语言

1. Kotlin

Kotlin 是一种以 JVM 为目标的静态类型语言 (和其他平台)允许编写简洁优雅的代码,同时提供 与用 Java 编写的现有库的互操作性非常好。spring-doc.cn

Spring 框架为 Kotlin 提供了一流的支持,并允许开发人员编写 Kotlin 应用程序几乎就像 Spring Framework 是原生 Kotlin 框架一样。spring-doc.cn

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

从 Spring Framework 5.2 开始,参考文档的大部分代码示例都是 除了 Java 之外,还以 Kotlin 提供。spring-doc.cn

如果您需要支持,请随时加入 Kotlin Slack 的 #spring 频道,或者在 Stackoverflow 上提出带有 和 as 标签的问题。springkotlinspring-doc.cn

1.1. 要求

Spring 框架支持 Kotlin 1.3 并需要 kotlin-stdlib(或其变体之一,例如 kotlin-stdlib-jdk8) 和 kotlin-reflect 出现在类路径中。如果您在 start.spring.io 上引导 Kotlin 项目,则默认提供这些 Cotlin。spring-doc.cn

1.2. 扩展

Kotlin 扩展提供了 以使用其他功能扩展现有类。Spring 框架 Kotlin API 使用这些扩展为现有 Spring API 添加新的特定于 Kotlin 的便利性。spring-doc.cn

Spring 框架 KDoc API 列表 并记录了所有可用的 Kotlin 扩展和 DSL。spring-doc.cn

请记住,需要导入 Kotlin 扩展才能使用。这意味着, 例如,Kotlin 扩展 仅在导入时可用。 也就是说,与静态导入类似,在大多数情况下,IDE 应该会自动建议导入。GenericApplicationContext.registerBeanorg.springframework.context.support.registerBean

例如,Kotlin 具体化类型参数为 JVM 泛型类型擦除提供了一种解决方法。 Spring Framework 提供了一些扩展来利用此功能。 这允许更好的 Kotlin API ,用于 Spring 中的新 WebFlux 和其他各种 API 的 API 的 API 中。RestTemplateWebClientspring-doc.cn

其他库(例如 Reactor 和 Spring Data)也提供 Kotlin 扩展 ,从而提供更好的整体 Kotlin 开发体验。

要在 Java 中检索对象列表,您通常会编写以下内容:Userspring-doc.cn

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

使用 Kotlin 和 Spring Framework 扩展,您可以改为编写以下内容:spring-doc.cn

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

与在 Java 中一样,Kotlin 是强类型的,但 Kotlin 巧妙的类型推断允许 以获得更短的语法。usersspring-doc.cn

1.3. 空安全

