Java 中怎么将外部 properties 配置文件中的属性自动绑定到 Java 实体类对象

轻枫小哥_4471

轻枫小哥_4471

2026-08-16

454人浏览

原创

最常用且推荐的方式是使用 spring boot 的 @configurationproperties 注解。它支持类型安全、松散绑定、校验和元数据提示,比传统方式更简洁可靠;需准备 properties 文件、创建带 @configurationproperties 和 @component 的实体类、启用配置绑定,并可直接注入使用。

java 中怎么将外部 properties 配置文件中的属性自动绑定到 java 实体类对象

Java 中将外部 properties 配置文件中的属性自动绑定到实体类对象,最常用且推荐的方式是使用 Spring Boot 的 @ConfigurationProperties 注解。它支持类型安全、松散绑定、校验和元数据提示,比传统的 PropertyPlaceholderConfigurer 或手动 Properties.load() 更简洁可靠。

1. 准备配置文件(如 application.properties 或自定义 xxx.properties)

在 src/main/resources 下新建一个 properties 文件,例如 app-config.properties:

app.name=MyApp<br>app.version=2.3.1<br>app.timeout=5000<br>app.features.cache=true<br>app.features.retry.max-attempts=3

注意:支持嵌套结构(用点号分隔),Spring 会自动映射到嵌套对象。

2. 创建对应实体类并启用 @ConfigurationProperties

实体类需满足 JavaBean 规范(提供无参构造器 + getter/setter),并添加 @ConfigurationProperties 和 @Component(或通过 @EnableConfigurationProperties 显式注册):

  • 类上加 @ConfigurationProperties(prefix = "app"),指定配置前缀
  • 加上 @Component 让 Spring 扫描并注入该 Bean
  • 建议搭配 @Validated 和字段校验注解(如 @NotBlank、@Min)提升健壮性
@Component<br>@ConfigurationProperties(prefix = "app")<br>@Validated<br>public class AppConfig {<br>    private String name;<br>    private String version;<br>    private int timeout;<br>    private Features features = new Features();<br>    // getter/setter...<br><br>    public static class Features {<br>        private boolean cache;<br>        private int maxAttempts;<br>        // getter/setter...<br>    }<br>}

3. 启用配置属性绑定(Spring Boot 2.2+ 默认开启)

确保项目已引入 spring-boot-configuration-processor(用于生成配置元数据,非必需但推荐):

Java Maven Code Review
Java Maven Code Review

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

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

同时,在 application.properties 中启用配置文件加载(如果用的是自定义文件名):

spring.config.import=classpath:app-config.properties

或者用 @PropertySource(适用于 Spring Framework 或老版本 Boot):

@ConfigurationProperties(prefix = "app")<br>@PropertySource("classpath:app-config.properties")<br>@Component<br>public class AppConfig { ... }

4. 在其他 Bean 中直接注入使用

Spring 容器会自动完成绑定,你只需像普通 Bean 一样注入即可:

@Service<br>public class AppService {<br>    private final AppConfig appConfig;<br><br>    public AppService(AppConfig appConfig) {<br>        this.appConfig = appConfig;<br>    }<br><br>    public void printConfig() {<br>        System.out.println(appConfig.getName()); // MyApp<br>        System.out.println(appConfig.getFeatures().isCache()); // true<br>    }<br>}

绑定发生在应用上下文刷新阶段,支持 reload(配合 @RefreshScope 可实现运行时刷新,需整合 Spring Cloud Config 或 Actuator)。

不复杂但容易忽略:确保属性名与配置键严格匹配(支持驼峰、中划线、下划线等松散绑定),字段类型必须可转换(如字符串转 int),否则启动失败并抛出 BindException。

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

相关文章

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

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

下载

相关标签:

java 配置文件

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

相关专题

更多
java
java

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

2023.06.15

10117

6

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

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

2023.07.05

7262

9

java自学难吗
java自学难吗

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

2023.07.31

6372

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

2669

5

java在线网站
java在线网站

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

2023.08.03

19991

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习