1. Kotlin

Kotlin 是针对 JVM (和其他平台)的静态类型化语言,它允许编写简洁而优雅的代码,同时提供与 Java 中编写的现有库的非常好的 互操作性 .

Spring Framework 为 Kotlin 提供了一流的支持,使开发人员可以编写 Kotlin 应用程序,就像 Spring Framework 是本地 Kotlin 框架一样.参考文档的大部分代码示例都是 提供了 Java 和 Kotlin。

用 Kotlin 构建 Spring 应用程序的最简单方法是利用 Spring Boot 及其 专用的Kotlin支持. 这个 全面的教程 将教您如何使用 start.spring.io 使用 Kotlin 构建 Spring Boot 应用程序.

了解 Spring 和 Kotlin 的最简单方法是遵循这个全面的教程. 如果您需要支持,请随意加入 Kotlin Slack 的 #spring频道或使用 springkotlin 作为标签在 Stackoverflow 上提问.

1.1. 要求

Spring Framework 支持 Kotlin 1.3+ 并且需要 kotlin-stdlib(或其变体之一, 例如 kotlin-stdlib-jdk8 ) 和 kotlin-reflect存在于类路径中. 如果您在 start.spring.io 上引导 Kotlin 项目,则默认提供它们.

Kotlin inline classes 不再支持.
Jackson Kotlin 模块 是必需的,用于使用 Jackson 为 Kotlin 类序列化或反序列化 JSON 数据,因此请确保添加 com.fasterxml.jackson.module:jackson-module-kotlin 依赖于你的项目,如果你有这样的需要。 在类路径中找到它时会自动注册。

1.2. 扩展

Kotlin 扩展 提供了继承现有类和其他功能的能力. Spring 框架 Kotlin API 利用这些扩展为现有的 Spring API 添加新的 Kotlin 特定的方便支持.

Spring Framework Spring Framework KDoc API 列表与 API 文档列出了所有的 Kotlin 扩展和 DSL 可用的情况

请记住,必须导入 Kotlin 扩展才能使用. . 这意味着,如果导入 org.springframework.context.support.registerBean,则 GenericApplicationContext.registerBean 扩展就可用. 这样看来,与静态导入类似,IDE 在大多数情况下应该建议自动导入.

例如, Kotlin 具体化类型参数 为JVM 泛型类型擦除 提供了一种变通方法, Spring 框架提供了一些扩展以利用此功能. 这样为 Spring WebFlux 中的 WebClient 和更多其他的 API 提供更好的 Kotlin API RestTemplate.

其他的库,如 Reactor 和 Spring Data 也提供了 Kotlin 扩展的 API,从而整体提高了 Kotlin 开发经验.

要在 Java 中检索 User 对象列表,通常会编写以下内容:

Flux<User> users  = client.get().retrieve().bodyToFlux(User.class)

使用 Kotlin 和 Spring Framework 扩展,您可以编写以下内容:

val users = client.get().retrieve().bodyToFlux<User>()
// or (both are equivalent)
val users : Flux<User> = client.get().retrieve().bodyToFlux()

与在 Java 中一样,Kotlin 中的 users 是强类型的,但 Kotlin 的聪明类型推断允许更短的语法.

1.3. Null 安全

Kotlin 的一个关键特性是 null-safety,它在编译时干净地处理 null 值,而不是在运行时撞上著名的 NullPointerException 异常. 这使得应用程序通过可空性声明更安全并表达"有价值或无价值"语义,而无需支付包装器的成本,例如 Optional. (Kotlin 允许使用具有可空值的功能构造. 请参阅此 综合指南以了解Kotlin null安全性. )

虽然 Java 不允许在其类型系统中表示 null 安全,但 Spring 框架现在通过在 org.springframework.lang 包中声明的工具友好注解,为整个Spring 框架 API 提供了 null 安全. 默认情况下,Kotlin 中使用的 Java API 中的类型被识别为可轻松进行 null 检查的 平台类型. Kotlin支持JSR 305注解, Spring 可空性注解为 Kotlin 开发人员提供了整个 Spring 框架 API 的 null 安全,其优点是在编译时处理 null 的相关问题.

像 Reactor 或 Spring Data 这样的库提供了利用此功能的 null 安全 api

JSR 305 检查可以通过添加 -Xjsr305 编译器标志来配置,其中有以下选项: -Xjsr305={strict|warn|ignore}.

对于 kotlin 1.1+, 默认行为与 -Xjsr305=warn 一致. strict 的值应该被认为是实验性的(Spring API 的 null 声明在小版本之间可能会发生变化,将来可能会增加更多的检查).

泛型类型参数、varargs 和数组元素为 null 性不受支持,但应在即将发布的版本中添加此功能. 请参阅 此讨论以获取最新信息.

1.4. 类和接口

Spring 框架支持各种 Kotlin 构造,如通过主构造函数、不可变类数据绑定和具有默认值的函数可选参数来实例化 Kotlin 类.

Kotlin 参数名称是通过专用的 KotlinReflectionParameterNameDiscoverer 识别的,它允许在编译过程中不需要启用 Java 8 -parameters 的编译器标志即可查找接口方法参数名称.

您可以将配置类声明为 顶级或嵌套但不是内部,因为后者需要引用外部类.

1.5. 注解

Spring 框架还利用 Kotlin null-safety 来确定是否需要 HTTP 参数,而不必显式定义 required 属性. 这意味着 @RequestParam name: String? 将被视为不需要的,相反 @RequestParam name: String 则是需要的. Spring Messaging @Header 也支持此功能.

以类似的方式,使用 @Autowired, @Bean, 或 @Inject 的 Spring bean 注入使用此信息来确定是否需要 bean.

例如, @Autowired lateinit var thing: Thing 意味着必须在应用程序上下文中注册 Thing 类型的 bean. 而 @Autowired lateinit var thing: Thing?,如果这样的 bean 不存在,则不会引发错误.

按照相同的原则,@Bean fun play(toy: Toy, car: Car?) = Baz(toy, Car), Toy 类型的 bean 必须在应用程序上下文中注册,而类型为 Car 的 bean 可能不存在. 相同的行为适用于自动装配的构造函数参数.

如果对具有属性或主构造函数参数的类使用 bean 验证,则可能需要使用 annotation use-site targets,例如 @field:NotNull@get:Size(min=5, max=15),如 this Stack Overflow response.

1.6. Bean 定义 DSL

Spring 5 介绍了使用 lambda 在功能上注册 bean 的新方法,作为 XML 或 JavaConfig( @Configuration@Bean)的替代方法. 简而言之,它可以使用 lambda 作为 FactoryBean 注册 bean. 这种机制非常有效,因为它不需要任何反射或 CGLIB 代理.

例如,在 Java 中,您可以编写以下内容:

