Kotlin 中的 Spring 项目

本节提供了一些在 Kotlin 中开发 Spring 项目的特定提示和建议。

默认为 Final

默认情况下，Kotlin 中的所有类和成员函数都是 final 的。类上的 open 修饰符与 Java 的 final 相反：它允许其他类继承此类。这也适用于成员函数，因为它们需要被标记为 open 才能被覆盖。

虽然 Kotlin 的 JVM 友好设计通常与 Spring 无缝集成，但如果不考虑这个特定的 Kotlin 特性，可能会阻止应用程序启动。这是因为 Spring Bean（例如默认需要在运行时扩展以满足技术原因的 @Configuration 注解类）通常由 CGLIB 代理。解决方法是在由 CGLIB 代理的 Spring Bean 的每个类和成员函数上添加 open 关键字，这会很快变得很麻烦，并且违反了 Kotlin 保持代码简洁和可预测性的原则。

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

幸运的是，Kotlin 提供了一个 kotlin-spring 插件（kotlin-allopen 插件的预配置版本），它会自动为使用以下注解之一进行注解或元注解的类型打开类及其成员函数

  • @Component

  • @Async

  • @Transactional

  • @Cacheable

元注解支持意味着用 @Configuration、@Controller、@RestController、@Service 或 @Repository 注解的类型会自动打开，因为这些注解是使用 @Component 进行元注解的。

一些涉及代理和 Kotlin 编译器自动生成 final 方法的使用场景需要特别注意。例如，一个带有属性的 Kotlin 类会生成相关的 final getter 和 setter。为了能够代理相关方法，应该优先使用类型级别的 @Component 注解而不是方法级别的 @Bean，以便 kotlin-spring 插件能够打开这些方法。一个典型的用例是 @Scope 及其流行的 @RequestScope 专用化。

start.spring.io 默认启用 kotlin-spring 插件。因此，实际上，你可以像在 Java 中一样，无需额外的 open 关键字即可编写你的 Kotlin Bean。

Spring Framework 文档中的 Kotlin 代码示例没有在类及其成员函数上显式指定 open。这些示例是为使用 kotlin-allopen 插件的项目编写的，因为这是最常用的设置。

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

在 Kotlin 中，一种方便且被认为是最佳实践的做法是在主构造函数中声明只读属性，如下例所示

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

你可以选择添加 data 关键字，让编译器自动从主构造函数中声明的所有属性派生出以下成员

  • equals() 和 hashCode()

  • 格式为 "User(name=John, age=42)" 的 toString()

  • 对应于属性声明顺序的 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 不可变类实例，并且如果模块使用 Spring Data 对象映射（例如 MongoDB、Redis、Cassandra 等），则不需要 kotlin-noarg 插件。

注入依赖

优先使用构造函数注入

我们建议尝试优先使用构造函数注入，并使用 val 只读（如果可能，且非 null）属性，如下例所示

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

Internal 函数名称混淆

Kotlin 函数带有 internal 可见性修饰符时，在编译为 JVM 字节码时会混淆它们的名称，这在按名称注入依赖时会产生副作用。

例如，这个 Kotlin 类

@Configuration
class SampleConfiguration {

	@Bean
	internal fun sampleBean() = SampleBean()
}

编译后的 JVM 字节码转换为如下 Java 表示

@Configuration
@Metadata(/* ... */)
public class SampleConfiguration {

	@Bean
	@NotNull
	public SampleBean sampleBean$demo_kotlin_internal_test() {
		return new SampleBean();
	}
}

因此，表示为 Kotlin 字符串的相关 bean 名称是 "sampleBean\$demo_kotlin_internal_test"，而不是常规 public 函数用例中的 "sampleBean"。按名称注入此类 bean 时，请确保使用混淆后的名称，或者添加 @JvmName("sampleBean") 以禁用名称混淆。

注入配置属性

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

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

如果你使用 Spring Boot，最好使用@ConfigurationProperties 而不是 @Value 注解。

作为替代方案，你可以通过声明以下配置 bean 来定制属性占位符前缀

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

你可以通过配置 bean 自定义使用 ${…​} 语法的现有代码（例如 Spring Boot actuator 或 @LocalServerPort），如下例所示

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

@Bean
fun defaultPropertyConfigurer() = PropertySourcesPlaceholderConfigurer()

受检异常

Java 和Kotlin 异常处理非常接近，主要区别在于 Kotlin 将所有异常都视为非受检异常。然而，在使用代理对象（例如用 @Transactional 注解的类或方法）时，抛出的受检异常默认会包装在 UndeclaredThrowableException 中。

要像在 Java 中那样获取抛出的原始异常，方法应该使用 @Throws 注解来显式指定抛出的受检异常（例如 @Throws(IOException::class)）。

注解数组属性

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])（对于命名数组属性，需要指定方括号）。

对于这个特定的 method 属性（最常用的属性），另一种替代方法是使用快捷注解，例如 @GetMapping、@PostMapping 等。

如果未指定 @RequestMapping 的 method 属性，则将匹配所有 HTTP 方法，而不仅仅是 GET 方法。

声明点协变

在 Kotlin 编写的 Spring 应用中处理泛型类型，在某些用例中可能需要理解 Kotlin 的声明点协变，它允许在声明类型时定义协变性，这在只支持使用点协变的 Java 中是不可能的。

例如，在 Kotlin 中声明 List<Foo> 在概念上等同于 java.util.List<? extends Foo>，因为 kotlin.collections.List 被声明为 interface List<out E> : kotlin.collections.Collection<E>。

在使用 Java 类时，需要在泛型类型上使用 out Kotlin 关键字来考虑这一点，例如，当编写一个将 Kotlin 类型转换为 Java 类型的 org.springframework.core.convert.converter.Converter 时。

class ListOfFooConverter : Converter<List<Foo>, CustomJavaList<out Foo>> {
	// ...
}

在转换任何类型的对象时，可以使用带有 * 的星投影代替 out Any。

class ListOfAnyConverter : Converter<List<*>, CustomJavaList<*>> {
	// ...
}
Spring Framework 尚未利用声明点协变类型信息进行 Bean 注入，请订阅 spring-framework#22313 以跟踪相关进展。

测试

本节介绍 Kotlin 和 Spring Framework 的组合测试。推荐的测试框架是 JUnit 5 以及用于 Mocking 的 Mockk。

如果你正在使用 Spring Boot，请参阅此相关文档。

构造函数注入

如专用部分所述，JUnit Jupiter (JUnit 5) 允许对 Bean 进行构造函数注入，这在 Kotlin 中非常有用，以便使用 val 而不是 lateinit var。你可以使用 @TestConstructor(autowireMode = AutowireMode.ALL) 来启用所有参数的自动装配。

你也可以在 junit-platform.properties 文件中通过设置 spring.test.constructor.autowire.mode = all 属性将默认行为更改为 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 Jupiter (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)
		}
	}
}