讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中 Spring 怎么使用 @ConfigurationProperties 绑定配置类

小萱姑娘_9387

小萱姑娘_9387

发布时间:2026-08-29 12:03:59

|

293人浏览过

|

来源于php中文网

原创

@ConfigurationProperties 用于将配置文件属性批量绑定到 Java 对象,需指定 prefix、添加 @Component 或 @EnableConfigurationProperties 注册为 Bean,支持嵌套属性与校验,字段名需匹配配置键风格且具备 setter。

java 中 spring 怎么使用 @configurationproperties 绑定配置类

在 Spring 中,@ConfigurationProperties 是将配置文件(如 application.yml 或 application.properties)中的属性批量绑定到 Java 对象的便捷方式。它比 @Value 更适合管理结构化、嵌套的配置项。

启用 @ConfigurationProperties 支持

Spring Boot 2.2+ 默认开启配置属性绑定,但需确保项目中已引入 spring-boot-configuration-processor(编译期支持元数据生成,非运行必需,但推荐添加):

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

定义配置类并绑定属性

创建一个普通 Java 类,用 @ConfigurationProperties 标注,并指定前缀(如 app.db),再通过 @Component 或 @EnableConfigurationProperties 注入容器:

  • 推荐使用 @Component 方式(简洁,自动注册为 Bean)
  • 属性名需与配置文件中 key 的驼峰/中划线风格保持一致(Spring 自动映射,如 max-connections → maxConnections)
  • 建议添加 @Validated 和字段级校验注解(如 @NotBlank、@Min(1)),启用校验需配合 @Valid 在类上

示例:

立即学习“Java免费学习笔记(深入)”;

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
@Component
@ConfigurationProperties(prefix = "app.db")
@Validated
public class DatabaseProperties {
    @NotBlank
    private String url;
    @NotBlank
    private String username;
    private int maxConnections = 10;
    private Timeout timeout = new Timeout();

    // 内部类也支持绑定(需静态或有无参构造)
    public static class Timeout {
        @Min(100)
        private long read = 5000;
        private long connect = 3000;

        // getter / setter 省略
    }

    // getter / setter 省略
}

在配置文件中写入对应属性

支持 .properties 和 .yml,注意层级缩进和命名规范:

application.yml 示例:

app:
  db:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    max-connections: 20
    timeout:
      read: 8000
      connect: 4000

application.properties 示例:

app.db.url=jdbc:mysql://localhost:3306/mydb
app.db.username=root
app.db.max-connections=20
app.db.timeout.read=8000
app.db.timeout.connect=4000

注入并使用配置类

像普通 Bean 一样注入即可,Spring 已完成属性填充和校验(若校验失败,应用启动时抛出 BindException):

@Service
public class DbService {
    private final DatabaseProperties dbProps;

    public DbService(DatabaseProperties dbProps) {
        this.dbProps = dbProps;
    }

    public void printConfig() {
        System.out.println("URL: " + dbProps.getUrl());
        System.out.println("Max connections: " + dbProps.getMaxConnections());
        System.out.println("Read timeout: " + dbProps.getTimeout().getRead());
    }
}

不复杂但容易忽略:确保配置前缀拼写一致、字段可写(有 setter)、类型兼容(如字符串能转为 int),以及配置类被 Spring 扫描到(加 @Component 或显式注册)。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
java
java

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

10037

2023.06.15

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

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

7182

2023.07.05

java自学难吗
java自学难吗

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

6312

2023.07.31

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

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

1104

2023.08.01

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

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

908

2023.08.02

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

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

1336

2023.08.02

java有什么用
java有什么用

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

2649

2023.08.02

java在线网站
java在线网站

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

19971

2023.08.03

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn