Spring Boot 中怎么使用 `@ConfigurationProperties` 批量读取配置文件

轻墨姑娘_6254

轻墨姑娘_6254

2026-08-07

937人浏览

原创

@ConfigurationProperties 是 Spring Boot 中批量读取配置的推荐方式,通过注解绑定 yml/properties 到 Java Bean,支持嵌套、集合、校验及自动类型转换。

spring boot 中怎么使用 `@configurationproperties` 批量读取配置文件

在 Spring Boot 中,@ConfigurationProperties 是批量读取配置文件最常用、最推荐的方式。它能把 application.yml 或 application.properties 中的一组结构化配置,自动绑定到一个 Java Bean 上,避免零散使用 @Value,提升可维护性和类型安全性。

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

创建一个普通 Java 类(如 AppConfig),用 @ConfigurationProperties 注解指定配置前缀,并确保该类被 Spring 容器管理(加 @Component 或通过 @EnableConfigurationProperties 显式注册):

注意:Spring Boot 2.2+ 默认要求配置类必须有无参构造器,且字段需提供 setter 方法(或使用 Lombok 的 @Data/@Setter)。

  • 添加 @ConfigurationProperties(prefix = "app"),对应 yml 中以 app. 开头的配置项
  • 加上 @Component 让 Spring 自动扫描并注入(也可不加,改用 @EnableConfigurationProperties(AppConfig.class) 在启动类上启用)
  • 建议搭配 @Validated 支持校验(如 @NotBlank、@Min)

2. 编写配置内容(application.yml)

配置需与 Java 类字段名严格匹配(支持驼峰转连字符,如 maxConnections ↔ max-connections):

app:
  name: demo-service
  version: 1.2.0
  timeout: 5000
  features:
    enable-cache: true
    enable-log: false
  servers:
    - host: 192.168.1.10
      port: 8080
    - host: 192.168.1.11
      port: 8081

对应 Java 类中需定义嵌套对象(Features)、集合(List<server></server>)等结构,并确保有相应 getter/setter。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

3. 启用 JSR-303 校验(可选但推荐)

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

  • 例如:@NotBlank private String name;、@Min(1000) private long timeout;
  • 若配置缺失或不合法,应用启动失败,并提示具体错误位置
  • 需引入 spring-boot-starter-validation 依赖(新版 Spring Boot 已内置)

4. 使用配置类

像普通 Bean 一样通过 @Autowired 注入即可,所有属性已自动绑定并完成类型转换(含日期、Duration、集合、嵌套对象等):

@Service
public class AppService {
    @Autowired
    private AppConfig appConfig;
<pre class="brush:php;toolbar:false;">public void printInfo() {
    System.out.println(appConfig.getName());
    System.out.println(appConfig.getFeatures().isEnableCache());
    appConfig.getServers().forEach(s -> System.out.println(s.getHost()));
}

}

无需手动解析字符串,也不用担心类型转换异常 —— Spring Boot 会自动处理。

相关文章

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

10177

6

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

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

2023.07.05

7322

9

java自学难吗
java自学难吗

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

2023.07.31

6432

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习