使用注解处理器生成你自己的元数据
你可以通过使用 spring-boot-configuration-processor jar，轻松地从带有 @ConfigurationProperties 注解的项生成你自己的配置元数据文件。该 jar 包含一个 Java 注解处理器，它会在你的项目编译时被调用。
配置注解处理器
使用 Maven 构建时，配置 compiler 插件（3.12.0 或更高版本），将 spring-boot-configuration-processor 添加到注解处理器路径中：
<project>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</project>
在 Gradle 中，依赖项应声明在 annotationProcessor 配置中，如下例所示：
dependencies {
annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
}
如果你正在使用一个 additional-spring-configuration-metadata.json 文件，应将 compileJava 任务配置为依赖于 processResources 任务，如下例所示：
tasks.named('compileJava') {
inputs.files(tasks.named('processResources'))
}
该依赖确保在编译期间注解处理器运行时，额外的元数据是可用的。
如果你在项目中使用 AspectJ，需要确保注解处理器只运行一次。有几种方式可以实现这一点。在 Maven 中，你可以显式配置 maven-apt-plugin，并仅在该插件中添加注解处理器的依赖。你也可以让 AspectJ 插件执行所有的处理，并在 maven-compiler-plugin 的配置中禁用注解处理，如下所示：
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<proc>none</proc>
</configuration>
</plugin>
如果你在项目中使用 Lombok，需要确保其注解处理器在 spring-boot-configuration-processor 之前运行。在 Maven 中，可以通过 Maven 编译器插件的 annotationProcessors 属性按所需顺序列出注解处理器。在 Gradle 中，则需在 annotationProcessor 配置中按所需顺序声明依赖项。
自动元数据生成
该处理器会拾取使用 @ConfigurationProperties 注解的类和方法。
不支持使用 @ConfigurationProperties 进行元注解的自定义注解。
如果类具有一个带参数的构造函数，则每个构造函数参数都会创建一个属性，除非该构造函数使用了 @Autowired 注解。如果类中存在一个显式使用 @ConstructorBinding 注解的构造函数，则会为该构造函数的每个参数创建一个属性。否则，属性将通过标准的 getter 和 setter 方法进行发现，并对集合（collection）和映射（map）类型进行特殊处理（即使仅存在 getter 方法也能被检测到）。注解处理器还支持使用 Lombok 的 @Data、@Value、@Getter 和 @Setter 注解。
考虑以下示例：
- Java
- Kotlin
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("my.server")
public class MyServerProperties {
/**
* Name of the server.
*/
private String name;
/**
* IP address to listen to.
*/
private String ip = "127.0.0.1";
/**
* Port to listener to.
*/
private int port = 9797;
// getters/setters ...
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
public String getIp() {
return this.ip;
}
public void setIp(String ip) {
this.ip = ip;
}
public int getPort() {
return this.port;
}
public void setPort(int port) {
this.port = port;
}
}
import org.springframework.boot.context.properties.ConfigurationProperties
@ConfigurationProperties("my.server")
class MyServerProperties(
/**
* Name of the server.
*/
var name: String,
/**
* IP address to listen to.
*/
var ip: String = "127.0.0.1",
/**
* Port to listen to.
*/
var port: Int = 9797)
这暴露了三个属性，其中 my.server.name 没有默认值，而 my.server.ip 和 my.server.port 的默认值分别为 "127.0.0.1" 和 9797。字段上的 Javadoc 用于填充 description 属性。例如，my.server.ip 的描述为 "IP address to listen to."。只有当类型以源代码形式存在并正在编译时，才能填充 description 属性。如果类型仅以依赖项中的已编译类形式存在，则无法填充该属性。对于这种情况，应提供 手动元数据。
你应该仅在 @ConfigurationProperties 字段的 Javadoc 中使用纯文本，因为它们在被添加到 JSON 之前不会经过处理。
如果你在 record 类上使用 @ConfigurationProperties，那么 record 组件的描述应通过类级别的 Javadoc 标签 @param 提供（record 类中没有显式的实例字段，无法在其上添加常规的字段级 Javadoc）。
注解处理器应用了多种启发式方法从源码模型中提取默认值。只有当类型作为正在编译的源代码可用时，才能提取默认值。如果该类型仅作为依赖项中的已编译类可用，则无法提取默认值。此外，默认值必须以静态方式提供。特别地，不要引用另一个类中定义的常量。同时，注解处理器无法自动检测 Collections 的默认值。
对于无法检测到默认值的情况，应提供手动元数据。请考虑以下示例：
- Java
- Kotlin
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("my.messaging")
public class MyMessagingProperties {
private List<String> addresses = new ArrayList<>(Arrays.asList("a", "b"));
private ContainerType containerType = ContainerType.SIMPLE;
// getters/setters ...
public List<String> getAddresses() {
return this.addresses;
}
public void setAddresses(List<String> addresses) {
this.addresses = addresses;
}
public ContainerType getContainerType() {
return this.containerType;
}
public void setContainerType(ContainerType containerType) {
this.containerType = containerType;
}
public enum ContainerType {
SIMPLE, DIRECT
}
}
import org.springframework.boot.context.properties.ConfigurationProperties
import java.util.Arrays
@ConfigurationProperties("my.messaging")
class MyMessagingProperties(
val addresses: List<String> = ArrayList(Arrays.asList("a", "b")),
var containerType: ContainerType = ContainerType.SIMPLE) {
enum class ContainerType {
SIMPLE, DIRECT
}
}
为了记录上述类中属性的默认值，您可以将以下内容添加到该模块的手动元数据中：
{"properties": [
{
"name": "my.messaging.addresses",
"defaultValue": ["a", "b"]
},
{
"name": "my.messaging.container-type",
"defaultValue": "simple"
}
]}
要为现有属性记录额外的元数据，仅需提供该属性的 name。
嵌套属性
注解处理器会自动将内部类视为嵌套属性。与其在命名空间的根级别记录 ip 和 port，我们可以为其创建一个子命名空间。请看下面更新后的示例：
- Java
- Kotlin
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("my.server")
public class MyServerProperties {
private String name;
private Host host;
// getters/setters ...
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
public Host getHost() {
return this.host;
}
public void setHost(Host host) {
this.host = host;
}
public static class Host {
private String ip;
private int port;
// getters/setters ...
public String getIp() {
return this.ip;
}
public void setIp(String ip) {
this.ip = ip;
}
public int getPort() {
return this.port;
}
public void setPort(int port) {
this.port = port;
}
}
}
import org.springframework.boot.context.properties.ConfigurationProperties
@ConfigurationProperties("my.server")
class MyServerProperties(
var name: String,
var host: Host) {
class Host(val ip: String, val port: Int = 0)
}
前面的示例为 my.server.name、my.server.host.ip 和 my.server.host.port 属性生成了元数据信息。你可以在字段或 getter 方法上使用 @NestedConfigurationProperty 注解，以表明一个普通的（非内部）类应被视为嵌套类。
这对集合（collections）和映射（maps）没有影响，因为这些类型会被自动识别，并且会为它们各自生成一个元数据属性。
添加额外的元数据
Spring Boot 的配置文件处理相当灵活，通常会存在一些属性并未绑定到 @ConfigurationProperties bean 上。你可能还需要调整某个已有键的某些属性，或者完全忽略该键。为了支持这些情况并允许你提供自定义的“提示”（hints），注解处理器会自动将 META-INF/additional-spring-configuration-metadata.json 中的条目合并到主元数据文件中。
如果你引用了一个已被自动检测到的属性，则其描述、默认值和弃用信息（如果已指定）将被覆盖。如果在当前模块中未找到该手动声明的属性，则会将其作为新属性添加。
additional-spring-configuration-metadata.json 文件的格式与常规的 spring-configuration-metadata.json 完全相同。“ignored.properties” 部分中包含的项将从生成的 spring-configuration-metadata.json 文件的 “properties” 部分中移除。
附加属性文件是可选的。如果你没有任何附加属性，请不要添加该文件。