Spring Boot Configuration Metadata

Spring Boot Configuration Metadata

简介

除了使用 @Value 注解之外还可以引入此包来实现配置项的引入功能。

注:这样使用还可以避免 IDEA 读取配置项报警的问题。

使用方式

首先需要引入依赖包

1
2
3
4
5
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
1
2
3
dependencies {
annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
}

然后需要编写配置项文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;

@Setter
@Getter
@ConfigurationProperties(prefix = "xxx.xxx")
public class XxxProperties {

private Integer xxx = 10;

private Integer yyy = 10;

}

最后要在启动类中标识配置项文件

1
2
3
4
5
6
7
8
9
10
11
12
13
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties({XxxProperties.class})
public class XxxApplication {

public static void main(String[] args) {
SpringApplication.run(Xxx.class, args);
}

}

配置 IDEA

进入如下配置项

Settings -> Build,Execution,Deployment -> Compiler -> Annotation Processors

打开如下配置即可

Enable annotation processing

参考资料

Properties with Spring and Spring Boot

SpringBoot 中的 ConfigurationProperties

官方网站


Spring Boot Configuration Metadata
https://wangqian0306.github.io/2022/conf/
作者
WangQian
发布于
2022年7月22日
许可协议