Web

路由器 DSL

Spring 框架提供三种口味的 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 项目 以获取具体示例。

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 框架提供了一个 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