Kotlin 的主要功能之一是 null 安全、 它在编译时干净利落地处理值,而不是在运行时撞到著名的值。这通过可为 null 性使应用程序更安全 声明和表达“值或无值”语义,而无需支付包装器的成本,例如 . (Kotlin 允许使用具有可为 null 值的函数式结构。请参阅此 Kotlin null 安全综合指南nullNullPointerExceptionOptionalspring-doc.cn

尽管 Java 不允许在其类型系统中表达 null 安全,但 Spring 框架 通过在包中声明的对工具友好的 Comments 提供整个 Spring Framework API 的空安全性。 默认情况下,Kotlin 中使用的 Java API 中的类型被识别为平台类型。 对此,放宽了 null 检查。Kotlin 对 JSR-305 注释和 Spring 可为 null 性注释为 Kotlin 开发人员的整个 Spring Framework API 提供了空安全性。 具有在编译时处理 -相关问题的优势。org.springframework.langnullspring-doc.cn

Reactor 或 Spring Data 等库提供了 null 安全的 API 来利用此功能。

您可以通过添加编译器标志来配置 JSR-305 检查 选项:。-Xjsr305-Xjsr305={strict|warn|ignore}spring-doc.cn

对于 kotlin 版本 1.1+,默认行为与 . 该值需要考虑 Spring Framework API null-safety 在 Kotlin 类型中,但应在知道 Spring API 可为 null 性声明甚至可能在次要版本之间演变,并且可能会进行更多检查 在将来添加。-Xjsr305=warnstrictspring-doc.cn

尚不支持泛型类型参数、varargs 和数组元素可为 null 性。 但应该在即将发布的版本中。有关最新信息,请参阅此讨论

1.4. 类和接口

Spring 框架支持各种 Kotlin 结构,例如实例化 Kotlin 类 通过主构造函数、不可变类、数据绑定和函数可选参数 替换为默认值。spring-doc.cn

Kotlin 参数名称通过专用的 、 它允许查找接口方法参数名称,而无需在编译期间启用 Java 8 编译器标志。KotlinReflectionParameterNameDiscoverer-parametersspring-doc.cn

Jackson Kotlin 模块(必需) 用于序列化或反序列化 JSON 数据,在 找到,如果 Jackson 和 Kotlin 是 在没有 Jackson Kotlin 模块的情况下检测到。spring-doc.cn

您可以将配置类声明为 top level 或 nested 但不能声明为 inner, 因为后者需要对 outer 类的引用。spring-doc.cn

1.5. 注解

Spring 框架还利用 Kotlin 空安全性来确定是否需要 HTTP 参数,而无需显式 定义属性。这意味着 视为不是必需的,反之,被视为必需的。 Spring Messaging 注释也支持此功能。required@RequestParam name: String?@RequestParam name: String@Headerspring-doc.cn

以类似的方式,带有 、 或 的 Spring bean 注入使用 此信息用于确定 Bean 是否是必需的。@Autowired@Bean@Injectspring-doc.cn

例如,表示 bean 类型必须在应用程序上下文中注册,如果不存在这样的 bean,则不会引发错误。@Autowired lateinit var thing: ThingThing@Autowired lateinit var thing: Thing?spring-doc.cn

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

如果你对具有 properties 或主构造函数的类使用 Bean 验证 参数,则可能需要使用 Comments use-site 目标、 例如 或 ,如此 Stack Overflow 响应中所述。@field:NotNull@get:Size(min=5, max=15)

1.6. Bean 定义 DSL

Spring Framework 支持使用 lambda 以功能方式注册 bean 作为 XML 或 Java 配置 ( 和 ) 的替代方法。简而言之 它允许您使用充当 . 这种机制非常有效,因为它不需要任何反射或 CGLIB 代理。@Configuration@BeanFactoryBeanspring-doc.cn

例如,在 Java 中,您可以编写以下内容:spring-doc.cn

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 中,使用具体化的类型参数和 Kotlin 扩展, 您可以改为编写以下内容:GenericApplicationContextspring-doc.cn

class Foo

class Bar(private val foo: Foo)

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

当类只有一个构造函数时,您甚至可以只指定 bean 类 构造函数参数将按类型自动装配:Barspring-doc.cn

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

为了实现更具声明性的方法和更简洁的语法, Spring Framework 提供了 一个 Kotlin bean 定义 DSL 它通过一个干净的声明式 API 声明了一个 它允许您处理配置文件和自定义 如何注册 bean。ApplicationContextInitializerEnvironmentspring-doc.cn

在以下示例中,请注意:spring-doc.cn

  • 类型推断通常允许避免为 bean 引用指定类型,例如ref("bazBean")spring-doc.cn

  • 可以使用 Kotlin 顶级函数通过可调用引用来声明 bean,如本例所示bean(::myRouter)spring-doc.cn

  • 指定 或 时,参数将按类型自动装配bean<Bar>()bean(::myRouter)spring-doc.cn

  • 仅当配置文件处于活动状态时,才会注册 BeanFooBarfoobarspring-doc.cn

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 是编程的,这意味着它允许自定义 bean 的注册逻辑 通过表达式、循环或任何其他 Kotlin 构造。iffor

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

val context = GenericApplicationContext().apply {
    myBeans.initialize(this)
    refresh()
}
Spring Boot 基于 JavaConfig,尚未为函数式 bean 定义提供特定支持。 但是你可以通过 Spring Boot 的支持来实验性地使用函数式 bean 定义。 有关更多详细信息和最新信息,请参阅此 Stack Overflow 答案。另请参阅在 Spring Fu 培养箱中开发的实验性 Kofu DSL。ApplicationContextInitializer

1.7. 网页

1.7.1. 路由器 DSL

Spring Framework 附带了一个 Kotlin 路由器 DSL,有 3 种风格可供选择:spring-doc.cn

这些 DSL 允许您编写简洁且惯用的 Kotlin 代码来构建实例,如下例所示:RouterFunctionspring-doc.cn

@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 是编程的,这意味着它允许自定义 bean 的注册逻辑 通过表达式、循环或任何其他 Kotlin 构造。这可能很有用 当您需要根据动态数据(例如,从数据库)注册路由时。iffor

有关具体示例,请参阅 MiXiT 项目spring-doc.cn

1.7.2. MockMvc DSL

Kotlin DSL 是通过 Kotlin 扩展提供的,以便提供更多 惯用的 Kotlin API,并且为了提高可发现性(不使用静态方法)。MockMvcspring-doc.cn

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 使用脚本引擎来渲染模板。spring-doc.cn

通过利用和依赖关系,它 可以使用此功能通过 kotlinx.html DSL 或 Kotlin 多行插值来呈现基于 Kotlin 的模板。kotlin-script-runtimescripting-jsr223-embeddableStringspring-doc.cn

build.gradle.ktsspring-doc.cn

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

配置通常是用 和 bean 完成的。ScriptTemplateConfigurerScriptTemplateViewResolverspring-doc.cn

KotlinScriptConfiguration.ktspring-doc.cn

@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 示例 project 了解更多详情。spring-doc.cn

1.8. 协程

Kotlin 协程就是 Kotlin 轻量级线程允许以命令式方式编写非阻塞代码。在语言方面, 挂起函数为异步操作提供了抽象,而在库端,kotlinx.coroutines 提供了 async { } 等函数和 Flow 等类型。spring-doc.cn

Spring Framework 在以下范围内为 Coroutines 提供支持:spring-doc.cn

1.8.1. 依赖项

当 and dependencies 位于 classpath 中时,将启用协程支持:kotlinx-coroutines-corekotlinx-coroutines-reactorspring-doc.cn

build.gradle.ktsspring-doc.cn

dependencies {

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

支持 版本及以上。1.3.0spring-doc.cn

1.8.2. Reactive 如何转换为 Coroutines?

对于返回值,从 Reactive API 到 Coroutines API 的转换如下:spring-doc.cn

  • fun handler(): Mono<Void>成为suspend fun handler()spring-doc.cn

  • fun handler(): Mono<T>变为 或 取决于 是否可以为空(具有更静态类型的优势)suspend fun handler(): Tsuspend fun handler(): T?Monospring-doc.cn

  • fun handler(): Flux<T>成为fun handler(): Flow<T>spring-doc.cn

对于输入参数:spring-doc.cn

  • 如果不需要 laziness,则可以调用 become since 一个挂起的函数来获取 value 参数。fun handler(mono: Mono<T>)fun handler(value: T)spring-doc.cn

  • 如果需要 laziness,则变为 或fun handler(mono: Mono<T>)fun handler(supplier: suspend () → T)fun handler(supplier: suspend () → T?)spring-doc.cn

Flow 在 Coroutines 世界中是等效的,适用于热流或冷流、有限流或无限流,主要区别如下:Fluxspring-doc.cn

有关更多详细信息,包括如何与协程并发运行代码,请参阅这篇关于使用 Spring、Coroutines 和 Kotlin Flow 实现反应式的博文。spring-doc.cn

1.8.3. 控制器

下面是一个 Coroutines 示例。@RestControllerspring-doc.cn

@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()
    }

}

