|
此版本仍在开发中，尚未视为稳定版。如需最新稳定版本，请使用 Spring Boot 4.0.4！ |
使用注解处理器生成您自己的元数据
通过使用 spring-boot-configuration-processor jar，您可以轻松地从使用 @ConfigurationProperties 注解的项生成自己的配置元数据文件。
该 jar 包含一个 Java 注解处理器，它会在您的项目编译时被调用。
配置注解处理器
当使用Maven构建时，请配置编译插件（版本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 中，你可以显式地配置 |
|
如果你在项目中使用 Lombok，则需要确保其注解处理器在 |
自动元数据生成
该处理器会选取同时使用 @ConfigurationProperties 注解的类和方法。
不支持使用 @ConfigurationProperties 进行元注解的自定义注解。 |
如果类只有一个带参数的构造函数，则每个构造函数参数都会创建一个属性，除非该构造函数使用了 @Autowired 注解。
如果类有一个显式使用 @ConstructorBinding 注解的构造函数，则该构造函数的每个参数都会创建一个属性。
否则，将通过标准的 getter 和 setter 方法发现属性，并对集合和映射类型进行特殊处理（即使只存在 getter 方法也能检测到）。
注解处理器还支持使用 @Data、@Value、@Getter 和 @Setter 等 Lombok 注解。
考虑以下示例:
-
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 地址”。
仅当类型作为正在编译的源代码可用时，才能填充 description 属性。
当类型仅作为来自依赖项的已编译类可用时，将不会填充该属性。
对于此类情况，应提供 手动元数据。
您应该仅使用带有 @ConfigurationProperties 字段的纯文本 Javadoc，因为它们在添加到 JSON 之前不会被处理。 |
如果您在记录类中使用 @ConfigurationProperties，则应通过类级别的 Javadoc 标签 @param 提供记录组件的描述（记录类中没有显式的实例字段来放置常规的字段级别 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 的属性。
您可能还需要调整现有键的某些属性，或者完全忽略该键。
为了支持此类情况并让您提供自定义“提示”，注解处理器会自动将 META-INF/additional-spring-configuration-metadata.json 中的条目合并到主元数据文件中。
如果你引用了一个已被自动检测到的属性，则其描述、默认值和弃用信息（如果已指定）将被覆盖。 如果在当前模块中未识别出手动声明的属性，则会将其作为新属性添加。
additional-spring-configuration-metadata.json 文件的格式与常规的 spring-configuration-metadata.json 完全相同。
“ignored.properties”部分中包含的条目将从生成的 spring-configuration-metadata.json 文件的“properties”部分中移除。
附加的属性文件是可选的。 如果没有额外的属性，请不要添加该文件。