class Foo {}

class Bar {
    private final Foo foo;
    public Bar(Foo foo) {
        this.foo = foo;
    }
}

GenericApplicationContext context = new GenericApplicationContext();
context.registerBean(Foo.class);
context.registerBean(Bar.class, () -> new Bar(context.getBean(Foo.class)));

在 Kotlin 中,使用 reified 类型参数和 GenericApplicationContext Kotlin 扩展,您可以编写以下内容:

class Foo

class Bar(private val foo: Foo)

val context = GenericApplicationContext().apply {
    registerBean<Foo>()
    registerBean { Bar(it.getBean()) }
}

Bar 类只有一个构造函数时,您甚至可以只指定 bean 类,构造函数参数将按类型自动关联:

val context = GenericApplicationContext().apply {
    registerBean<Foo>()
    registerBean<Bar>()
}

为了使用更具声明性的方法和更简洁的语法,Spring 框架提供了 Kotlin bean 定义的 DSL,它通过简洁的声明性 API 声明了 ApplicationContextInitializer,能够处理配置文件和 Environment 自定义 bean 的注册方式. 在以下示例中注意:

  • 类型推断通常可以避免为 ref("bazBean") 之类的 bean 引用指定类型.

  • 在此示例中,可以使用 Kotlin 顶级函数通过可调用引用(如 bean(::myRouter) ) 声明 bean.

  • 当指定 bean<Bar>()bean(::myRouter) 时,参数将按类型自动关联

  • 仅当 foobar 配置文件处于活动状态时,才会注册 FooBar bean

class Foo
class Bar(private val foo: Foo)
class Baz(var message: String = "")
class FooBar(private val baz: Baz)

val myBeans = beans {
    bean<Foo>()
    bean<Bar>()
    bean("bazBean") {
        Baz().apply {
            message = "Hello world"
        }
    }
    profile("foobar") {
        bean { FooBar(ref("bazBean")) }
    }
    bean(::myRouter)
}

fun myRouter(foo: Foo, bar: Bar, baz: Baz) = router {
    // ...
}
该 DSL 是编程的,这意味着它允许通过 if 表达式,for 循环或任何其他 Kotlin 构造对 bean 进行自定义注册逻辑.

然后,您可以使用此 beans() 函数在应用程序上下文中注册 bean,如以下示例所示:

val context = GenericApplicationContext().apply {
    myBeans.initialize(this)
    refresh()
}
Spring Boot 是基于 Java 配置的, 并且不提供对函数式bean定义的特定支持. 但是可以通过 Spring Boot 的 ApplicationContextInitializer 支持在实验中使用函数式 bean 定义, 请参阅 Stack Overflow answer获取更多的细节和最新的信息. 另请参阅在 Spring Fu incubator 中开发的实验性 Kofu DSL.

1.7. Web

1.7.1. Router DSL

Spring Framework 现在附带了三种 Kotlin 路由 DSL,它允许您使用 WebFlux functional API 编写干净且惯用的 Kotlin 代码,如以下示例所示:

这些 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

1.7.2. 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()
}

1.7.3. 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 示例项目.

1.7.4. Kotlin multiplatform serialization

从 Spring Framework 5.3 开始, Spring MVC, Spring WebFlux 和 Spring Messaging (RSocket) 中支持 Kotlin multiplatform serialization. 内置支持当前仅针对 JSON 格式.

要启用它, 请遵循 这些说明 添加相关的依赖和插件. 使用 Spring MVC 和 WebFlux, 如果它们位于类路径中, 则默认情况下将同时配置 Kotlin 序列化和 Jackson Kotlin 序列化旨在仅序列化带有 @ Serializable 的 Kotlin 类. 如果您要进行自动配置, 请使用 Spring Messaging (RSocket) 来确保 Jackson, GSON 或 JSONB 都不在类路径中, 如果需要 Jackson, 请手动配置 KotlinSerializationJsonMessageConverter.

1.8. Coroutines

Kotlin Coroutines 是 Kotlin 轻量级线程,允许以命令式方式编写非阻塞代码. 在语言方面,挂起函数为异步操作提供了一种抽象,而在库方面, kotlinx.coroutines 提供了诸如 async { } 之类的函数以及诸如 Flow 之类的类型.

Spring Framework 在以下范围内提供对 Coroutines 的支持:

  • DeferredFlow return values support in Spring WebFlux annotated @Controller

  • Spring MVC 和 WebFlux 中带有 @Controller 注解的暂停功能支持

  • WebFlux clientserver 功能 API 的扩展.

  • WebFlux.fn coRouter { } DSL

  • RSocket @MessageMapping 注解方法中的暂停功能和 Flow 支持

  • RSocketRequester 的扩展

1.8.1. 依赖

kotlinx-coroutines-corekotlinx-coroutines-reactor 依赖位于类路径中时,将启用 Coroutines 支持:

build.gradle.kts

dependencies {

    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:${coroutinesVersion}")
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:${coroutinesVersion}")
}

支持 1.4.0 及更高版本.

1.8.2. Reactive 如何转换为 Coroutines?

对于返回值,以下是从 Reactive 到 Coroutines API的转换:

  • fun handler(): Mono<Void> 变成 suspend fun handler()

  • fun handler(): Mono<T> 变成 suspend fun handler(): Tsuspend fun handler(): T? 取决于 Mono 是否可以为空(具有更静态输入的优势)

  • fun handler(): Flux<T> 变成 fun handler(): Flow<T>

对于输入参数:

  • 如果不需要懒加载,则 fun handler(mono: Mono<T>) 变成 fun handler(value: T) 因为可以调用挂起函数来获取value参数.

  • 如果需要懒加载, 则 fun handler(mono: Mono<T>) 变成 fun handler(supplier: suspend () → T)fun handler(supplier: suspend () → T?)

在 Coroutines 中, FlowFlux 是等效的, 适用于热流或冷流,有限流或无限流,主要区别如下:

  • Flow 是基于推式的 Flux 是推拉式混合的

  • 背压通过暂停功能实现

  • Flow 只有一个暂停的 收集方法 并且运算符被实现为 扩展借助 Coroutines,操作员易于实施

  • Operators are easy to implement thanks to Coroutines

  • 扩展允许向 Flow 添加自定义运算符

  • 收集操作正在暂停功能

  • map operator 支持异步操作(不需要 flatMap) ,因为它需要一个暂停函数参数

通过阅读有关 Spring,Coroutines和Kotlin Flow Reactive的博客文章,了解更多详细信息,包括如何与Coroutines并发运行代码.

1.8.3. Controllers

这是一个 Controllers @RestController 的示例.

@RestController
class CoroutinesRestController(client: WebClient, banner: Banner) {

    @GetMapping("/suspend")
    suspend fun suspendingEndpoint(): Banner {
        delay(10)
        return banner
    }

