语言
1. Kotlin
Spring Framework 为 Kotlin 提供了一流的支持,并允许开发人员编写 Kotlin 应用程序几乎就像 Spring Framework 是原生 Kotlin 框架一样。
使用 Kotlin 构建 Spring 应用程序的最简单方法是利用 Spring Boot 和 其专门的 Kotlin 支持。这个综合教程将教您如何使用 start.spring.io 使用 Kotlin 构建 Spring Boot 应用程序。
从 Spring Framework 5.2 开始,参考文档的大多数代码示例是 除了 Java 之外,还在 Kotlin 中提供。
欢迎加入 Kotlin Slack 的 #spring 频道或向spring
和kotlin
作为 Stackoverflow 上的标签,如果您需要支持。
1.1. 要求
Spring Framework 支持 Kotlin 1.3,需要kotlin-stdlib
(或其变体之一,例如kotlin-stdlib-jdk8
)
和kotlin-reflect
出现在类路径上。如果您在 start.spring.io 上引导 Kotlin 项目,则默认提供它们。
1.2. 扩展
Kotlin 扩展提供了以下功能 以使用附加功能扩展现有类。Spring Framework Kotlin API 使用这些扩展为现有 Spring API 添加新的 Kotlin 特定便利。
Spring Framework KDoc API 列表 并记录所有可用的 Kotlin 扩展和 DSL。
请记住,需要导入 Kotlin 扩展才能使用。这意味着,
例如,将GenericApplicationContext.registerBean Kotlin 扩展
仅在以下情况下可用org.springframework.context.support.registerBean 被导入。
也就是说,与静态导入类似,在大多数情况下,IDE 应该自动建议导入。 |
例如,Kotlin 具体化类型参数为 JVM 泛型类型擦除提供了解决方法,
Spring Framework 提供了一些扩展来利用此功能。
这允许更好的 Kotlin APIRestTemplate
,对于新的WebClient
从Spring开始
WebFlux 以及各种其他 API。
其他库(例如 Reactor 和 Spring Data)也提供 Kotlin 扩展 ,从而提供更好的整体 Kotlin 开发体验。 |
检索列表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 一样,users
在 Kotlin 中是强类型化的,但 Kotlin 巧妙的类型推断允许
用于更短的语法。
1.3. 空安全
Kotlin 的主要功能之一是空安全,
干净利落地处理null
值,而不是撞到著名的NullPointerException
在运行时。这通过可空性使应用程序更安全
声明并表达“值或无值”语义,而无需支付包装器的成本,例如Optional
.
(Kotlin 允许使用具有可为空值的函数式结构。请参阅此 Kotlin 空安全综合指南。
尽管 Java 不允许您在其类型系统中表达空安全性,但 Spring Framework
通过在org.springframework.lang
包。
默认情况下,Kotlin 中使用的 Java API 中的类型被识别为平台类型,
对其放宽空检查。Kotlin 对 JSR-305 注释和 Spring 空性注释的支持为 Kotlin 开发人员提供了整个 Spring Framework API 的空安全性,
具有处理的优势null
-相关问题。
Reactor 或 Spring Data 等库提供了空安全 API 来利用此功能。 |
您可以通过添加-Xjsr305
编译器标志,并添加以下内容 选项:-Xjsr305={strict|warn|ignore}
.
对于 kotlin 版本 1.1+,默认行为与-Xjsr305=warn
. 这strict
value 是需要考虑 Spring Framework API null 安全性的在从 Spring API 推断的 Kotlin 类型中,但应在知道 Spring 的情况下使用该类型API 可空性声明甚至可能在次要版本之间演变,并且可能会进行更多检查将来添加。
尚不支持泛型类型参数、varargs 和数组元素可空性,但应该在即将发布的版本中。有关最新信息,请参阅此讨论。 |
1.4. 类和接口
Spring Framework 支持各种 Kotlin 构造,例如实例化 Kotlin 类通过主构造函数、不可变类、数据绑定和函数可选参数使用默认值。
Kotlin 参数名称通过专用的KotlinReflectionParameterNameDiscoverer
, 它允许查找接口方法参数名称,而无需 Java 8-parameters
编译器标志。
Jackson Kotlin 模块是必需的用于序列化或反序列化 JSON 数据,在以下情况下自动注册在类路径中找到,并且如果 Jackson 和 Kotlin 是在不存在 Jackson Kotlin 模块的情况下检测到的,则会记录一条警告消息。
您可以将配置类声明为顶层或嵌套但不是内部,因为后者需要对外部类的引用。
1.5. 注释
Spring Framework 还利用 Kotlin 空安全来确定是否需要 HTTP 参数,而无需显式定义required
属性。 这意味着@RequestParam name: String?
被视为不需要,相反,@RequestParam name: String
被视为必需的。
Spring Messaging 也支持此功能@Header
注解。
以类似的方式,春豆注射@Autowired
,@Bean
或@Inject
使用
此信息用于确定是否需要 bean。
例如@Autowired lateinit var thing: Thing
意味着 bean
类型Thing
必须在应用程序上下文中注册,而@Autowired lateinit var thing: Thing?
如果这样的 bean 不存在,则不会引发错误。
遵循同样的原则,@Bean fun play(toy: Toy, car: Car?) = Baz(toy, Car)
意味 着
那 一种豆子Toy
必须在应用程序上下文中注册,而
类型Car
可能存在也可能不存在。相同的行为也适用于自动连接的构造函数参数。
如果对具有属性或主构造函数的类使用 bean 验证
参数,您可能需要使用注释 use-site targets,
如@field:NotNull 或@get:Size(min=5, max=15) ,如此 Stack Overflow 响应中所述。 |
1.6. Bean 定义 DSL
Spring Framework 支持使用 lambda 以函数方式注册 Bean
作为 XML 或 Java 配置 (@Configuration
和@Bean
).简而言之
它允许您使用 lambda 注册 bean,该 lambda 充当FactoryBean
.
这种机制非常有效,因为它不需要任何反射或 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 中,使用具体化的类型参数和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 Framework 提供了
一个 Kotlin bean 定义 DSL 它声明一个ApplicationContextInitializer
通过干净的声明式 API,
这使您可以处理配置文件和Environment
用于定制
如何注册 bean。
在以下示例中,请注意:
-
类型推断通常允许避免为 bean 引用指定类型,例如
ref("bazBean")
-
可以使用 Kotlin 顶级函数使用可调用引用来声明 bean,例如
bean(::myRouter)
在此示例中 -
指定时
bean<Bar>()
或bean(::myRouter)
,参数按类型自动连接 -
这
FooBar
只有当foobar
配置文件处于活动状态
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 的注册逻辑
通过if 表达式,一个for 循环或任何其他 Kotlin 构造。 |
然后您可以使用beans()
函数在应用程序上下文中注册 bean,
如以下示例所示:
val context = GenericApplicationContext().apply {
myBeans.initialize(this)
refresh()
}
Spring Boot 基于 JavaConfig,目前还没有提供对功能 bean 定义的特定支持,
但您可以通过 Spring Boot 的ApplicationContextInitializer 支持。
有关更多详细信息和最新信息,请参阅此 Stack Overflow 答案。另请参阅在 Spring Fu 培养箱中开发的实验性 Kofu DSL。 |
1.7. 网络
1.7.1. 路由器 DSL
Spring Framework 附带一个 Kotlin 路由器 DSL,有 3 种版本可供选择:
-
WebMvc.fn 带路由器的 DSL { }
-
WebFlux.fn Coroutines DSL with coRouter { }
这些 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 是编程的,这意味着它允许自定义 bean 的注册逻辑
通过if 表达式,一个for 循环或任何其他 Kotlin 构造。这可能很有用
当您需要根据动态数据(例如,来自数据库)注册路由时。 |
有关具体示例,请参阅 MiXiT 项目。
1.7.2. 模拟Mvc DSL
Kotlin DSL 通过MockMvc
Kotlin 扩展,以便提供更多
习惯的 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 使用脚本引擎渲染模板。
通过利用kotlin-script-runtime
和scripting-jsr223-embeddable
依赖项, it
可以使用此类功能来渲染基于 Kotlin 的模板kotlinx.html DSL 或 Kotlin 多行插值String
.
build.gradle.kts
dependencies {
compile("org.jetbrains.kotlin:kotlin-script-runtime:${kotlinVersion}")
runtime("org.jetbrains.kotlin:kotlin-scripting-jsr223-embeddable:${kotlinVersion}")
}
配置通常使用ScriptTemplateConfigurer
和ScriptTemplateViewResolver
豆。
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.8. 协程
Kotlin 协程是 Kotlin
轻量级线程允许以命令式方式编写非阻塞代码。在语言方面,
挂起函数为异步作提供了抽象,而在库端,kotlinx.coroutines 提供了类似的函数async { }
以及像Flow
.
Spring Framework 在以下范围内为协程提供支持:
-
暂停 Spring WebFlux 中的函数支持 Commented
@Controller
-
WebFlux.fn coRouter { } DSL
-
挂起函数和
Flow
RSocket 中的支持@MessageMapping
带注释的方法
1.8.1. 依赖项
在以下情况下启用协程支持kotlinx-coroutines-core
和kotlinx-coroutines-reactor
依赖项位于类路径中:
build.gradle.kts
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:${coroutinesVersion}")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:${coroutinesVersion}")
}
版本1.3.0
和以上支持。
1.8.2. Reactive 如何转换为协程?
对于返回值,从 Reactive API 到协程 API 的转换如下:
-
fun handler(): Mono<Void>
成为suspend fun handler()
-
fun handler(): Mono<T>
成为suspend fun handler(): T
或suspend 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?)
Flow
是Flux
等效于协程世界中,适用于热流或冷流、有限流或无限流,主要区别如下:
-
Flow
是基于推送的,而Flux
是推拉混合 -
背压是通过挂起功能实现的
-
Flow
只有一个单次挂起collect
方法运算符作为扩展实现 -
由于协程,运算符很容易实现
-
扩展允许将自定义运算符添加到
Flow
-
收集作是挂起功能
-
map
算子支持异步作(无需flatMap
),因为它采用挂起函数参数
阅读这篇关于使用 Spring、协程和 Kotlin Flow 进行响应式的博文,了解更多详细信息,包括如何与协程同时运行代码。
1.8.3. 控制器
下面是协程的示例@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 和相关处理程序定义的协程路由器的示例。
@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 开始提供的事务管理。
对于挂起函数,一个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
}
}
对于 KotlinFlow
一个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 项目
本节提供了一些开发 Spring 项目的具体提示和建议 在 Kotlin 中。
1.9.1. 默认情况下的最终
默认情况下,Kotlin 中的所有类都是final
. 这open
modifier 与 Java 的final
:它允许其他人继承自此
类。这也适用于成员函数,因为它们需要标记为open
被覆盖。
虽然 Kotlin 的 JVM 友好型设计通常与 Spring 无摩擦,但这个特定的 Kotlin 功能
如果不考虑这一事实,则可以阻止应用程序启动。这是因为
春豆(如@Configuration
带注释的类,默认情况下需要在运行时扩展以进行技术
原因)通常由 CGLIB 代理。解决方法是添加一个open
关键字和
由 CGLIB 代理的 Spring Bean 的成员函数,它可以
很快就会变得痛苦,并且违背了保持代码简洁和可预测的 Kotlin 原则。
还可以通过使用@Configuration(proxyBeanMethods = false) .
看proxyBeanMethods Javadoc了解更多详情。 |
幸运的是,Kotlin 提供了一个kotlin-spring
插件(预配置的kotlin-allopen
plugin)自动打开类
以及它们的成员函数,用于使用以下内容之一进行注释或元注释的类型
附注:
-
@Component
-
@Async
-
@Transactional
-
@Cacheable
元注释支持意味着使用@Configuration
,@Controller
,@RestController
,@Service
或@Repository
会自动打开,因为这些
注释是用@Component
.
start.spring.io 启用
这kotlin-spring
插件。因此,在实践中,您可以编写 Kotlin Bean
无需任何额外open
关键字,就像在 Java 中一样。
Spring Framework 文档中的 Kotlin 代码示例没有明确指定open 在类及其成员函数上。这些示例是为项目编写的
使用kotlin-allopen 插件,因为这是最常用的设置。 |
1.9.2. 使用不可变类实例进行持久化
在 Kotlin 中,声明只读属性很方便,并且被认为是最佳实践 在主构造函数中,如以下示例所示:
class Person(val name: String, val age: Int)
您可以选择添加这data
关键词使编译器自动从声明的所有属性派生以下成员
在主构造函数中:
-
equals()
和hashCode()
-
toString()
形式的"User(name=John, age=42)"
-
componentN()
与属性按声明顺序对应的函数 -
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)需要默认构造函数,从而阻止
一种设计。幸运的是,对于这个“默认构造函数地狱”,有一个解决方法,
由于 Kotlin 提供了kotlin-jpa
为使用 JPA 注释的类生成合成无参数构造函数的插件。
如果您需要将这种机制用于其他持久性技术,您可以配置
这kotlin-noarg
插件。
从 Kay 发布系列开始,Spring Data 支持 Kotlin 不可变类实例和
不需要kotlin-noarg 插件,如果模块使用 Spring Data 对象映射
(如MongoDB、Redis、Cassandra等)。 |
1.9.3. 注入依赖项
我们的建议是尝试使用val
只读(和
不可为空)属性,
如以下示例所示:
@Component
class YourBean(
private val mongoTemplate: MongoTemplate,
private val solrClient: SolrClient
)
具有单个构造函数的类会自动自动连接其参数。
这就是为什么不需要显式的@Autowired constructor 在所示示例中
以上。 |
如果确实需要使用字段注入,可以使用lateinit var
构建
如以下示例所示:
@Component
class YourBean {
@Autowired
lateinit var mongoTemplate: MongoTemplate
@Autowired
lateinit var solrClient: SolrClient
}
1.9.4. 注入配置属性
在 Java 中,您可以使用注释(例如@Value("${property}")
).
但是,在 Kotlin 中,是用于字符串插值的保留字符。$
因此,如果您希望使用@Value
comments 时,您需要通过编写$
@Value("\${property}")
.
如果你使用 Spring Boot,你可能应该使用@ConfigurationProperties 而不是@Value 附注。 |
或者,您可以通过声明 以下配置 Bean:
@Bean
fun propertyConfigurer() = PropertySourcesPlaceholderConfigurer().apply {
setPlaceholderPrefix("%{")
}
您可以自定义现有代码(例如 Spring Boot 执行器或@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
attribute name,与其他属性不同,并将其指定为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])
(方括号需要
使用命名数组属性指定)。
此特定method
属性(最常见的一个)是
使用快捷方式注释,例如@GetMapping
,@PostMapping
,等。
如果@RequestMapping method 属性,则所有 HTTP 方法都将匹配,而不仅仅是GET 方法。 |
1.9.7. 测试
如果您使用的是 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。
您还可以将默认行为更改为PER_CLASS
感谢junit-platform.properties
文件,并带有junit.jupiter.testinstance.lifecycle.default = 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)
}
}
}
1.10. 入门
学习如何使用 Kotlin 构建 Spring 应用程序的最简单方法是按照专门的教程进行作。
1.10.1.start.spring.io
在 Kotlin 中启动新的 Spring Framework 项目的最简单方法是在 start.spring.io 上创建一个新的 SpringBoot 2 项目。
1.10.2. 选择 Web 风格
Spring Framework 现在带有两种不同的 Web 堆栈:Spring MVC 和 Spring WebFlux。
如果您想创建处理延迟的应用程序,建议使用 Spring WebFlux, 长期连接、流式处理方案或如果要使用 Web 功能 Kotlin DSL 的 DSL。
对于其他用例,特别是如果您使用 JPA、Spring 等阻塞技术 MVC 及其基于注释的编程模型是推荐的选择。
1.11. 资源
我们建议学习如何使用 Kotlin 和 Spring 框架:
-
Kotlin Slack(带有专用的 #spring 频道)
1.11.1. 示例
以下 Github 项目提供了您可以学习甚至扩展的示例:
-
spring-boot-kotlin-demo:常规 Spring Boot 和 Spring Data JPA 项目
-
mixit:Spring Boot 2、WebFlux 和响应式 Spring Data MongoDB
-
spring-kotlin-functional:独立 WebFlux 和函数式 bean 定义 DSL
-
spring-kotlin-fullstack:WebFlux Kotlin 全栈示例,前端使用 Kotlin2js 而不是 JavaScript 或 TypeScript
-
spring-petclinic-kotlin:Spring PetClinic 示例应用程序的 Kotlin 版本
-
spring-kotlin-deepdive:Boot 1.0 和 Java 到 Boot 2.0 和 Kotlin 的分步迁移指南
-
spring-cloud-gcp-kotlin-app-sample:Spring Boot 与 Google Cloud Platform 集成
2. 阿帕奇 Groovy
Groovy 是一种功能强大的、可选类型的动态语言,具有静态类型和静态 编译能力。它提供了简洁的语法并可与任何 现有的 Java 应用程序。
Spring Framework 提供了一个专用的ApplicationContext
支持基于 Groovy 的
Bean 定义 DSL。有关更多详细信息,请参阅 Groovy Bean 定义 DSL。
对 Groovy 的进一步支持,包括用 Groovy 编写的 bean、可刷新的脚本 bean、 动态语言支持中提供了更多内容。
3. 动态语言支持
Spring 为使用已 通过在 Spring 中使用动态语言(例如 Groovy)来定义。这种支持可以 你用受支持的动态语言编写任意数量的类,并拥有 Spring 容器透明地实例化、配置和依赖注入生成的 对象。
Spring 的脚本支持主要针对 Groovy 和 BeanShell。除此之外 特别支持的语言,支持 JSR-223 脚本机制 用于与任何支持 JSR-223 的语言提供程序集成(从 Spring 4.2 开始), 例如 JRuby。
您可以找到这种动态语言支持的完全有效的示例 在场景中立即有用。
3.1. 第一个例子
本章的大部分内容涉及描述 细节。 在深入了解动态语言支持的所有细节之前,我们看一个用动态语言定义的 bean 的快速示例。第一个 bean 的动态语言是 Groovy。(这个例子的基础取自Spring 测试套件。如果你想看到任何其他支持的语言中的等效示例,请查看源代码)。
下一个示例显示了Messenger
接口,Groovy bean 将要 实现。 请注意,此接口是用纯 Java 定义的。依赖对象被注入了对Messenger
不知道底层实现是一个 Groovy 脚本。以下列表显示了Messenger
接口:
package org.springframework.scripting;
public interface Messenger {
String getMessage();
}
以下示例定义了一个依赖于Messenger
接口:
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...
}
}
以下示例实现了Messenger
Groovy 中的界面:
// 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 有关基于架构的配置的详细信息,请参阅基于 XML 架构的配置。 |
最后,以下示例显示了影响注入Groovy 定义的 bean 定义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 (aDefaultBookingService
) 现在可以使用其私有的messenger
member 变量,因为Messenger
注入其中的实例是 一个Messenger
实例。 这里没有什么特别的事情——只有普通的 Java 和普通的 Groovy。
希望前面的 XML 片段是不言自明的,但如果不是,请不要过度担心。继续阅读有关上述配置的原因和原因的深入详细信息。
3.2. 定义由动态语言支持的 Bean
本节准确描述了如何在任何支持的动态语言中定义 Spring 托管的 bean。
请注意,本章不试图解释支持的 动态语言。例如,如果您想使用 Groovy 编写某些类 在您的应用程序中,我们假设您已经了解 Groovy。如果您需要更多详细信息 关于动态语言本身,请参阅末尾的更多资源 本章。
3.2.1. 常用概念
使用动态语言支持的 Bean 所涉及的步骤如下:
-
编写动态语言源代码的测试(自然)。
-
然后编写动态语言源代码本身。
-
使用适当的
<lang:language/>
XML 配置中的元素(您可以通过以下方式以编程方式定义此类 bean: 使用 Spring API,尽管您必须查阅源代码 有关如何执行此作的说明,因为本章不涉及此类高级配置)。 请注意,这是一个迭代步骤。每个动态至少需要一个 Bean 定义 语言源文件(尽管多个 bean 定义可以引用同一个源文件)。
前两个步骤(测试和编写动态语言源文件)超出了 本章的范围。请参阅语言规范和参考手册 选择的动态语言,并继续开发您的动态语言 源文件。不过,您首先要阅读本章的其余部分,因为 Spring 的动态语言支持确实对内容做出了一些(小的)假设 的动态语言源文件。
<lang:language/> 元素
上一节中列表中的最后一步涉及定义动态语言支持的 Bean 定义,对于您
想要配置(这与正常的 JavaBean 配置没有什么不同)。然而
而不是指定要成为的类的完全限定类名
实例化并由容器配置,您可以使用<lang:language/>
元素来定义动态语言支持的 bean。
每种受支持的语言都有相应的<lang:language/>
元素:
-
<lang:groovy/>
(时髦) -
<lang:bsh/>
(豆壳) -
<lang:std/>
(JSR-223,例如使用 JRuby)
可用于配置的确切属性和子元素取决于 Bean 的确切定义语言(特定于语言的部分 本章后面将详细介绍这一点)。
可刷新豆
动态语言最引人注目的附加值之一(也许是唯一的) Spring 中的支持是“可刷新 bean”功能。
可刷新 Bean 是动态语言支持的 Bean。用少量的 配置,动态语言支持的 Bean 可以监控其底层的更改 源文件资源,然后在动态语言源文件 已更改(例如,当您编辑和保存对文件系统上文件的更改时)。
这允许您将任意数量的动态语言源文件部署为 应用程序,配置 Spring 容器以创建由动态支持的 Bean 语言源文件(使用本章中描述的机制)和(稍后, 随着需求的变化或其他一些外部因素发挥作用)编辑动态 语言源文件,并将它们所做的任何更改反映在 Bean 中。 由更改的动态语言源文件支持。无需关闭 正在运行的应用程序(或在 Web 应用程序的情况下重新部署)。这 dynamic-language-backed bean so amended 从 更改了动态语言源文件。
默认情况下,此功能处于关闭状态。 |
现在我们可以看一个例子,看看开始使用 refreshable 是多么容易
豆。要打开可刷新 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>
这确实是你所要做的。这refresh-check-delay
属性定义在messenger
bean 定义是 bean 之后的毫秒数
刷新对底层动态语言源文件所做的任何更改。
您可以通过为refresh-check-delay
属性。请记住,默认情况下,刷新行为为
禁用。如果不希望刷新行为,请不要定义属性。
如果我们随后运行以下应用程序,我们可以行使可刷新功能。
(请原谅“跳过障碍暂停执行”的恶作剧
在下一段代码中。这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());
}
}
然后,出于本示例的目的,假设所有对getMessage()
方法Messenger
必须更改实现,以便消息是
用引号括起来。以下列表显示了您所做的更改
(开发商)应向Messenger.groovy
当
程序的执行暂停:
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
}
}
当程序运行时,输入暂停前的输出将是I Can Do The Frug
.
对源文件进行更改并保存并恢复程序执行后,
调用getMessage()
动态语言支持的方法Messenger
实现是'I Can Do The Frug'
(请注意,包含
附加引号)。
如果对脚本的更改发生在
这refresh-check-delay
价值。对脚本的更改直到
在动态语言支持的 Bean 上调用一个方法。只有当一个方法被
调用动态语言支持的 Bean 时,它会检查其底层脚本是否
来源已更改。与刷新脚本相关的任何异常(例如
遇到编译错误或发现脚本文件已被删除)
导致将致命异常传播到调用代码。
前面描述的可刷新 Bean 行为不适用于动态语言
源文件定义了<lang:inline-script/>
元素表示法(参见内联动态语言源文件)。此外,它仅适用于以下 bean
实际上可以检测到对基础源文件的更改(例如,通过代码
检查动态语言源文件的上次修改日期,该文件存在于
文件系统)。
内联动态语言源文件
动态语言支持还可以满足动态语言源文件的需求
直接嵌入到 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>
如果我们把围绕定义是否是良好做法的问题放在一边
动态语言源代码,则<lang:inline-script/>
元素在某些情况下可能很有用。例如,我们可能想要快速添加一个
SpringValidator
实现到 Spring MVCController
.这只是片刻的
使用内联源代码工作。(参见脚本验证器
示例。
在动态语言支持的 Bean 上下文中理解构造函数注入
关于 Spring 的动态,有一件非常重要的事情需要注意 语言支持。也就是说,您不能(当前)提供构造函数参数 到动态语言支持的 bean(因此,构造函数注入不适用于 dynamic-language-backed bean)。为了对 构造函数和属性 100% 清晰,以下代码和配置的混合 不起作用:
// 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注入是绝大多数开发人员青睐的注入风格(关于这是否是一件好事的讨论留到另一天)。
3.2.2. Groovy 豆
本节介绍如何使用 Spring 的 Groovy 中定义的 bean。
Groovy 主页包含以下描述:
“Groovy 是一种用于 Java 2 平台的敏捷动态语言,它具有许多人们非常喜欢 Python、Ruby 和 Smalltalk 等语言的功能,使它们可供使用类似 Java 语法的 Java 开发人员使用。
如果您从头开始阅读了本章,那么您已经看到了一个 Groovy-dynamic-language-backed 的示例 豆。 现在考虑另一个示例(再次使用 Spring 测试套件中的示例):
package org.springframework.scripting;
public interface Calculator {
int add(int x, int y);
}
以下示例实现了Calculator
Groovy 中的界面:
// from the file 'calculator.groovy'
package org.springframework.scripting.groovy
class GroovyCalculator implements Calculator {
int add(int x, int y) {
x + y
}
}
以下 bean 定义使用 Groovy 中定义的计算器:
<!-- from the file 'beans.xml' -->
<beans>
<lang:groovy id="calculator" script-source="classpath:calculator.groovy"/>
</beans>
最后,以下小型应用程序执行上述配置:
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));
}
}
运行上述程序的结果输出是(毫不奇怪)10
. (有关更有趣的示例,请参阅动态语言展示项目以获取更多复杂示例,或参见本章后面的示例场景)。
您不得为每个 Groovy 源文件定义多个类。虽然这完全是在 Groovy 中是合法的,但这(可以说)是一种糟糕的做法。为了保持一致方法,您应该(在 Spring 团队看来)尊重标准 Java每个源文件一个(公共)类的约定。
使用回调自定义 Groovy 对象
这GroovyObjectCustomizer
interface 是一个回调,可让您将额外的creation 逻辑挂钩到创建 Groovy 支持的 bean 的过程中。 例如 此接口的实现可以调用任何所需的初始化方法,设置一些默认属性值,或指定自定义MetaClass
. 以下列表显示了GroovyObjectCustomizer
接口定义:
public interface GroovyObjectCustomizer {
void customize(GroovyObject goo);
}
Spring Framework 实例化 Groovy 支持的 bean 的实例,然后将创建的GroovyObject
到指定的GroovyObjectCustomizer
(如果有一个
已被定义)。您可以使用提供的GroovyObject
参考。我们预计大多数人都希望设置自定义MetaClass
有了这个
callback,以下示例显示了如何执行此作:
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 参考手册的相关部分或执行
在线搜索。很多文章都涉及这个话题。实际上,利用GroovyObjectCustomizer
如果您使用 Spring 命名空间支持,则很容易,因为以下示例显示:
<!-- 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"/>
您还可以指定一个 GroovyCompilationCustomizer (例如ImportCustomizer ) 甚至是完整的 GroovyCompilerConfiguration 对象与 Spring 的GroovyObjectCustomizer . 此外,您可以设置一个共同的GroovyClassLoader 使用自定义配置ConfigurableApplicationContext.setClassLoader 水平; 这也导致共享GroovyClassLoader 用法,因此建议在下列情况下使用大量脚本化 bean(避免孤立的GroovyClassLoader 实例)。 |
3.2.3. BeanShell 豆
本节介绍如何在 Spring 中使用 BeanShell bean。
BeanShell 主页包括以下内容 描述:
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 动态代理,该代理实现了script-interfaces
属性值<lang:bsh>
元素(这就是为什么您必须在属性的值中至少提供一个接口,因此,当您使用 BeanShell 支持的beans 时,编程到接口)。这意味着对 BeanShell 支持的对象的每个方法调用都会通过JDK 动态代理调用机制。
现在我们可以展示一个完全有效的示例,使用基于 BeanShell 的 bean 实现 这Messenger
本章前面定义的接口。我们再次展示
定义Messenger
接口:
package org.springframework.scripting;
public interface Messenger {
String getMessage();
}
以下示例显示了 BeanShell 的“实现”(我们在这里松散地使用该术语)
的Messenger
接口:
String message;
String getMessage() {
return message;
}
void setMessage(String aMessage) {
message = aMessage;
}
以下示例显示了定义上述“实例”的 Spring XML “类”(同样,我们在这里非常宽松地使用这些术语):
<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。
3.3. 场景
在脚本语言中定义 Spring 托管 Bean 的可能场景 有益是多种多样的。本节介绍 Spring 中的动态语言支持。
3.3.1. 脚本化的 Spring MVC 控制器
一组可以从使用动态语言支持的 bean 中受益的类是的 Spring MVC 控制器。在纯 Spring MVC 应用程序中,导航流通过 Web 应用程序在很大程度上是由封装在您的 Spring MVC 控制器中的代码决定的。由于导航流和其他表示层逻辑需要更新 Web 应用程序以响应支持问题或更改业务需求,通过以下方式实现任何此类所需更改可能会更容易编辑一个或多个动态语言源文件并看到这些更改立即反映在正在运行的应用程序的状态中。
请记住,在诸如 Spring,您通常的目标是拥有一个非常薄的表示层,所有 包含在域和服务中的应用程序的丰富业务逻辑 图层类。将 Spring MVC 控制器开发为动态语言支持的 bean 可以 您可以通过编辑和保存文本文件来更改表示层逻辑。任何 对此类动态语言源文件的更改是(取决于配置) 自动反映在由动态语言源文件支持的 Bean 中。
要自动“拾取”对动态语言支持的任何更改 bean,您必须启用“可刷新 bean”功能。有关此功能的完整处理,请参阅可刷新豆。 |
以下示例显示了org.springframework.web.servlet.mvc.Controller
实现
通过使用 Groovy 动态语言:
// 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。
同样,将验证器开发为动态语言支持的 bean 可以让您更改 通过编辑和保存简单的文本文件来验证逻辑。任何此类更改都是 (取决于配置)自动反映在执行 正在运行的应用程序,并且不需要重新启动应用程序。
自动“拾取”对动态语言支持的任何更改 bean,您必须启用“可刷新 bean”功能。有关此功能的完整详细处理,请参阅可刷新 Bean。 |
以下示例显示了 Springorg.springframework.validation.Validator
使用 Groovy 动态语言实现(有关 Spring 的 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 — 为脚本化 Bean 提供建议
您可以使用 Spring AOP 框架来建议脚本化 bean。春季AOP 框架实际上并不知道被建议的 bean 可能是脚本化的 bean,因此您使用(或打算使用)的所有 AOP 用例和功能 使用脚本化 Bean。建议脚本化 Bean 时,不能使用基于类的 代理。您必须使用基于接口的代理。
您不仅限于为脚本 Bean 提供建议。您也可以自己编写方面 使用受支持的动态语言,并使用此类 bean 向其他 Spring Bean 提供建议。 不过,这确实是动态语言支持的高级使用。
3.4.2. 范围
如果不是立即显现出来,脚本化 bean 的范围可以与
任何其他豆子。这scope
属性<lang:language/>
元素让
您可以控制底层脚本 Bean 的范围,就像它对常规
豆。(默认作用域为单例,
就像“普通”豆子一样。
以下示例使用scope
属性来定义作用域为
原型:
<?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>
3.4.3.lang
XML 架构
这lang
元素处理公开已
用动态语言(例如 Groovy 或 BeanShell)编写为 Spring 容器中的 bean。
动态语言支持中全面介绍了这些元素(以及动态语言支持)。请参阅该部分
有关此支持的完整详细信息,以及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>