Web

路由器 DSL

Spring Framework 提供了 3 种风格的 Kotlin 路由器 DSL

这些 DSL 让你能够编写整洁、地道的 Kotlin 代码来构建 RouterFunction 实例,如下例所示

@Configuration
class RouterRouterConfiguration {

	@Bean
	fun mainRouter(userHandler: UserHandler) = router {
		accept(TEXT_HTML).nest {
			GET("/") { ok().render("index") }
			GET("/sse") { ok().render("sse") }
			GET("/users", userHandler::findAllView)
		}
		"/api".nest {
			accept(APPLICATION_JSON).nest {
				GET("/users", userHandler::findAll)
			}
			accept(TEXT_EVENT_STREAM).nest {
				GET("/users", userHandler::stream)
			}
		}
		resources("/**", ClassPathResource("static/"))
	}
}
此 DSL 是编程式的,这意味着它允许通过 if 表达式、for 循环或任何其他 Kotlin 构造进行 Bean 的自定义注册逻辑。当你需要根据动态数据(例如,来自数据库)注册路由时,这会很有用。

请参阅 MiXiT project 获取具体示例。

MockMvc DSL

通过 MockMvc Kotlin 扩展提供了 Kotlin DSL,以提供更地道的 Kotlin API 并允许更好的可发现性(不使用静态方法)。

val mockMvc: MockMvc = ...
mockMvc.get("/person/{name}", "Lee") {
	secure = true
	accept = APPLICATION_JSON
	headers {
		contentLanguage = Locale.FRANCE
	}
	principal = Principal { "foo" }
}.andExpect {
	status { isOk }
	content { contentType(APPLICATION_JSON) }
	jsonPath("$.name") { value("Lee") }
	content { json("""{"someBoolean": false}""", false) }
}.andDo {
	print()
}

Kotlin 脚本模板

Spring Framework 提供了 ScriptTemplateView,它支持 JSR-223,可以使用脚本引擎渲染模板。

通过利用 scripting-jsr223 依赖,可以使用此特性,通过 kotlinx.html DSL 或 Kotlin 多行插值 String 渲染基于 Kotlin 的模板。

build.gradle.kts

dependencies {
	runtime("org.jetbrains.kotlin:kotlin-scripting-jsr223:${kotlinVersion}")
}

配置通常通过 ScriptTemplateConfigurerScriptTemplateViewResolver Bean 完成。

KotlinScriptConfiguration.kt

@Configuration
class KotlinScriptConfiguration {

	@Bean
	fun kotlinScriptConfigurer() = ScriptTemplateConfigurer().apply {
		engineName = "kotlin"
		setScripts("scripts/render.kts")
		renderFunction = "render"
		isSharedEngine = false
	}

	@Bean
	fun kotlinScriptViewResolver() = ScriptTemplateViewResolver().apply {
		setPrefix("templates/")
		setSuffix(".kts")
	}
}

有关更多详情,请参阅 kotlin-script-templating 示例项目。

Kotlin 多平台序列化

Kotlin 多平台序列化 在 Spring MVC、Spring WebFlux 和 Spring Messaging (RSocket) 中得到支持。内置支持目前针对 CBOR、JSON 和 ProtoBuf 格式。

要启用它,请按照这些说明添加相关的依赖和插件。对于 Spring MVC 和 WebFlux,如果它们在类路径中,Kotlin 序列化和 Jackson 都会默认配置,因为 Kotlin 序列化旨在仅序列化用 @Serializable 注解的 Kotlin 类。对于 Spring Messaging (RSocket),如果你想要自动配置,请确保类路径中没有 Jackson、GSON 或 JSONB;如果需要 Jackson,请手动配置 KotlinSerializationJsonMessageConverter