Kotlin 中的 Spring 项目

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

默认情况下为 final

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

虽然 Kotlin 的 JVM 友好设计通常与 Spring 无缝衔接，但这个特定的 Kotlin 特性可能会阻止应用程序启动，如果这个事实没有被考虑在内。这是因为 Spring bean（例如 @Configuration 注释的类，默认情况下需要在运行时出于技术原因进行扩展）通常由 CGLIB 代理。解决方法是在每个类和 Spring bean 的成员函数上添加一个 open 关键字，这些 Spring bean 由 CGLIB 代理，这很快就会变得很痛苦，并且违背了 Kotlin 保持代码简洁和可预测的原则。

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

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

  • @Component

  • @Async

  • @Transactional

  • @Cacheable

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

一些涉及代理和 Kotlin 编译器自动生成最终方法的用例需要格外注意。例如，具有属性的 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
}

内部函数名称混淆

使用 internal 可见性修饰符 的 Kotlin 函数在编译为 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 类时，例如在从 Kotlin 类型到 Java 类型编写 org.springframework.core.convert.converter.Converter 时，需要使用泛型上的 out Kotlin 关键字来考虑这一点。

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

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

构造函数注入

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

您也可以在 junit-platform.properties 文件中将默认行为更改为 ALL，方法是使用 spring.test.constructor.autowire.mode = 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 文件中将默认行为更改为 PER_CLASS，方法是使用 junit.jupiter.testinstance.lifecycle.default = per_class 属性。

以下示例演示了非静态方法上的 @BeforeAll 和 @AfterAll 注解

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

  val application = Application(8181)
  val client = WebClient.create("https://127.0.0.1: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)
     }
  }
}