还支持使用 进行视图渲染。@Controllerspring-doc.cn

@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 和相关处理程序定义的协程路由器示例。spring-doc.cn

@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. 事务

协程上的事务通过 Reactive 的编程变体支持 从 Spring Framework 5.2 开始提供的事务 Management。spring-doc.cn

对于挂起功能,提供了扩展。TransactionalOperator.executeAndAwaitspring-doc.cn

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 ,提供了一个扩展。FlowFlow<T>.transactionalspring-doc.cn

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 项目

本节提供了一些值得开发 Spring 项目的具体提示和建议 在 Kotlin 中。spring-doc.cn

1.9.1. 默认为 Final

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

虽然 Kotlin 的 JVM 友好设计通常与 Spring 没有摩擦,但这个特定的 Kotlin 功能 如果不考虑这一事实,则可以阻止应用程序启动。这是因为 Spring bean(例如带注释的类,默认情况下需要在运行时扩展,以便技术 原因)通常由 CGLIB 代理。解决方法是在每个类上添加一个关键字,然后 member 函数,该函数可以 很快就会变得痛苦,并且违背了保持代码简洁和可预测的 Kotlin 原则。@Configurationopenspring-doc.cn

也可以使用 CGLIB 代理来避免配置类的 CGLIB 代理。 有关更多详细信息,请参见 proxyBeanMethods Javadoc@Configuration(proxyBeanMethods = false)

幸运的是,Kotlin 提供了一个 kotlin-spring 插件(插件的预配置版本),可以自动打开类 及其成员函数,适用于使用以下项之一进行批注或元批注的类型 附注:kotlin-allopenspring-doc.cn

元注释支持意味着使用 、 或 注释的类型会自动打开,因为这些 注释使用 .@Configuration@Controller@RestController@Service@Repository@Componentspring-doc.cn

start.spring.io 启用 插件。因此,在实践中,您可以编写 Kotlin bean 没有任何其他关键字,就像在 Java 中一样。kotlin-springopenspring-doc.cn

Spring Framework 文档中的 Kotlin 代码示例未明确指定类及其成员函数。这些示例是为项目编写的 使用插件,因为这是最常用的设置。openkotlin-allopen

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

在 Kotlin 中,声明只读属性非常方便,并且被认为是一种最佳做法 在 Primary 构造函数中,如以下示例所示:spring-doc.cn

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

您可以选择添加 data 关键字,以使编译器自动从声明的所有属性中派生以下成员 在 Primary 构造函数中:spring-doc.cn

如下例所示,这允许轻松更改各个属性,即使属性是只读的:Personspring-doc.cn

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 注释注释的类生成合成 no-arg 构造函数。spring-doc.cn

如果需要将这种机制用于其他持久性技术,则可以配置 kotlin-noarg 插件。spring-doc.cn

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

1.9.3. 注入依赖项

我们的建议是尝试使用只读(并且 non-nullable when possible) 属性、 如下例所示:valspring-doc.cn

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

如果你真的需要使用字段注入,你可以使用 construct 如下例所示:lateinit varspring-doc.cn

@Component
class YourBean {

    @Autowired
    lateinit var mongoTemplate: MongoTemplate

    @Autowired
    lateinit var solrClient: SolrClient
}

1.9.4. 注入配置属性

在 Java 中,您可以使用注释(例如 )来注入配置属性。 但是,在 Kotlin 中,是用于字符串插值的保留字符。@Value("${property}")$spring-doc.cn

因此,如果您希望在 Kotlin 中使用注释,则需要通过编写 .@Value$@Value("\${property}")spring-doc.cn

如果您使用 Spring Boot,则可能应该使用 @ConfigurationProperties 而不是 Comments。@Value

或者,您可以通过声明 以下配置 bean:spring-doc.cn

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

您可以自定义现有代码(例如 Spring Boot 执行器或 ) 使用带有配置 bean 的语法,如下例所示:@LocalServerPort${…​}spring-doc.cn

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

@Bean
fun defaultPropertyConfigurer() = PropertySourcesPlaceholderConfigurer()

1.9.5. 检查的异常

Java 和 Kotlin 异常处理非常接近,主要区别在于 Kotlin 将所有异常视为 unchecked 异常。但是,当使用代理对象(例如类或方法 annotated with ),则默认情况下,抛出的选中异常将包装在 一。@TransactionalUndeclaredThrowableExceptionspring-doc.cn

要像在 Java 中一样引发原始异常,方法应该用 @Throws 进行注释,以明确指定引发的检查异常(例如 )。@Throws(IOException::class)spring-doc.cn

1.9.6. 注解数组属性

Kotlin 注解与 Java 注解大体相似,但数组属性(即 在 Spring 中广泛使用)的行为不同。如 Kotlin 文档中所述,您可以省略 属性名称,并将其指定为参数。valuevarargspring-doc.cn

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

public @interface RequestMapping {

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

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

    RequestMethod[] method() default {};

    // ...
}

的典型用例是将处理程序方法映射到特定路径 和方法。在 Java 中,您可以为 annotation 数组属性指定单个值 它会自动转换为数组。@RequestMappingspring-doc.cn

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

但是,在 Kotlin 中,您必须编写 or(方括号需要 使用命名数组属性指定)。@RequestMapping("/toys", method = [RequestMethod.GET])@RequestMapping(path = ["/toys"], method = [RequestMethod.GET])spring-doc.cn

此特定属性(最常见的属性)的替代方法是 使用快捷方式注释,例如 、 和其他注释。method@GetMapping@PostMappingspring-doc.cn

如果未指定该属性,则所有 HTTP 方法都将 匹配,而不仅仅是 method。@RequestMappingmethodGET

1.9.7. 测试

本节介绍了使用 Kotlin 和 Spring Framework 的组合进行测试。 推荐的测试框架是 JUnit 5 以及用于模拟的 Mockkspring-doc.cn

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

专门部分所述, JUnit 5 允许 bean 的构造函数注入,这对 Kotlin 非常有用 以便使用 而不是 .您可以使用 @TestConstructor(autowireMode = AutowireMode.ALL) 为所有参数启用自动装配。vallateinit varspring-doc.cn

