Spring Boot中的@ConfigurationProperties注解解读
更新时间：2024年10月23日 09:28:14 作者：需要重新演唱
在SpringBoot框架中,@ConfigurationProperties注解是处理外部配置的强大工具,它允许开发者将配置文件中的属性自动映射到Java类的字段上,实现配置的集中管理和类型安全,通过定义配置类并指定前缀,可以将配置文件中的属性绑定到Java对象
解析Spring Boot中的@ConfigurationProperties注解
在Spring Boot框架中，配置管理是一个核心功能。
Spring Boot提供了多种方式来处理外部配置，其中@ConfigurationProperties注解是一个非常强大且灵活的工具。
本文将深入探讨@ConfigurationProperties注解的概念、用法、工作原理、配置绑定、类型安全以及如何在实际开发中应用它。
什么是@ConfigurationProperties？
@ConfigurationProperties是Spring Boot提供的一个注解，用于将外部配置属性绑定到Java对象上。
通过使用这个注解，开发者可以将配置文件（如application.properties或application.yml）中的属性值自动映射到Java类的字段上，从而实现配置的集中管理和类型安全。
@ConfigurationProperties的作用
- 配置绑定：将配置文件中的属性值绑定到Java类的字段上，实现配置的自动映射。
- 类型安全：提供类型安全的配置绑定，避免类型转换错误。
- 复杂配置：支持复杂配置结构的绑定，如嵌套对象、集合、Map等。
- 配置校验：结合
@Valid注解，实现配置属性的校验。
@ConfigurationProperties的基本用法
1. 定义配置类
首先，定义一个Java类，用于绑定配置属性。
使用@ConfigurationProperties注解标记该类，并指定前缀（prefix）。
示例代码：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
private String name;
private String version;
private boolean enabled;
// getters and setters
}解释：
@ConfigurationProperties(prefix = "app")：指定配置属性的前缀为app。@Component：将该类注册为Spring Bean，使其可以被Spring容器管理。
2. 配置文件
在application.properties或application.yml文件中定义配置属性。
示例代码（application.properties）：
app.name=MyApp app.version=1.0.0 app.enabled=true
示例代码（application.yml）：
app: name: MyApp version: 1.0.0 enabled: true
解释：
- 配置属性以
app为前缀，与@ConfigurationProperties注解中的前缀一致。
3. 启用配置属性支持
在Spring Boot应用的主类或配置类上，使用@EnableConfigurationProperties注解启用配置属性支持。
示例代码：
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
@SpringBootApplication
@EnableConfigurationProperties(AppProperties.class)
public class MyAppApplication {
public static void main(String[] args) {
SpringApplication.run(MyAppApplication.class, args);
}
}解释：
@EnableConfigurationProperties(AppProperties.class)：启用AppProperties类的配置属性绑定支持。
@ConfigurationProperties的高级用法
1. 嵌套对象绑定
@ConfigurationProperties支持嵌套对象的绑定，可以实现复杂配置结构的映射。
示例代码：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
private String name;
private String version;
private boolean enabled;
private Server server;
// getters and setters
public static class Server {
private String host;
private int port;
// getters and setters
}
}配置文件（application.properties）：
app.name=MyApp app.version=1.0.0 app.enabled=true app.server.host=localhost app.server.port=8080
配置文件（application.yml）：
app:
name: MyApp
version: 1.0.0
enabled: true
server:
host: localhost
port: 8080解释：
- 嵌套对象
Server的属性可以通过app.server前缀进行绑定。
2. 集合和Map绑定
@ConfigurationProperties支持集合和Map类型的绑定，可以实现更灵活的配置结构。
示例代码：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
import java.util.Map;
@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
private String name;
private String version;
private boolean enabled;
private List<String> features;
private Map<String, String> settings;
// getters and setters
}配置文件（application.properties）：
app.name=MyApp app.version=1.0.0 app.enabled=true app.features[0]=feature1 app.features[1]=feature2 app.settings.key1=value1 app.settings.key2=value2
配置文件（application.yml）：
app:
name: MyApp
version: 1.0.0
enabled: true
features:
- feature1
- feature2
settings:
key1: value1
key2: value2解释：
- 集合
features和Mapsettings的属性可以通过app.features和app.settings前缀进行绑定。
3. 配置校验
结合@Valid注解，可以实现配置属性的校验，确保配置的有效性。
示例代码：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
@Component
@ConfigurationProperties(prefix = "app")
@Validated
public class AppProperties {
@NotEmpty
private String name;
@NotNull
private String version;
private boolean enabled;
// getters and setters
}解释：
@Validated：启用校验支持。@NotEmpty和@NotNull：对name和version字段进行非空校验。
@ConfigurationProperties的工作原理
@ConfigurationProperties注解的工作原理主要涉及以下几个步骤：
- 属性扫描：Spring Boot应用启动时，会扫描所有带有
@ConfigurationProperties注解的类。 - 属性绑定：根据注解中指定的前缀，将配置文件中的属性值绑定到类的字段上。
- 类型转换：Spring Boot内置了多种类型转换器，可以将配置属性值转换为相应的Java类型。
- 校验：结合
@Valid注解，对绑定的配置属性进行校验。
@ConfigurationProperties的最佳实践
- 合理划分配置类：根据功能模块合理划分配置类，避免单个配置类过于庞大。
- 使用嵌套对象：对于复杂配置结构，使用嵌套对象进行绑定，提高配置的可读性和可维护性。
- 配置校验：结合
@Valid注解，对配置属性进行校验，确保配置的有效性。 - 文档和注释：在配置类中添加文档和注释，说明配置属性的作用和取值范围，方便团队成员理解和维护。
结论
@ConfigurationProperties是Spring Boot中一个非常强大且灵活的工具，用于将外部配置属性绑定到Java对象上。
通过使用这个注解，开发者可以实现配置的集中管理和类型安全，提高开发效率和代码质量。
希望通过本文的讲解，你对Spring Boot中的@ConfigurationProperties注解有了更深入的理解，并能在实际开发中灵活应用。
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
本篇文章主要介绍了Spring 5.0集成log4j2日志管理的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-12-12
本篇文章主要介绍了Spring Boot 读取静态资源文件的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-09-09
这篇文章主要介绍了Java单例模式实现静态内部类方法示例，涉及构造函数私有化等相关内容，需要的朋友可以了解下。2017-09-09
这篇文章主要为大家介绍了sa-token 路由拦截式鉴权使用示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-07-07
本篇文章主要对Java中的设计模式如，创建型模式、结构型模式和行为型模式以及7大原则进行了归纳整理，需要的朋友可以参考下2017-04-04
Springboot项目使用Slf4j将日志保存到本地目录的实现代码
这篇文章主要介绍了Springboot项目使用Slf4j将日志保存到本地目录的实现方法，本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-05-05
这篇文章主要介绍了Java中具有映射关系的容器:数组和Map的区别说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-09-09
基于logback 实现springboot超级详细的日志配置
java web 下有好几种日志框架，比如：logback，log4j，log4j2（slj4f 并不是一种日志框架，它相当于定义了规范，实现了这个规范的日志框架就能够用 slj4f 调用）。这篇文章主要介绍了基于logback springboot超级详细的日志配置,需要的朋友可以参考下2019-06-06
java必学必会之this关键字，java中this的用法进行了详细的分析介绍，感兴趣的小伙伴们可以参考一下2015-12-12
这篇文章主要介绍了Java 如何解析key为动态的json操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-02-02
最新评论