    @GetMapping("/flow")
    fun flowEndpoint() = flow {
        delay(10)
        emit(banner)
        delay(10)
        emit(banner)
    }

    @GetMapping("/deferred")
    fun deferredEndpoint() = GlobalScope.async {
        delay(10)
        banner
    }

    @GetMapping("/sequential")
    suspend fun sequential(): List<Banner> {
        val banner1 = client
                .get()
                .uri("/suspend")
                .accept(MediaType.APPLICATION_JSON)
                .awaitExchange()
                .awaitBody<Banner>()
        val banner2 = client
                .get()
                .uri("/suspend")
                .accept(MediaType.APPLICATION_JSON)
                .awaitExchange()
                .awaitBody<Banner>()
        return listOf(banner1, banner2)
    }

    @GetMapping("/parallel")
    suspend fun parallel(): List<Banner> = coroutineScope {
        val deferredBanner1: Deferred<Banner> = async {
            client
                    .get()
                    .uri("/suspend")
                    .accept(MediaType.APPLICATION_JSON)
                    .awaitExchange()
                    .awaitBody<Banner>()
        }
        val deferredBanner2: Deferred<Banner> = async {
            client
                    .get()
                    .uri("/suspend")
                    .accept(MediaType.APPLICATION_JSON)
                    .awaitExchange()
                    .awaitBody<Banner>()
        }
        listOf(deferredBanner1.await(), deferredBanner2.await())
    }

    @GetMapping("/error")
    suspend fun error() {
        throw IllegalStateException()
    }

    @GetMapping("/cancel")
    suspend fun cancel() {
        throw CancellationException()
    }

}

还支持使用 @Controller 进行视图渲染.

@Controller
class CoroutinesViewController(banner: Banner) {

    @GetMapping("/")
    suspend fun render(model: Model): String {
        delay(10)
        model["banner"] = banner
        return "index"
    }
}

1.8.4. WebFlux.fn

这是通过 coRouter { } DSL 和相关处理程序定义的 Coroutines 路由器的示例.

@Configuration
class RouterConfiguration {

    @Bean
    fun mainRouter(userHandler: UserHandler) = coRouter {
        GET("/", userHandler::listView)
        GET("/api/user", userHandler::listApi)
    }
}
class UserHandler(builder: WebClient.Builder) {

    private val client = builder.baseUrl("...").build()

    suspend fun listView(request: ServerRequest): ServerResponse =
            ServerResponse.ok().renderAndAwait("users", mapOf("users" to
            client.get().uri("...").awaitExchange().awaitBody<User>()))

    suspend fun listApi(request: ServerRequest): ServerResponse =
                ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).bodyAndAwait(
                client.get().uri("...").awaitExchange().awaitBody<User>())
}

1.8.5. 事务

从 Spring Framework 5.2 开始,通过 Reactive 事务管理的程序化变体支持协同程序上的事务.

对于挂起函数,提供了 TransactionalOperator.executeAndAwait 扩展.

import org.springframework.transaction.reactive.executeAndAwait

class PersonRepository(private val operator: TransactionalOperator) {

    suspend fun initDatabase() = operator.executeAndAwait {
        insertPerson1()
        insertPerson2()
    }

    private suspend fun insertPerson1() {
        // INSERT SQL statement
    }

    private suspend fun insertPerson2() {
        // INSERT SQL statement
    }
}

对于 Kotlin Flow,提供了 Flow<T>.transactional 扩展.

import org.springframework.transaction.reactive.transactional

class PersonRepository(private val operator: TransactionalOperator) {

    fun updatePeople() = findPeople().map(::updatePerson).transactional(operator)

    private fun findPeople(): Flow<Person> {
        // SELECT SQL statement
    }

    private suspend fun updatePerson(person: Person): Person {
        // UPDATE SQL statement
    }
}

1.9. Kotlin 中的 Spring 项目

本节提供了一些在 Kotlin 中开发 Spring 项目的具体提示和建议.

1.9.1. 默认不可变

默认情况下, Kotlin中的所有类都是 final 的. 类上的 open 修饰符与 Java 的 final 相反: 它允许其他人从这个类继承. 这也适用于成员函数,因为它们需要被标记为 open ,才能被重写.

虽然 Kotlin 的 JVM 友好设计通常与 Spring 无缝对接,但如果不考虑这一事实,则此特定的 Kotlin 功能可能会阻止应用程序启动. 这是因为 Spring bean 通常使用 CGLIB 来代理 , 例如 @Configuration 类. 解决方法是在由 CGLIB 代理的 Spring bean 的每个类和成员函数上添加一个 open 关键字(例如 @Configuration 类) ,这种设计可能很快就成为 Kotlin 的累赘,并且违反了保持代码简洁和可预测的 Kotlin 原则.

也可以通过使用 @Configuration(proxyBeanMethods = false) 避免在配置上使用 CGLIB 代理,有关更多详细信息,请参见 proxyBeanMethods Javadoc .

幸运的是,Kotlin 现在提供了 kotlin-spring 插件(kotlin-allopen 插件的预配置版本) ,它可以自动打开类及其成员函数,用于使用以下注解之一进行注解或元注解的类型:

  • @Component

  • @Async

  • @Transactional

  • @Cacheable

元注解的支持意味着使用 @Configuration, @Controller, @RestController, @Service, 或 @Repository 注解的类型会自动设置为 open,因为这些都是 @Component 注解的元注解.

默认情况下, start.spring.io 是启用 kotlin-spring 插件,因此在实践中,将能够编写自定义 Kotlin bean 而无需像在 Java 中那样添加额外的 open 关键字.

Spring Framework 文档中的 Kotlin 代码示例未明确指定在类及其成员函数上使用 open. 项目中的 sample 使用 kotlin-allopen 插件,因为这是最常用的设置.

1.9.2. 使用不可变的类实例进行持久化

在 Kotlin 中,将主构造函数声明为只读属性是非常方便和最佳的做法,如下面的示例所示:

class Person(val name: String, val age: Int)

您可以选择添加 data 关键字,以使编译器自动从主构造函数中声明的所有属性扩展以下成员:

  • equals()hashCode()

  • "User(name=John, age=42)"toString() 方法

  • 按照其声明顺序与属性相对应的 component() 函数

  • copy() 方法

如下面的示例所示,即使 Person 属性是只读的,也允许轻松更改单个属性:

data class Person(val name: String, val age: Int)

val jack = Person(name = "Jack", age = 1)
val olderJack = jack.copy(age = 2)

但是一些像 JPA 这样的持久化技术需要默认的构造函数,这妨碍了这种设计. 幸运的是,现在有解决办法这种 “default constructor hell”, 因为Kotlin提供了一个 kotlin-jpa 插件,生成在 JPA 注解上合成无参数的构造器.

