Java 中怎么使用 @ConfigurationProperties 批量绑定配置属性

夏枫姑娘_5678

夏枫姑娘_5678

2026-11-02

786人浏览

原创

@ConfigurationProperties是Spring Boot推荐的批量绑定配置方式,通过指定前缀将application.yml/properties中结构化配置自动映射到Java Bean,支持松散绑定、类型安全、校验(@Validated)及IDE提示,显著提升可读性与可维护性。

java 中怎么使用 @configurationproperties 批量绑定配置属性

在 Java Spring Boot 项目中,@ConfigurationProperties 是批量绑定配置属性最常用、最推荐的方式。它能把 application.yml 或 application.properties 中的一组结构化配置,自动映射到一个 Java Bean 中,避免逐个用 @Value 注入,提升可读性和可维护性。

1. 添加依赖并启用配置绑定

确保项目已引入 spring-boot-configuration-processor(非必须但强烈建议),用于生成配置元数据,支持 IDE 提示和校验:

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

Spring Boot 2.2+ 默认开启配置绑定,无需额外启用;若使用较老版本,需在主类或配置类上加 @EnableConfigurationProperties(YourConfigClass.class)。

2. 定义配置类并绑定前缀

创建一个普通 Java 类,用 @ConfigurationProperties 指定配置前缀,并用 @Component 或 @Configuration 声明为 Spring Bean:

@Component
@ConfigurationProperties(prefix = "app.db")
@Data // Lombok,也可手写 getter/setter
public class DatabaseProperties {
    private String url;
    private String username;
    private String password;
    private int maxPoolSize = 10;
    private List<string> allowedHosts = new ArrayList();
}</string>

对应 application.yml 示例:

app:
  db:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret
    max-pool-size: 20
    allowed-hosts:
      - 127.0.0.1
      - 192.168.1.100

注意:YAML 中的短横线(max-pool-size)会自动匹配 Java 的驼峰命名(maxPoolSize)。

3. 启用松散绑定与类型安全校验

@ConfigurationProperties 默认支持松散绑定(kebab-case、snake_case、camelCase 等均可识别)。如需校验,可结合 Bean Validation 注解:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
  • 在字段上添加 @NotBlank、@Min(1)、@Email 等注解
  • 类上加 @Validated(必须,否则校验不生效)
  • 启动时自动校验,失败则抛出 BindException,应用无法启动

例如:

@Component
@ConfigurationProperties(prefix = "app.mail")
@Validated
@Data
public class MailProperties {
    @NotBlank
    private String host;
    @Min(1)
    @Max(65535)
    private int port = 587;
    @Email
    private String from;
}

4. 在其他 Bean 中注入使用

像普通 Spring Bean 一样通过构造器或字段注入即可:

@Service
public class UserService {
    private final DatabaseProperties dbProps;
<pre class="brush:php;toolbar:false;">public UserService(DatabaseProperties dbProps) {
    this.dbProps = dbProps;
}

public void connect() {
    System.out.println("Connecting to: " + dbProps.getUrl());
    System.out.println("Max pool: " + dbProps.getMaxPoolSize());
}

}

也可用 @Autowired 字段注入(不推荐,不利于单元测试)。

不复杂但容易忽略:确保配置类有无参构造器(Lombok @Data 自带)、字段可写(有 setter 或用 Lombok @Setter),且配置前缀在 YAML/properties 中拼写正确——这是绑定失败最常见的原因。

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

相关文章

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

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

下载

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

相关专题

更多
java
java

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

2023.06.15

11757

6

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

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

2023.07.05

8842

9

java自学难吗
java自学难吗

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

2023.07.31

7592

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3089

5

java在线网站
java在线网站

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

2023.08.03

20331

3

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

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

2023.08.03

1355

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习