@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 测试类可以使用注解来启用测试类的单个实例化,从而允许在非静态方法上使用 AND 注解,这非常适合 Kotlin。`@TestInstance(TestInstance.Lifecycle.PER_CLASS)@BeforeAll@AfterAllspring-doc.cn

您还可以将默认行为更改为 thanks to a file with a property.PER_CLASSjunit-platform.propertiesjunit.jupiter.testinstance.lifecycle.default = per_classspring-doc.cn

以下示例对非静态方法进行演示和注释:@BeforeAll@AfterAllspring-doc.cn

@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 创建类似规范的测试。 以下示例显示了如何执行此操作:spring-doc.cn

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)
     }
  }
}
WebTestClientKotlin 中的类型推断问题

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

另请参阅相关的 SPR-16057 问题。spring-doc.cn

1.10. 入门

学习如何使用 Kotlin 构建 Spring 应用程序的最简单方法是遵循专门的教程spring-doc.cn

1.10.1.start.spring.io

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

1.10.2. 选择 Web 风格

Spring Framework 现在带有两个不同的 Web 堆栈:Spring MVCSpring WebFluxspring-doc.cn

如果您想创建将处理延迟的应用程序,建议使用 Spring WebFlux, 长期连接、流式处理方案或想要使用 Web 功能 Kotlin DSL 的 DSL 中。spring-doc.cn

对于其他使用案例,特别是如果您使用 JPA、Spring 等阻塞技术 MVC 及其基于注释的编程模型是推荐的选择。spring-doc.cn

1.11. 资源

我们为学习如何使用 Kotlin 和 Spring 框架:spring-doc.cn

1.11.1. 示例

以下 Github 项目提供了一些示例,您可以从中学习,甚至可能进行扩展:spring-doc.cn

2. 阿帕奇 Groovy

Groovy 是一种功能强大的、可选类型的动态语言,具有 static-type 和 static 编译功能。它提供简洁的语法,并与任何 现有的 Java 应用程序。spring-doc.cn

Spring Framework 提供了一个专用的,它支持基于 Groovy 的 Bean 定义 DSL。有关更多详细信息,请参阅 Groovy Bean 定义 DSL。ApplicationContextspring-doc.cn

对 Groovy 的进一步支持,包括用 Groovy 编写的 bean、可刷新的脚本 bean、 以及更多内容,可在 Dynamic Language Support 中使用。spring-doc.cn

3. 动态语言支持

Spring 为使用已 通过在 Spring 中使用动态语言(例如 Groovy)来定义。此支持允许 您可以使用支持的动态语言编写任意数量的类,并拥有 Spring 容器透明地实例化、配置和依赖注入生成的 对象。spring-doc.cn

Spring 的脚本支持主要针对 Groovy 和 BeanShell。超越这些 特别支持的语言,支持 JSR-223 脚本机制 用于与任何支持 JSR-223 的语言提供程序集成(从 Spring 4.2 开始), 例如 JRuby。spring-doc.cn

您可以找到有关此动态语言支持的完整工作示例 立即在 Scenarios 中有用。spring-doc.cn

3.1. 第一个例子

本章的大部分内容是描述 细节。在深入研究动态语言支持的所有细节之前, 我们看一个用动态语言定义的 bean 的快速示例。动态 第一个 bean 的语言是 Groovy。(此示例的基础取自 Spring 测试套件。如果您想在任何其他 支持的语言,请查看源代码)。spring-doc.cn

下一个示例显示了 Groovy bean 将要访问的接口 实现。请注意,此接口是用纯 Java 定义的。依赖对象 注入了对 do not know underlying implementation 是一个 Groovy 脚本。下面的清单显示了该接口:MessengerMessengerMessengerspring-doc.cn

package org.springframework.scripting;

public interface Messenger {

    String getMessage();
}

以下示例定义一个依赖于接口的类:Messengerspring-doc.cn

package org.springframework.scripting;

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 中实现接口:Messengerspring-doc.cn

// from the file 'Messenger.groovy'
package org.springframework.scripting.groovy;

// 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 实现作为 IoC 容器。支持将动态语言支持的 bean 与普通实现一起使用,但您必须管理 Spring 内部的管道 执行此操作。ApplicationContextBeanFactoryspring-doc.cn

有关基于架构的配置的更多信息,请参阅 XML 基于架构的配置spring-doc.cn

最后,以下示例显示了影响 Groovy 定义的实现添加到类的实例中:MessengerDefaultBookingServicespring-doc.cn

<?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>

bean (a ) 现在可以正常使用其私有成员变量,因为注入其中的实例是 一个实例。这里没有什么特别的事情 — 只是普通的 Java 和 普通的 Groovy。bookingServiceDefaultBookingServicemessengerMessengerMessengerspring-doc.cn

希望前面的 XML 代码段是不言自明的,但如果不是,请不要过分担心。 请继续阅读,深入了解上述配置的原因和原因。spring-doc.cn

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

本节准确描述了如何在任何 支持的动态语言。spring-doc.cn

请注意,本章并不试图解释支持的 动态语言。例如,如果您想使用 Groovy 编写某些类 在您的应用程序中,我们假设您已经了解 Groovy。如果您需要更多详细信息 关于动态语言本身,请参阅 末尾的 更多资源 本章。spring-doc.cn

3.2.1. 常见概念

使用动态语言支持的 bean 所涉及的步骤如下:spring-doc.cn

  1. 为动态语言源代码编写测试(自然)。spring-doc.cn

  2. 然后编写动态语言源代码本身。spring-doc.cn

  3. 通过在 XML 配置中使用适当的元素来定义动态语言支持的 bean(您可以通过以下方式以编程方式定义此类 bean 使用 Spring API,尽管您必须查阅 有关如何执行此操作的说明,因为本章不介绍这种类型的高级配置)。 请注意,这是一个迭代步骤。每个动态至少需要一个 bean 定义 language 源文件(尽管多个 bean 定义可以引用同一个源文件)。<lang:language/>spring-doc.cn

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

<lang:language/> 元素

上一节列表中的最后一步涉及定义动态语言支持的 bean 定义,每个 bean 定义 想要配置(这与普通的 JavaBean 配置没有什么不同)。然而 而不是指定要 由容器实例化和配置,则可以使用该元素来定义动态语言支持的 Bean。<lang:language/>spring-doc.cn

每种支持的语言都有相应的元素:<lang:language/>spring-doc.cn

可用于配置的确切属性和子元素取决于 确切地说,是用哪种语言定义 Bean(特定于语言的部分 本章稍后将详细介绍这一点)。spring-doc.cn

可刷新的 Bean

动态语言最引人注目的附加值之一(也许是唯一的) Spring 中的支持是“可刷新的 bean”功能。spring-doc.cn

可刷新 Bean 是动态语言支持的 Bean。用少量 configuration 中,动态语言支持的 bean 可以监视其底层 bean 中的更改 source file 资源,然后在动态语言源文件为 已更改(例如,当您在文件系统上编辑并保存对文件的更改时)。spring-doc.cn

这允许您将任意数量的动态语言源文件部署为 应用程序中,配置 Spring 容器以创建由动态 语言源文件(使用本章中介绍的机制)和(稍后的 随着需求的变化或其他一些外部因素的开始发挥作用)编辑一个动态 language 源文件,并且他们所做的任何更改都会反映在 Bean 中,即 由更改的动态语言源文件提供支持。无需关闭 正在运行的应用程序(如果是 Web 应用程序,则为 redeploy)。这 dynamic-language-supported bean so modified 从 更改了动态语言源文件。spring-doc.cn

默认情况下,此功能处于关闭状态。

现在我们可以看一个示例,看看开始使用 refreshable 是多么容易 豆。要打开可刷新 bean 功能,您必须指定一个 additional 属性。所以 如果我们坚持前面的例子 本章,以下示例显示了我们将在 Spring XML 中更改的内容 配置以影响可刷新的 bean:<lang:language/>spring-doc.cn

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

这真的就是你所要做的。在 Bean 定义上定义的属性是 Bean 为 刷新对基础动态语言源文件所做的任何更改。 您可以通过为属性分配负值来关闭刷新行为。请记住,默认情况下,刷新行为为 禁用。如果不需要刷新行为,请不要定义该属性。refresh-check-delaymessengerrefresh-check-delayspring-doc.cn

如果我们随后运行以下应用程序,则可以执行可刷新功能。 (请原谅那些 “跳过圈子暂停执行 ”的恶作剧 在下一段代码中。调用只是为了让 程序的执行在您(本方案中的开发人员)离开时暂停 并编辑基础动态语言源文件,以便触发刷新 在动态语言支持的 bean 上。System.in.read()spring-doc.cn

下面的清单显示了这个示例应用程序:spring-doc.cn

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());
    }
}

然后,为了本例的目的,假设必须更改对 implementation 方法的所有调用,以便消息为 用引号括起来。以下清单显示了您 (开发人员)应在 程序的执行已暂停:getMessage()MessengerMessenger.groovyspring-doc.cn

package org.springframework.scripting

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
    }
}

当程序运行时,输入暂停之前的输出将为 。 在对源文件进行更改并保存并且程序恢复执行后, 在 Dynamic-Language 支持的实现上调用该方法的结果是(请注意,包含 附加引号)。I Can Do The FruggetMessage()Messenger'I Can Do The Frug'spring-doc.cn

如果对脚本的更改发生在 值。对脚本的更改实际上直到 在动态语言支持的 Bean 上调用方法。只有当方法 调用了动态语言支持的 Bean,它会检查其底层脚本是否 来源已更改。与刷新脚本相关的任何异常(例如 遇到编译错误或发现脚本文件已被删除) 导致致命异常传播到调用代码。refresh-check-delayspring-doc.cn

前面描述的可刷新 bean 行为不适用于动态语言 使用元素表示法定义的源文件(请参阅内联动态语言源文件)。此外,它仅适用于 实际上可以检测到对底层源文件的更改(例如,通过代码 检查存在于 文件系统)。<lang:inline-script/>spring-doc.cn

内联动态语言源文件

动态语言支持还可以满足以下动态语言源文件的需求 直接嵌入到 Spring bean 定义中。更具体地说,该元素允许您立即定义动态语言源 在 Spring 配置文件中。一个例子可以阐明内联脚本 功能作品:<lang:inline-script/>spring-doc.cn

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

如果我们把围绕定义 dynamic language 源,该元素在某些情况下可能很有用。例如,我们可能希望快速添加 Spring implementation 到 Spring MVC 中。这只是片刻的 使用内联源工作。(有关此类 示例。<lang:inline-script/>ValidatorControllerspring-doc.cn

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

关于 Spring 的动态,有一件非常重要的事情需要注意 语言支持。也就是说,你不能(目前)提供构造函数参数 添加到动态语言支持的 bean 中(因此,构造函数注入不适用于 dynamic-language-backed bean 的 bean)。为了对 构造函数和属性 100% 清晰,以下代码和配置的混合 不起作用:spring-doc.cn

行不通的方法
// from the file 'Messenger.groovy'
package org.springframework.scripting.groovy;

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 注入是绝大多数开发人员青睐的注入方式 (我们把关于这是否是一件好事的讨论留到另一天)。spring-doc.cn

3.2.2. Groovy Bean

本节介绍如何在 Spring 中使用 Groovy 中定义的 bean。spring-doc.cn

Groovy 主页包括以下描述:spring-doc.cn

“Groovy 是一种面向 Java 2 平台的敏捷动态语言,它具有许多 人们在 Python、Ruby 和 Smalltalk 等语言中非常喜欢的功能,使得 它们可供 Java 开发人员使用类似 Java 的语法。spring-doc.cn

如果你直接从顶部阅读了本章,你已经看到了一个 Groovy-dynamic-language-backed 的例子 豆。现在考虑另一个示例(再次使用 Spring 测试套件中的示例):spring-doc.cn

package org.springframework.scripting;

public interface Calculator {

    int add(int x, int y);
}

以下示例在 Groovy 中实现接口:Calculatorspring-doc.cn

// from the file 'calculator.groovy'
package org.springframework.scripting.groovy

class GroovyCalculator implements Calculator {

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

以下 bean 定义使用 Groovy 中定义的计算器:spring-doc.cn

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

最后,以下小型应用程序执行上述配置:spring-doc.cn

package org.springframework.scripting;

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));
    }
}

运行上述程序的结果输出是(不出所料)。 (有关更多有趣的示例,请参阅 dynamic language showcase 项目以获取更多 complex 示例,或参阅本章后面的示例场景)。10spring-doc.cn

每个 Groovy 源文件不能定义多个类。虽然这是完美的 legal,这(可以说)是一种糟糕的做法。为了始终如一的 方法,您应该(在 Spring 团队看来)尊重标准的 Java 每个源文件一个 (public) 类的约定。spring-doc.cn

使用回调自定义 Groovy 对象

该接口是一个回调,允许您挂接额外的 创建逻辑添加到创建 Groovy 支持的 bean 的过程中。例如 此接口的实现可以调用任何所需的初始化方法, 设置一些默认属性值,或指定自定义 .以下清单 显示了接口定义:GroovyObjectCustomizerMetaClassGroovyObjectCustomizerspring-doc.cn

public interface GroovyObjectCustomizer {

    void customize(GroovyObject goo);
}

Spring Framework 实例化 Groovy 支持的 bean 的实例,然后 将 created 传递给指定的 (如果 已定义)。您可以使用提供的引用执行任何您喜欢的操作。我们预计大多数人都希望使用 this 设置自定义 callback 的 Tim 函数,以下示例显示了如何执行此操作:GroovyObjectGroovyObjectCustomizerGroovyObjectMetaClassspring-doc.cn

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 命名空间支持,那么使用 a 很容易,因为 以下示例显示:GroovyObjectCustomizerspring-doc.cn

<!-- 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 命名空间支持,您仍然可以使用该功能,如下例所示:GroovyObjectCustomizerspring-doc.cn

<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"/>
您还可以指定 Groovy (例如 ) 甚至是与 Spring 的 .此外,您可以设置一个带有自定义的 common 级别的 bean 的配置; 这也会导致共享使用,因此建议在以下情况下使用 大量脚本化 bean(避免每个 bean 有一个孤立的实例)。CompilationCustomizerImportCustomizerCompilerConfigurationGroovyObjectCustomizerGroovyClassLoaderConfigurableApplicationContext.setClassLoaderGroovyClassLoaderGroovyClassLoader

3.2.3. BeanShell Bean

本节介绍如何在 Spring 中使用 BeanShell bean。spring-doc.cn

BeanShell 主页包括以下内容 描述:spring-doc.cn

BeanShell is a small, free, embeddable Java source interpreter with dynamic language
features, written in Java. BeanShell dynamically runs 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 动态代理,该代理实现了所有 interfaces 的 APIS(这就是为什么您必须在值 属性,因此,当您使用 BeanShell 支持的 beans) 的 bean 的 T这意味着对 BeanShell 支持的对象的每个方法调用都会通过 JDK 动态代理调用机制。script-interfaces<lang:bsh>spring-doc.cn

现在,我们可以展示一个使用基于 BeanShell 的 bean 的完整工作示例,该 bean 实现 本章前面定义的接口。我们再次展示 接口定义:MessengerMessengerspring-doc.cn

package org.springframework.scripting;

public interface Messenger {

    String getMessage();
}

下面的示例展示了 BeanShell 的 “实现” (我们在这里松散地使用了这个术语) 的界面中:Messengerspring-doc.cn

String message;

String getMessage() {
    return message;
}

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

以下示例显示了定义上述 “实例” 的 Spring XML “class”(同样,我们在这里非常松散地使用这些术语):spring-doc.cn

<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。spring-doc.cn

3.3. 场景

在脚本语言中定义 Spring 托管 bean 的可能情况是 有益是多种多样的。本节介绍了 Spring 中的动态语言支持。spring-doc.cn

3.3.1. 脚本化的 Spring MVC 控制器

可以从使用动态语言支持的 bean 中受益的一组类是 Spring MVC 控制器。在纯 Spring MVC 应用程序中,导航流 通过 Web 应用程序在很大程度上由封装在 你的 Spring MVC 控制器。作为导航流等表示层逻辑 的 Web 应用程序需要更新以响应支持问题或更改 业务要求,则通过以下方式实现任何此类所需的更改可能更容易 编辑一个或多个动态语言源文件,并看到这些更改 立即反映在正在运行的应用程序的状态中。spring-doc.cn

请记住,在项目支持的轻量级架构模型中,例如 Spring,您通常的目标是拥有一个非常薄的表示层,其中包含所有 包含在域和服务中的应用程序的丰富业务逻辑 Layer 类。将 Spring MVC 控制器开发为动态语言支持的 bean 允许 您可以通过编辑和保存文本文件来更改表示图层逻辑。任何 对此类动态语言源文件的更改是 (取决于配置) 自动反映在由动态语言源文件支持的 bean 中。spring-doc.cn

为了实现对 dynamic-language-backed 的任何更改的自动 “拾取” beans 中,您必须启用 “refreshable beans” 功能。有关此功能的完整处理,请参见 Refreshable Bean

以下示例显示了已实现的 通过使用 Groovy 动态语言:org.springframework.web.servlet.mvc.Controllerspring-doc.cn

// from the file '/WEB-INF/groovy/FortuneController.groovy'
package org.springframework.showcase.fortune.web

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. 脚本验证器

使用 Spring 进行应用程序开发的另一个领域可能会受益于 动态语言支持的 bean 提供的灵活性是验证的灵活性。它可以 通过使用松散类型的动态语言,更容易表达复杂的验证逻辑 (也可能支持内联正则表达式)而不是常规 Java。spring-doc.cn

同样,将验证器开发为动态语言支持的 bean 可以让您更改 验证逻辑。任何此类更改都是 (取决于配置)自动反映在 正在运行的应用程序,并且不需要重新启动应用程序。spring-doc.cn

实现对 dynamic-language-backed 的任何更改的自动 “拾取” beans 中,您必须启用 'refreshable beans' 功能。有关此功能的完整和详细处理,请参见 Refreshable Bean

下面的示例展示了使用 Groovy 动态语言实现的 Spring(有关接口的讨论,请参见使用 Spring 的 Validator 接口进行验证):org.springframework.validation.ValidatorValidatorspring-doc.cn

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. 其他详细信息

最后一部分包含一些与动态语言支持相关的其他详细信息。spring-doc.cn

3.4.1. AOP — 为脚本化 bean 提供建议

您可以使用 Spring AOP 框架来通知脚本化 bean。Spring AOP 系列 框架实际上不知道被通知的 bean 可能是脚本 bean,因此您使用(或打算使用)的所有 AOP 用例和功能 使用脚本化 bean。当您建议脚本 bean 时,不能使用基于类的 代理。您必须使用基于接口的代理spring-doc.cn

您不仅限于为脚本 bean 提供建议。你也可以自己编写 aspect 并使用此类 bean 来通知其他 Spring bean。 不过,这确实是动态语言支持的高级使用。spring-doc.cn

3.4.2. 范围

如果不是很明显,则可以采用与 任何其他 bean。各种元素上的属性允许 您可以控制底层脚本化 Bean 的范围,就像使用常规的 豆。(默认范围为单例, 就像 “常规” bean 一样。scope<lang:language/>spring-doc.cn

下面的示例使用该属性来定义一个范围为 原型scopespring-doc.cn

<?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 框架中范围支持的完整讨论,请参见 IoC 容器中Bean 范围spring-doc.cn

3.4.3. XML 模式lang

Spring XML 配置中的元素处理公开已 用动态语言(例如 Groovy 或 BeanShell)编写为 Spring 容器中的 bean。langspring-doc.cn

动态语言支持中全面介绍了这些元素(以及动态语言支持)。请参阅该部分 了解有关此支持和 Elements 的完整详细信息。langspring-doc.cn

要使用架构中的元素,您需要在 top 的 Spring XML 配置文件。以下代码段中的文本引用 正确的架构,以便命名空间中的标记可供您使用:langlangspring-doc.cn

<?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. 更多资源

以下链接指向有关引用的各种动态语言的更多资源 本章包含的主题:spring-doc.cn