IntelliJ Idea for Kotlin @ConfigurationProperties 类中未生成 spring-configuration-met

Spring

在使用 IntelliJ Idea for Kotlin 开发 Spring Boot 应用时，我们经常会使用 @ConfigurationProperties 注解来读取配置文件中的属性值。这个注解可以帮助我们将配置文件中的属性值映射到对应的类中，并且提供了代码提示和校验的功能，非常方便实用。

然而，有时候我们会发现在使用 @ConfigurationProperties 注解后，IntelliJ Idea 并没有生成相应的 Spring-configuration-Metadata.JSon 文件。这个文件是用来存储属性的元数据信息，供 IDE 在编写代码时提供更好的支持。

问题分析

为什么会出现这个问题呢？经过调查，我们发现生成 Spring-configuration-Metadata.JSon 文件的过程是由 Spring Boot 的插件自动完成的。而在使用 Kotlin 开发时，默认的插件可能不会正确地处理 Kotlin 类中的注解。

解决方案

为了解决这个问题，我们可以手动添加一个额外的插件来处理 Kotlin 类中的注解，并生成正确的 Spring-configuration-Metadata.JSon 文件。下面是具体的解决步骤。

1. 首先，在项目的 build.gradle 文件中添加一个额外的插件依赖：

groovy
buildscript {
    dependencies {
        classpath("org.Springframework.boot:Spring-boot-configuration-processor")
    }
}

2. 然后，在应用的配置类中，添加 @SpringBootApplication 注解的同时，也添加 @EnableConfigurationProperties 注解，并指定要生成元数据的类：

kotlin
@SpringBootApplication
@EnableConfigurationProperties(MyProperties::class)
class MyApplication
fun mAIn(args: Array<String>) {
    runApplication<MyApplication>(*args)
}

3. 接下来，在配置类对应的属性类上添加 @ConfigurationProperties 注解，并指定属性的前缀：

kotlin
@ConfigurationProperties(prefix = "myapp")
data class MyProperties(
    var name: String = "",
    var version: String = ""
)

4. 最后，在项目的 build.gradle 文件中，添加一个处理 Kotlin 注解的配置：

groovy
kapt {
    arguments {
        arg("Spring.boot.configuration.processor.includeNestedProperties", "true")
    }
}

测试案例

为了验证解决方案的有效性，我们可以创建一个简单的 Spring Boot 应用，并使用 @ConfigurationProperties 注解读取配置文件中的属性值。

首先，创建一个名为 application.yml 的配置文件，内容如下：

yaml
myapp:
  name: MyApp
  version: 1.0.0

然后，创建一个测试类来使用 @ConfigurationProperties 注解读取配置文件中的属性值：

kotlin
@RestController
class MyController(private val myProperties: MyProperties) {
    @GetMapping("/app")
    fun getAppInfo(): String {
        return "Name: ${myProperties.name}, Version: ${myProperties.version}"
    }
}

最后，启动应用并访问 http://localhost:8080/app，可以看到返回的结果为 "Name: MyApp, Version: 1.0.0"，说明配置文件中的属性值成功地被读取到了。

在使用 IntelliJ Idea for Kotlin 开发 Spring Boot 应用时，如果发现 @ConfigurationProperties 注解未生成 Spring-configuration-Metadata.JSon 文件的问题，可以按照上述步骤来手动添加一个额外的插件来解决。这样就可以享受到代码提示和校验的便利，提高开发效率。