如果您需要将此类机制用于其他持久性技术,则可以配置 kotlin-noarg 插件.

从 Kay 发布系列开始,Spring Data 支持 Kotlin 不可变类实例,如果模块使用 Spring Data 对象映射(如 MongoDB,Redis,Cassandra 等) ,则不需要 kotlin-noarg 插件.

1.9.3. 依赖注入

我们的建议是尝试和支持使用 val 只读的构造函数注入(如果可能的话) properties,如下所示:

@Component
class YourBean(
    private val mongoTemplate: MongoTemplate,
    private val solrClient: SolrClient
)
具有单个构造函数的类的参数会自动自动装配,这就是为什么在上面显示的示例中不需要显式的 @Autowired 构造函数 的原因.

如果确实需要使用字段注入,则可以使用 lateinit var 构造,如以下示例所示:

@Component
class YourBean {

    @Autowired
    lateinit var mongoTemplate: MongoTemplate

    @Autowired
    lateinit var solrClient: SolrClient
}

1.9.4. 注入配置属性

在 Java 中,您可以使用注解(例如 @Value("${property}")) ) 注入配置属性. 但是,在 Kotlin 中,$ 是一个用于 字符串插值 的保留字符.

因此,如果您希望在 Kotlin 中使用 @Value 注解,则需要通过编写 @Value("\${property}") 来转义 $ 字符.

如果使用 Spring Boot,则可能应该使用 @ConfigurationProperties 而不是 @Value 注解.

或者,您可以通过声明以下配置 Bean 来自定义属性占位符前缀:

@Bean
fun propertyConfigurer() = PropertySourcesPlaceholderConfigurer().apply {
    setPlaceholderPrefix("%{")
}

现有的代码(如 Spring Boot actuators 或 @LocalServerPort)都使用 ${…​} 语法,可以使用配置 bean 进行定制. 如以下示例所示:

@Bean
fun kotlinPropertyConfigurer() = PropertySourcesPlaceholderConfigurer().apply {
    setPlaceholderPrefix("%{")
    setIgnoreUnresolvablePlaceholders(true)
}

@Bean
fun defaultPropertyConfigurer() = PropertySourcesPlaceholderConfigurer()

1.9.5. 异常检查

Java 和 Kotlin异常处理非常接近,主要区别在于 Kotlin 将所有异常视为未经检查的异常. 但是,当使用代理对象(例如,用 @Transactional 注解的类或方法) 时,默认情况下, 引发的检查异常将包装在 UndeclaredThrowableException 中.

为了像在 Java 中一样抛出原始异常,应该使用 @Throws 注解方法,以明确指定抛出的已检查异常(例如 @Throws(IOException::class)) .

1.9.6. 注解数组属性

Kotlin 注解大多与 Java 相似,但数组属性(在 Spring 中广泛使用着)的表现方式不同. 正如 Kotlin 文档 中所解释的, 与其他属性不同,value 属性名称可以省略,当它是数组属性时,它被指定为 vararg 参数.

要理解这意味着什么,请考虑 @RequestMapping(这是最广泛使用的Spring注解之一) 作为示例. 此 Java 注解声明如下:

public @interface RequestMapping {

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};

    // ...
}

@RequestMapping 的典型用例是将处理程序方法映射到特定的路径和方法. 在 Java 中,可以为注解数组属性指定单个值,并将其自动转换为数组.

这就是为什么可以写 @RequestMapping(value = "/toys", method = RequestMethod.GET)@RequestMapping(path = "/toys", method = RequestMethod.GET).

然而, 在 Kotlin 中, 你必须编写 @RequestMapping("/toys", method = [RequestMethod.GET])@RequestMapping(path = ["/toys"], method = [RequestMethod.GET]) (方括号需要使用命名数组属性指定).

这种特殊方法属性的解决方法(最常见的方法) 是使用快捷方式注解,例如 @GetMapping, @PostMapping 等.

提醒: 如果未指定 @RequestMapping method 属性,则将匹配所有 HTTP 方法,而不仅仅是 GET 方法.

1.9.7. 测试

本节介绍了 Kotlin 和 Spring Framework 的结合测试. 推荐的测试框架是 JUnit 5,以及用于模拟的 Mockk .

如果您使用的是 Spring Boot,请参阅此 相关文档.
构造器注入

专用部分中所述,JUnit 5 允许构造函数注入 bean,这对于 Kotlin 来说非常有用,以便使用 val 而不是 lateinit var. 您可以使用 @TestConstructor(autowireMode = AutowireMode.ALL) 启用所有参数的自动装配.

@SpringJUnitConfig(TestConfig::class)
@TestConstructor(autowireMode = AutowireMode.ALL)
class OrderServiceIntegrationTests(val orderService: OrderService,
                                   val customerService: CustomerService) {

    // tests that use the injected OrderService and CustomerService
}
PER_CLASS 生命周期

