Java 中 Spring Boot 怎么使用 @ConfigurationProperties 批量绑定配置

小磊酱_7447

小磊酱_7447

2026-10-01

674人浏览

原创

@configurationproperties 是 spring boot 中批量绑定配置的推荐方式,可将 yml/properties 中前缀相同的配置自动映射为 java bean,支持校验、类型安全和嵌套结构。

java 中 spring boot 怎么使用 @configurationproperties 批量绑定配置

在 Spring Boot 中,@ConfigurationProperties 是批量绑定配置最常用、最推荐的方式。它能把 application.yml 或 application.properties 中的一组前缀相同的配置,自动映射到一个 Java Bean 中,避免逐个用 @Value 注入,更安全、可校验、易维护。

1. 定义配置类并启用属性绑定

创建一个普通 Java 类(如 AppConfig),用 @ConfigurationProperties 指定配置前缀,并加上 @Component 或通过 @EnableConfigurationProperties 显式注册:

  • 推荐方式:加 @Component + @ConfigurationProperties("app")
  • 必须搭配 @EnableConfigurationProperties(如果没用 @Component)或启用配置类扫描
  • 类中字段名需与配置项小写短横线(kebab-case)风格一一对应,如 max-connections → 字段 maxConnections

示例:

<font size="2">@Component<br>@ConfigurationProperties(prefix = "app")<br>public class AppConfig {<br>    private String name;<br>    private int port;<br>    private List<string> servers = new ArrayList();<br>    private Map<string integer> timeout = new HashMap();<br>    // getter/setter 必须有(Lombok 的 @Data 也可)<br>}</string></string></font>

2. 在配置文件中写对应结构

支持 yml 和 properties,yml 更直观。注意缩进和类型表达:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • yml 中 list 用 -,map 用键值对,嵌套对象用缩进
  • properties 中 list 用 [0], [1] 索引;map 用 .key 后缀

yml 示例(application.yml):

<font size="2">app:<br>  name: demo-service<br>  port: 8080<br>  servers:<br>    - 192.168.1.10<br>    - 192.168.1.11<br>  timeout:<br>    db: 5000<br>    redis: 2000</font>

3. 启用 JSR-303 校验(可选但强烈建议)

在配置类上加 @Validated,字段上加 @NotBlank、@Min 等注解,Spring Boot 启动时会校验配置合法性:

  • 校验失败会直接抛出 BindException,应用启动失败,避免运行时出错
  • 嵌套对象也支持校验,只需在对应字段加 @Valid

示例:

<font size="2">@Component<br>@ConfigurationProperties(prefix = "app")<br>@Validated<br>public class AppConfig {<br>    @NotBlank<br>    private String name;<br>    @Min(1024)<br>    @Max(65535)<br>    private int port;<br>    // ...<br>}</font>

4. 注意事项和常见问题

实际使用中容易踩坑,需留意以下几点:

  • 必须有无参构造器(Lombok @Data 默认提供)
  • 字段必须有 setter 方法(@Data 或手动写)
  • 配置类不能是 final 类(否则 CGLIB 代理失败)
  • 不支持静态字段绑定
  • 若用 @ConfigurationProperties 在非 @Configuration 类上,需确保该类被 Spring 扫描到(如加 @Component)
  • IDE 可能提示“Configuration properties not bound”,需添加 spring-boot-configuration-processor 依赖以支持元数据提示(开发体验优化,非运行必需)

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9497

6

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

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

2023.07.05

6662

9

java自学难吗
java自学难吗

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

2023.07.31

5912

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2489

5

java在线网站
java在线网站

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

2023.08.03

19831

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习