无法使用 gradle 生成 Spring Boot 配置元数据

Posted 2023-02-27

【中文标题】无法使用 gradle 生成 Spring Boot 配置元数据

【英文标题】：Cannot generate Spring Boot configuration metadata with gradle

【发布时间】：2021-05-30 15:22:55

【问题描述】：

我想生成 Spring Boot 配置元数据，用这种方式：

configuration-metadata-annotation-processor-setup

在 Maven 中，没关系：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

但在 gradle 中，没有生成：

dependencies 
    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"

spring-boot-configuration-processor 也有同样的问题，maven 可以，但是 gradle 不行。

我使用的插件是java或org.jetbrains.kotlin.jvm，不是org.springframework.boot，但我不认为这是问题所在（使用插件org.springframework.boot，问题仍然存在）。

【问题讨论】：

你是否也在你的 gradle 文件中做了compileJava.inputs.files(processResources)？

@DonHosek 是的，compileJava.dependsOn(processResources)

@DonHosek 即使我运行 tast processResources，在 META-INF 中也没有生成

【参考方案1】：

除了您提到的步骤之外，您还需要添加一个类映射。如下所示。

import lombok.Data;    
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.props")
@Data
public class MyProperties 

  /**
   * Prop1 description.
   */
   private String prop1;

   /**
   * Prop2 description.
   */
   private String prop2;

添加一个没有props的类是可以的，但它是必需的。

资源的示例内容/META-INF/additional-spring-configuration-metadata.json

   "properties": [
      
         "name": "my.props.prop1",
         "type": "java.lang.String",
         "description": "Prop1 description",
         "defaultValue": "property 1"
      
    ]