Kotlin 允许您在反引号 (\`) 之间指定有意义的测试函数名称. 从 JUnit 5开始,Kotlin 测试类可以使用 @TestInstance(TestInstance.Lifecycle.PER_CLASS) 注解来启用测试类的单个实例化. 从而允许使用 @BeforeAll@AfterAll 非静态方法的注解,这种特征很适合 Kotlin.

现在,由于 junit-platform.properties 文件带有 junit.jupiter.testinstance.lifecycle.default = per_class 属性,您现在可以将默认行为更改为 PER_CLASS .

以下示例 @BeforeAll@AfterAll 对非静态方法的注解:

@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class IntegrationTests {

  val application = Application(8181)
  val client = WebClient.create("http://localhost:8181")

  @BeforeAll
  fun beforeAll() {
    application.start()
  }

  @Test
  fun `Find all users on HTML page`() {
    client.get().uri("/users")
        .accept(TEXT_HTML)
        .retrieve()
        .bodyToMono<String>()
        .test()
        .expectNextMatches { it.contains("Foo") }
        .verifyComplete()
  }

  @AfterAll
  fun afterAll() {
    application.stop()
  }
}
类似规范的测试

您可以使用 JUnit 5 和 Kotlin 创建类似规范的测试. 以下示例显示了如何执行此操作:

class SpecificationLikeTests {

  @Nested
  @DisplayName("a calculator")
  inner class Calculator {
     val calculator = SampleCalculator()

     @Test
     fun `should return the result of adding the first number to the second number`() {
        val sum = calculator.sum(2, 4)
        assertEquals(6, sum)
     }

     @Test
     fun `should return the result of subtracting the second number from the first number`() {
        val subtract = calculator.subtract(4, 2)
        assertEquals(2, subtract)
     }
  }
}
Kotlin 中的 WebTestClient 类型推断问题

由于 类型推断问题,您必须使用 Kotlin expectBody 扩展(例如 expectBody<String>().isEqualTo("toys") ) ,因为它为 Java API 提供了 Kotlin 问题的解决方法.

另请参阅相关的 SPR-16057 问题.

1.10. 入门

本节描述了开始结合 Kotlin 和 Spring Framework 的项目的最快方法是 使用特定教程.

1.10.1. start.spring.io

在 Kotlin 中启动新的 Spring Framework 5 项目的最简单方法是在 start.spring.io上创建一个新的 Spring Boot 2 项目.

1.10.2. 选择 Web 风格

Spring 框架现在带有两个不同的 Web 堆栈: Spring MVCSpring WebFlux.

如果您要创建处理延迟,长期连接,流传输方案的应用程序,或者要使用网络功能的 Kotlin DSL,建议使用 Spring WebFlux.

对于其他用例,尤其是在使用阻塞技术(例如 JPA,Spring MVC 及其基于注解的编程模型) 的情况下,建议选择.

1.11. 资源

对于学习如何使用 Kotlin 和 Spring Framework 构建应用程序的人们,我们建议使用以下资源:

1.11.1. 示例

以下 Github 项目提供了示例,您可以从中学习甚至扩展:

2. Apache Groovy

Groovy 是一种功能强大的,类型可选的动态语言,具有静态类型和静态编译功能. 它提供了简洁的语法,并且可以与任何现有的 Java 应用程序集成.

Spring 框架提供了专用的 ApplicationContext,它支持基于 Groovy 的 Bean 定义 DSL. 有关更多详细信息,请参见 The Groovy Bean Definition DSL

动态语言支持中提供了对 Groovy 的进一步支持,包括用 Groovy 编写的 bean,可刷新的脚本 bean 等.

3. 动态语言支持

Spring 为使用已经被使用过的类和对象提供了全面的支持. 通过在 Spring 中使用动态语言(例如 Groovy)进行定义. 这种支持让您可以使用受支持的动态语言编写任意数量的类,并具有 Spring 容器透明地实例化,配置并依赖注入结果对象.

Spring 的脚本支持主要针对 Groovy 和 BeanShell. 超越那些特别支持的语言,支持 JSR-223 脚本编制机制 用于与任何支持 JSR-223 的语言提供者集成(自 Spring 4.2 起), 例如 JRuby.

您可以找到完全可行的示例,这些示例可以在Scenarios中立即使用这种动态语言支持.

3.1. 第一个示例

本章的大部分内容与详细描述动态语言支持有关. 在深入探讨动态语言支持的所有内容之前,我们来看一个使用动态语言定义的 bean 的简单示例. 这个第一个 bean 的动态语言是 Groovy. (该示例的基础取自 Spring 测试套件.如果要查看其他任何受支持语言的等效示例,请查看源代码).

下一个示例显示了 Groovy bean 将要实现的 Messenger 接口. 请注意,此接口是用纯 Java 定义的。注入了对 Messenger 的引用的依赖对象不知道底层的实现是一个 Groovy 脚本。 以下清单显示了 Messenger 接口:

;

public interface Messenger {

    String getMessage();
}

Messenger 接口的实现:

public class DefaultBookingService implements BookingService {

    private Messenger messenger;

    public void setMessenger(Messenger messenger) {
        this.messenger = messenger;
    }

    public void processBooking() {
        // use the injected Messenger object...
    }
}

在 Groovy 中实现 Messenger 接口

;

// import the Messenger interface (written in Java) that is to be implemented

import org.springframework.scripting.Messenger

// define the implementation in Groovy
class GroovyMessenger implements Messenger {

    String message
}

要使用定制的动态语言标签来定义动态语言的 Bean,您需要在 Spring XML 配置文件的顶部具有 XML Schema 声明. 您还需要使用 Spring ApplicationContext 实现作为 IoC 容器. 支持将动态语言支持的 bean 与纯 BeanFactory 实现一起使用,但是您必须管理 Spring 内部.

有关基于 schema 的配置的更多信息,请参见基于XML schema 的配置.

最后,以下示例显示了将 Groovy 定义的 Messenger 实现注入到 DefaultBookingService 类的实例中:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:lang="http://www.springframework.org/schema/lang"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/lang https://www.springframework.org/schema/lang/spring-lang.xsd">

    <!-- this is the bean definition for the Groovy-backed Messenger implementation -->
    <lang:groovy id="messenger" script-source="classpath:Messenger.groovy">
        <lang:property name="message" value="I Can Do The Frug" />
    </lang:groovy>

    <!-- an otherwise normal bean that will be injected by the Groovy-backed Messenger -->
    <bean id="bookingService" class="x.y.DefaultBookingService">
        <property name="messenger" ref="messenger" />
    </bean>

</beans>

bookingService bean(DefaultBookingService)现在可以照常使用其 private Messenger 成员变量,因为注入到其中的 Messenger 实例是 Messenger 实例. 这里没有什么特别的事情-只是普通的 Java 和普通的 Groovy.

希望你能看懂上面的 XML 定义,如果看不懂,请继续往下阅读.

3.2. 定义由动态语言支持的 Bean

本节准确地描述了如何使用任何受支持的动态语言来定义 Spring 托管的 bean.

注意,本章并不试图解释受支持的动态语言的语法和惯用语. 例如,如果您想使用 Groovy 在您的应用程序中编写某些类,我们假设您已经了解 Groovy. 如果您需要有关动态语言本身的更多详细信息,请参阅本章末尾的 Further Resources .

3.2.1. 相关概念

使用动态语言定义 bean 涉及的步骤如下:

  1. 为动态语言源代码编写测试 (naturally).

  2. 然后编写动态语言源代码本身

  3. 通过在 XML 配置中使用适当的 <lang:language/> 元素来定义支持动态语言的 Bean(您可以使用 Spring API 以编程方式定义此类 Bean,尽管您将不得不参考源代码以获取有关如何 请执行此操作,因为本章不介绍此类高级配置. 请注意,这是一个迭代步骤. 每个动态语言源文件至少需要一个 bean 定义(尽管多个 bean 定义可以引用同一个动态语言源文件).

前两个步骤(测试和编写动态语言源文件)超出了范围 本章的范围. 请参阅语言规范和参考手册 您选择的动态语言,并继续开发动态语言源文件. 您首先要阅读本章的其余部分,因为 Spring 的动态语言支持确实对内容做了一些(小的)假设动态语言源文件.

<lang:language/> 元素

上一节最后一步涉及到定义动态语言支持的 bean 定义, 每个要配置的 bean 定义一个(这与常规 JavaBean 配置没有什么不同). 但是, 可以使用 <lang:language /> 元素定义动态语言支持的 bean, 而不是指定由容器实例化和配置的类的完全限定类名.

每种支持的语言都有一个相对于的 <lang:language/> 元素:

  • <lang:groovy/> (Groovy)

  • <lang:bsh/> (BeanShell)

  • <lang:std/> (JSR-223, e.g. with JRuby)

可用于配置的属性和子元素完全取决于定义该 bean 所使用的语言(本章稍后的特定于语言的部分对此进行了详细说明).

Refreshable Beans

Spring 对动态语言的支持(也许是唯一)最引人注目的功能之一就是 “refreshable bean” 特性.

可刷新的 bean 是动态语言支持的 bean. 通过少量配置, 支持动态语言的 Bean 可以监视其源文件资源中的更改, 然后在更改动态语言源文件时(例如, 当您在 Windows 上编辑并保存对文件的更改时)重新加载自身文件系统).

这使您可以将任何数量的动态语言源文件部署为应用程序的一部分, 配置 Spring 容器以创建由动态语言源文件支持的 bean(使用本章中描述的机制), 以及(随后, 随着需求的变化或其他一些变化) 外部因素起作用)编辑动态语言源文件, 并使它们所做的任何更改都反映在更改后的动态语言源文件支持的 Bean 中. 无需关闭正在运行的应用程序(或在 Web 应用程序的情况下重新部署). 如此修改的支持动态语言的 Bean 从更改后的动态语言源文件中获取了新的状态和逻辑.

此特性默认是关闭的.

现在我们来看一个例子, 看看使用可刷新 bean 是多么容易. 要打开可刷新 bean 功能, 必须在 bean 定义的 <lang:language /> 元素上指定一个附加属性. 因此, 如果我们坚持使用本章前面的示例, 则以下示例显示了我们将在 Spring XML 配置中进行哪些更改以实现可刷新的 bean:

<beans>

    <!-- this bean is now 'refreshable' due to the presence of the 'refresh-check-delay' attribute -->
    <lang:groovy id="messenger"
            refresh-check-delay="5000" <!-- switches refreshing on with 5 seconds between checks -->
            script-source="classpath:Messenger.groovy">
        <lang:property name="message" value="I Can Do The Frug" />
    </lang:groovy>

    <bean id="bookingService" class="x.y.DefaultBookingService">
        <property name="messenger" ref="messenger" />
    </bean>

</beans>

这确实是您要做的. 在 messenger Bean 定义上定义的 refresh-check-delay 属性是毫秒数, 在该毫秒数之后, 对基础动态语言源文件进行的任何更改都会刷新 Bean. 您可以通过为 refresh-check-delay 属性分配一个负值来关闭刷新行为. 请记住, 默认情况下, 刷新行为是禁用的. 如果您不希望刷新行为, 则不要定义属性.

然后运行以下应用程序, 则可以使用可刷新功能. (请在下一段代码中使用 “jumping-through-hoops-to-pause-the-execution” 的恶作剧. )System.in.read() 调用仅存在, 以便在您执行该程序时暂停执行. (在这种情况下, 开发人员)关闭并编辑基础动态语言源文件, 以便在程序恢复执行时在由动态语言支持的 bean 上触发刷新.

以下清单显示了此示例应用程序:

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.scripting.Messenger;

public final class Boot {

    public static void main(final String[] args) throws Exception {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
        Messenger messenger = (Messenger) ctx.getBean("messenger");
        System.out.println(messenger.getMessage());
        // pause execution while I go off and make changes to the source file...
        System.in.read();
        System.out.println(messenger.getMessage());
    }
}

然后, 出于本示例的目的, 假定必须更改对 Messenger 实现的 getMessage() 方法的所有调用, 以使 message 用引号引起来. 以下清单显示了您(开发人员)在暂停程序执行时应对 Messenger.groovy 源文件进行的更改:

class GroovyMessenger implements Messenger {

    private String message = "Bingo"

    public String getMessage() {
        // change the implementation to surround the message in quotes
        return "'" + this.message + "'"
    }

    public void setMessage(String message) {
        this.message = message
    }
}

程序运行时, 输入暂停之前的输出将为 I Can Do The Frug. 更改并保存对源文件的更改并恢复执行程序之后, 在支持动态语言的 Messenger 实现上调用 getMessage() 方法的结果为 'I Can Do The Frug'(请注意包含其他内容-引号).

如果更改发生在 refresh-check-delay 值的窗口内, 则对脚本所做的更改不会触发刷新. 直到在支持动态语言的 Bean 上调用方法之前, 实际上不会进行对脚本的更改. 只有在支持动态语言的 Bean 上调用方法时, 它才会检查其基础脚本源是否已更改. 与刷新脚本有关的任何异常(例如遇到编译错误或发现脚本文件已被删除)都会导致致命异常传播到调用代码.

前面描述的可刷新 bean 行为不适用于使用 <lang:inline-script/> 元素表示法定义的动态语言源文件(请参阅Inline Dynamic Language Source Files). 此外, 它仅适用于实际上可以检测到基础源文件的更改的 Bean(例如, 通过检查文件系统上存在的动态语言源文件的最后修改日期的代码).

Inline Dynamic Language Source Files

动态语言支持还可以直接嵌入在 Spring bean 定义中的动态语言源文件. 更具体地说, 使用 <lang:inline-script/> 元素, 您可以在 Spring 配置文件中立即定义动态语言源. 下面示例可以阐明内联脚本功能的工作方式:

<lang:groovy id="messenger">
    <lang:inline-script>

package org.springframework.scripting.groovy;

import org.springframework.scripting.Messenger

class GroovyMessenger implements Messenger {
    String message
}

    </lang:inline-script>
    <lang:property name="message" value="I Can Do The Frug" />
</lang:groovy>

如果将有关在 Spring 配置文件中定义动态语言源是否是一种好习惯的问题放在一边, 在某些情况下, <lang:inline-script/> 元素可能会有用. 例如, 我们可能想将 Spring Validator 实现快速添加到 Spring MVC Controller. 这只是使用嵌入式源代码的工作. (有关此类示例, 请参见脚本验证. )

在动态语言支持的 Bean 的上下文中了解构造函数注入

关于 Spring 的动态语言支持, 有一件非常重要的事情要注意. 也就是说, 您不能(当前)向动态语言支持的 bean 提供构造函数参数(因此, 构造函数注入不适用于动态语言支持的 bean). 为了使对构造函数和属性的特殊处理 100% 清晰, 以下代码和配置的混合将不起作用:

An approach that cannot work
;

import org.springframework.scripting.Messenger

class GroovyMessenger implements Messenger {

    GroovyMessenger() {}

    // this constructor is not available for Constructor Injection
    GroovyMessenger(String message) {
        this.message = message;
    }

    String message

    String anotherMessage
}
<lang:groovy id="badMessenger"
    script-source="classpath:Messenger.groovy">
    <!-- this next constructor argument will not be injected into the GroovyMessenger -->
    <!-- in fact, this isn't even allowed according to the schema -->
    <constructor-arg value="This will not work" />

    <!-- only property values are injected into the dynamic-language-backed object -->
    <lang:property name="anotherMessage" value="Passed straight through to the dynamic-language-backed object" />

</lang>

在实践中, 这种限制并不像它最初出现的那样重要, 因为 setter 注入是绝大多数开发人员所偏爱的注入方式(我们将讨论是否对另一天来说是一件好事).

3.2.2. Groovy Beans

本节描述了如何在 Spring 中使用 Groovy 中定义的 bean.

Groovy 主页包含以下描述:

“Groovy is an agile dynamic language for the Java 2 Platform that has many of the features that people like so much in languages like Python, Ruby and Smalltalk, making them available to Java developers using a Java-like syntax.”

如果您从上至下直接阅读了本章, 那么您已经看到了 Groovy 动态语言支持的 bean 的 示例. 现在考虑另一个示例(再次使用 Spring 测试套件中的示例):

public interface Calculator {

    int add(int x, int y);
}

以下实例使用 Groovy 实现了 Calculator 接口:

class GroovyCalculator implements Calculator {

    int add(int x, int y) {
        x + y
    }
}

以下 bean 定义使用 Groovy 中定义的 calculator:

<!-- from the file 'beans.xml' -->
<beans>
    <lang:groovy id="calculator" script-source="classpath:calculator.groovy"/>
</beans>

最后, 应用程序将执行上述配置:

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
        Calculator calc = ctx.getBean("calculator", Calculator.class);
        System.out.println(calc.add(2, 8));
    }
}

运行上述程序得到的结果是 10(很正常). (有关更多有趣的示例, 请参见 Scenarios 以获得更复杂的示例, 或参见本章后面的示例场景).

每个 Groovy 源文件中定义的类不得超过一个. 尽管这在 Groovy 中是完全合法的, 但(可以说)这是一种不好的做法. 为了采用一致的方法, 您(在 Spring 小组看来)应该遵守每个源文件一个 (public) 类的标准 Java 约定.

通过使用回调自定义 Groovy 对象

GroovyObjectCustomizer 接口是一个回调, 您可以将其他创建逻辑挂接到创建 Groovy 支持的 bean 的过程中. 例如, 此接口的实现可以调用任何必需的初始化方法, 设置一些默认属性值或指定自定义 MetaClass. 以下清单显示了 GroovyObjectCustomizer 接口定义:

public interface GroovyObjectCustomizer {

    void customize(GroovyObject goo);
}

Spring 框架实例化您的 Groovy 支持的 bean 的实例, 然后将创建的 GroovyObject 传递到指定的 GroovyObjectCustomizer(如果已定义). 您可以使用提供的 GroovyObject 参考来做任何您想做的事情. 我们希望大多数人都希望使用此回调来设置自定义 MetaClass, 以下示例说明了如何进行设置:

public final class SimpleMethodTracingCustomizer implements GroovyObjectCustomizer {

    public void customize(GroovyObject goo) {
        DelegatingMetaClass metaClass = new DelegatingMetaClass(goo.getMetaClass()) {

            public Object invokeMethod(Object object, String methodName, Object[] arguments) {
                System.out.println("Invoking '" + methodName + "'.");
                return super.invokeMethod(object, methodName, arguments);
            }
        };
        metaClass.initialize();
        goo.setMetaClass(metaClass);
    }

}

Groovy 中对元编程的完整讨论超出了 Spring 参考手册的范围. 请参阅 Groovy 参考手册的相关部分, 或在线进行搜索. 大量文章讨论了该主题. 实际上, 如果使用 Spring 命名空间支持, 使用 GroovyObjectCustomizer 很容易, 如以下示例所示:

<!-- define the GroovyObjectCustomizer just like any other bean -->
<bean id="tracingCustomizer" class="example.SimpleMethodTracingCustomizer"/>

    <!-- ... and plug it into the desired Groovy bean via the 'customizer-ref' attribute -->
    <lang:groovy id="calculator"
        script-source="classpath:org/springframework/scripting/groovy/Calculator.groovy"
        customizer-ref="tracingCustomizer"/>

如果不使用 Spring 命名空间支持, 则仍然可以使用 GroovyObjectCustomizer 功能, 如以下示例所示:

<bean id="calculator" class="org.springframework.scripting.groovy.GroovyScriptFactory">
    <constructor-arg value="classpath:org/springframework/scripting/groovy/Calculator.groovy"/>
    <!-- define the GroovyObjectCustomizer (as an inner bean) -->
    <constructor-arg>
        <bean id="tracingCustomizer" class="example.SimpleMethodTracingCustomizer"/>
    </constructor-arg>
</bean>

<bean class="org.springframework.scripting.support.ScriptFactoryPostProcessor"/>
您还可以在与 Spring 的 GroovyObjectCustomizer 相同的位置指定一个 Groovy CompilationCustomizer(例如 ImportCustomizer)或是完整的 Groovy CompilerConfiguration 对象. 此外, 您可以在 ConfigurableApplicationContext.setClassLoader 级别为您的 bean 设置具有自定义配置的通用 GroovyClassLoader. 这也导致了 GroovyClassLoader 的共享使用, 因此建议在有大量脚本化 bean 的情况下使用(避免每个 bean 使用隔离的 GroovyClassLoader 实例).

3.2.3. BeanShell Beans

本节描述如何在 Spring 中使用 BeanShell bean.

BeanShell 主页 包括以下描述:

BeanShell is a small, free, embeddable Java source interpreter with dynamic language
features, written in Java. BeanShell dynamically executes standard Java syntax and
extends it with common scripting conveniences such as loose types, commands, and method
closures like those in Perl and JavaScript.

与 Groovy 相比, BeanShell 支持的 bean 定义需要一些(小的)附加配置. 在 Spring 中实现 BeanShell 动态语言支持很有趣, 因为 Spring 创建了一个 JDK 动态代理, 该代理实现了 <lang:bsh> 元素的 s`script-interfaces` 属性值中指定的所有接口(这就是为什么必须 在属性值中提供至少一个接口, 因此在使用 BeanShell 支持的 bean 时对接口进行编程). 这意味着对 BeanShell 支持的对象的每个方法调用都将通过 JDK 动态代理调用机制进行.

现在, 我们可以展示一个使用基于 BeanShell 的 Bean 的完整工作示例, 该 Bean 实现了本章前面定义的 Messenger 接口. 我们再次显示 Messenger 接口的定义:

public interface Messenger {

    String getMessage();
}

下面的示例显示了 Messenger 接口的 BeanShell “implementation”:

String message;

String getMessage() {
    return message;
}

void setMessage(String aMessage) {
    message = aMessage;
}

The following example shows the Spring XML that defines an “instance” of the above “class” (again, we use these terms very loosely here):

<lang:bsh id="messageService" script-source="classpath:BshMessenger.bsh"
    script-interfaces="org.springframework.scripting.Messenger">

    <lang:property name="message" value="Hello World!" />
</lang:bsh>

有关可能需要使用基于 BeanShell 的 bean 的某些方案, 请参阅 Scenarios.

3.3. Scenarios

用脚本语言定义 Spring 托管 Bean 可能会有所裨益的方案有很多, 而且也各不相同. 本节描述了 Spring 中对动态语言支持的两种可能的用例.

3.3.1. 脚本 Spring MVC Controllers

可以从使用动态语言支持的 bean 中受益的一组类是 Spring MVC 控制器的类. 在纯 Spring MVC 应用程序中, 通过 Web 应用程序的导航流在很大程度上取决于封装在 Spring MVC 控制器中的代码. 由于需要更新 Web 应用程序的导航流和其他表示层逻辑以响应支持问题或不断变化的业务需求, 因此通过编辑一个或多个动态语言源文件并查看它们, 很容易实现任何此类必需的更改. 更改立即反映在正在运行的应用程序的状态中.

请记住, 在像 Spring 这样的项目所拥护的轻量级架构模型中, 您通常旨在拥有一个非常浅的表示层, 而应用程序的所有繁琐的业务逻辑都包含在 domain 和服务层类中. 将 Spring MVC 控制器开发为支持动态语言的 Bean, 使您可以通过编辑和保存文本文件来更改表示层逻辑. 对此类动态语言源文件的任何更改(取决于配置)都会自动反映在由动态语言源文件支持的 Bean 中.

要对动态语言支持的 bean 进行任何更改的这种自动 “pickup”, 必须启用 “refreshable beans” 功能. 有关此功能的完整处理, 请参见 Refreshable Beans.

以下示例显示了使用 Groovy 动态语言实现的 org.springframework.web.servlet.mvc.Controller:

import org.springframework.showcase.fortune.service.FortuneService
import org.springframework.showcase.fortune.domain.Fortune
import org.springframework.web.servlet.ModelAndView
import org.springframework.web.servlet.mvc.Controller

import javax.servlet.http.HttpServletRequest
import javax.servlet.http.HttpServletResponse

class FortuneController implements Controller {

    @Property FortuneService fortuneService

    ModelAndView handleRequest(HttpServletRequest request,
            HttpServletResponse httpServletResponse) {
        return new ModelAndView("tell", "fortune", this.fortuneService.tellFortune())
    }
}
<lang:groovy id="fortune"
        refresh-check-delay="3000"
        script-source="/WEB-INF/groovy/FortuneController.groovy">
    <lang:property name="fortuneService" ref="fortuneService"/>
</lang:groovy>

3.3.2. 脚本验证

可以从动态语言支持的 bean 提供的灵活性中受益的, 使用 Spring 进行应用程序开发的另一个领域是验证领域. 与常规 Java 相比, 使用松散类型的动态语言(可能还支持内联正则表达式)来表达复杂的验证逻辑会更容易.

同样, 将验证器开发为动态语言支持的 bean, 使您可以通过编辑和保存简单的文本文件来更改验证逻辑. 任何此类更改(取决于配置)都会自动反映在正在运行的应用程序的执行中, 而无需重新启动应用程序

要对动态语言支持的 bean 进行任何更改的这种自动 “pickup”, 必须启用 “refreshable beans” 功能. 有关此功能的完整处理, 请参见 Refreshable Beans.

以下示例显示了使用 Groovy 动态语言实现的 Spring org.springframework.validation.Validator(请参阅 使用 Spring 的 Validator 接口进行验证, 以了解 Validator 接口):

import org.springframework.validation.Validator
import org.springframework.validation.Errors
import org.springframework.beans.TestBean

class TestBeanValidator implements Validator {

    boolean supports(Class clazz) {
        return TestBean.class.isAssignableFrom(clazz)
    }

    void validate(Object bean, Errors errors) {
        if(bean.name?.trim()?.size() > 0) {
            return
        }
        errors.reject("whitespace", "Cannot be composed wholly of whitespace.")
    }
}

3.4. 额外细节

最后一部分包含与动态语言支持有关的一些其他详细信息.

3.4.1. AOP — Advising Scripted Beans

您可以使用 Spring AOP 框架来通知脚本化 Bean. 实际上, Spring AOP 框架没有意识到通知使用的 Bean 可能是脚本 Bean, 因此您使用(或打算使用)的所有 AOP 用例和功能都可以与脚本 Bean 一起使用. 当通知脚本 bean 时, 不能使用基于类的代理. 您必须使用interface-based proxies.

您不仅限于通知脚本化的 bean. 您还可以使用受支持的动态语言自己编写方面, 并使用此类 Bean 来通知其他 Spring Bean. 不过, 这确实是对动态语言支持的高级使用.

3.4.2. Scoping

万一这不是立即显而易见的话, 可以以与任何其他 Bean 相同的方式确定脚本 Bean 的范围. 各种 <lang:language/> 元素上的 scope 属性使您可以像使用常规 bean 一样控制基础脚本 bean 的范围. (默认范围是 singleton, 与 "常规" bean一样. )

以下示例使用 scope 属性定义范围为 prototype 的 Groovy:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:lang="http://www.springframework.org/schema/lang"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/lang https://www.springframework.org/schema/lang/spring-lang.xsd">

    <lang:groovy id="messenger" script-source="classpath:Messenger.groovy" scope="prototype">
        <lang:property name="message" value="I Can Do The RoboCop" />
    </lang:groovy>

    <bean id="bookingService" class="x.y.DefaultBookingService">
        <property name="messenger" ref="messenger" />
    </bean>

</beans>

有关 Spring 框架中作用域支持的完整讨论, 请参见 The IoC Container 中的 Bean Scopes.

3.4.3. The lang XML schema

Spring XML 配置中的 lang 元素用于处理以动态语言(例如 Groovy 或 BeanShell )编写的对象作为 Spring 容器中的 bean.

这些元素(和动态语言支持)在 Dynamic Language Support 中全面介绍. 有关此支持和 lang 元素的完整详细信息, 请参见该章.

要使用 lang schema 中的元素, 您需要在 Spring XML 配置文件的顶部具有以下序言. 以下代码段中的文本引用了正确的架构, 以便您可以使用 lang 命名空间中的标记:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:lang="http://www.springframework.org/schema/lang"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/lang https://www.springframework.org/schema/lang/spring-lang.xsd">

    <!-- bean definitions here -->

</beans>

3.5. Further Resources

以下链接提供了有关本章中引用的各种动态语言的更多资源: