Java 中配置文件怎么使用 @ConfigurationProperties 将一组配置批量绑定到实体类

舞夢輝影

舞夢輝影

2026-07-27

531人浏览

原创

@configurationproperties 是 spring boot 中将配置文件前缀属性批量绑定到实体类的推荐方式,需配合 @component 或 @enableconfigurationproperties 注册、无参构造器、getter/setter 及校验注解使用。

java 中配置文件怎么使用 @configurationproperties 将一组配置批量绑定到实体类

在 Java Spring Boot 项目中,@ConfigurationProperties 是将配置文件(如 application.ymlapplication.properties)中的一组前缀配置批量绑定到一个实体类的最常用方式。它比 @Value 更清晰、类型安全,也更利于维护。

配置类需满足基本条件

要让 @ConfigurationProperties 正常工作,实体类必须满足几个关键要求:

  • 类上标注 @ConfigurationProperties(prefix = "xxx"),指定配置前缀(如 app.user
  • 该类需被 Spring 容器管理:通常配合 @Component 或通过 @EnableConfigurationProperties 显式注册
  • 必须提供无参构造函数(Lombok 的 @Data@NoArgsConstructor 可自动满足)
  • 字段建议使用标准 getter/setter(Lombok 的 @Data@Setter + @Getter 即可)
  • 推荐搭配 @Validated 和校验注解(如 @NotBlank@Min)做配置合法性检查

YAML 配置与实体类对应示例

比如在 application.yml 中写:

app:
  user:
    name: zhangsan
    age: 28
    email: zhangsan@example.com
    roles:
      - admin
      - user
    timeout: 5000

对应实体类定义为:

@ConfigurationProperties(prefix = "app.user")
@Component
@Validated
public class UserConfig {
    @NotBlank
    private String name;
    @Min(1)
    private int age;
    @Email
    private String email;
    private List<string> roles;
    private long timeout;
<pre class="brush:php;toolbar:false;"><code>// getter/setter(Lombok 可省略)</code>

}

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载

Spring Boot 启动时会自动将 app.user.* 下的所有属性按名称和类型映射到该类字段。

启用松散绑定与元数据支持(可选但推荐)

Spring Boot 默认支持松散绑定(如 user-nameuserNameUSER_NAME 都能匹配 userName 字段),无需额外配置。

若希望 IDE(如 IntelliJ)在写 YAML 时有提示和校验,可添加 spring-boot-configuration-processor 依赖:

<dependency><groupid>org.springframework.boot</groupid><artifactid>spring-boot-configuration-processor</artifactid><optional>true</optional></dependency>

该处理器会在编译时生成 META-INF/spring-configuration-metadata.json,提供配置提示和跳转支持。

避免常见坑点

实际使用中容易出错的地方包括:

  • 忘记加 @Component 或没在主配置类上用 @EnableConfigurationProperties(UserConfig.class) —— 导致 Bean 未注册,注入失败
  • 字段类型不匹配(如配置写成 timeout: 5s,但字段是 long)—— Spring 会尝试转换,失败则抛 BindException
  • 嵌套对象未声明为 static 内部类或独立类,且没有无参构造器 —— 绑定会失败
  • 配置项缺失且字段非 Optional 或未设默认值 —— 默认绑定为 null 或 0,可能引发空指针或逻辑错误;可用 @DefaultValue("xxx") 或字段初始化处理

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

3863

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

2838

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

2875

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

637

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

602

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

706

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1316

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

18845

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

647

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习