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 中一样编写 Kotlin bean，而无需任何额外的 open 关键字。

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

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

在 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 不可变类实例，如果模块使用 Spring Data 对象映射（如 MongoDB、Redis、Cassandra 等），则不需要 kotlin-noarg 插件。

注入依赖项

优先使用构造函数注入

我们的建议是尝试优先使用带有 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
}

内部函数名称混淆

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

例如，这个 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 注解。

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

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

您可以通过声明多个 PropertySourcesPlaceholderConfigurer bean 来支持使用标准 ${…​} 语法的组件（例如 Spring Boot 执行器或 @LocalServerPort）以及使用自定义 %{…​} 语法的组件，示例如下：

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

@Bean
fun defaultPropertyConfigurer() = PropertySourcesPlaceholderConfigurer()

此外，可以通过 JVM 系统属性（或通过 SpringProperties 机制）设置 spring.placeholder.escapeCharacter.default 属性来全局更改或禁用默认转义字符。

受检异常

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 类型编写 org.springframework.core.convert.converter.Converter 到 Java 类型时。

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 以及用于模拟的 Mockk。

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

构造函数注入

如 专用部分 所述，JUnit Jupiter 允许构造函数注入 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，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("https://: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()
	}
}

类似规范的测试

您可以使用 Kotlin 和 JUnit Jupiter 的 @Nested 测试类支持创建类似规范的测试。以下示例显示了如何操作：

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)
		}
	}
}
© . This site is unofficial and not affiliated with VMware.