注解实现配置项动态注入_自定义注解如何通过反射读取Properties文件并赋值

轻磊小哥_1774

轻磊小哥_1774

2026-05-15

522人浏览

原创

自定义注解本身不具注入能力,需结合反射与Spring机制实现配置动态注入;通过定义@ConfigValue标记字段、编写BeanPostProcessor扫描赋值,并利用Spring的类型转换和生命周期管理完成自动绑定。

自定义注解本身不能自动读取 properties 文件并完成字段赋值,它只是元数据标记;真正实现“配置项动态注入”的,是配合反射 + spring 的 @configurationproperties 机制,或手动编写一个初始化后置处理器(如 beanpostprocessor)来扫描注解、加载配置、设置字段值。

1. 定义自定义注解(标记需要注入的字段)

例如定义一个 @ConfigValue 注解,用于标注字段,并指定配置项 key:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ConfigValue {
    String value(); // 如 "app.timeout"
    String defaultValue() default "";
}

这个注解不带任何逻辑,仅作标识用,必须搭配运行时反射才能生效。

2. 编写配置加载与反射赋值逻辑

核心步骤:获取 Properties 实例 → 扫描 Bean 中被 @ConfigValue 标记的字段 → 通过反射设值。可封装为工具类或 Spring Bean 后置处理器:

  • 使用 ResourceBundle.getBundle("xxx") 或 Properties.load(InputStream) 加载配置文件
  • 遍历目标对象所有 Field,检查是否含 @ConfigValue
  • 从 Properties 中按注解 value 查 key,获取字符串值
  • 根据字段类型做简单转换(如 "true" → boolean,"8080" → int),再调用 field.setAccessible(true); field.set(obj, convertedValue)

⚠️ 注意:需处理 static 字段、final 字段(反射无法修改 final,除非先绕过修饰符)、类型不匹配等边界情况。

3. 在 Spring 中集成(推荐方式)

不建议裸写反射逻辑,而是复用 Spring 生态能力:

  • 用 @ConfigurationProperties(prefix = "app") + @Component 类接收配置,Spring 自动绑定(基于 getter/setter 或构造器)
  • 若坚持用字段注解风格,可实现 BeanPostProcessor,在 postProcessAfterInitialization 中对特定 Bean 执行上述反射赋值
  • 配合 @ConditionalOnProperty 或自定义 @Conditional 实现条件化注入

这样既保持扩展性,又兼容 Spring 生命周期和类型转换(ConversionService)。

4. 配置文件与使用示例

application.properties:

app.timeout=3000
app.debug=true
app.name=my-app

Java 类中使用:

@Component
public class AppConfig {
    @ConfigValue("app.timeout")
    private int timeout;

    @ConfigValue(value = "app.debug", defaultValue = "false")
    private boolean debug;

    @ConfigValue("app.name")
    private String name;
}

只要确保该 Bean 初始化完成后,你的反射注入逻辑被执行(如注册为 BeanPostProcessor),字段就会被正确赋值。

不复杂但容易忽略:反射设值前务必调用 setAccessible(true);配置值为空或类型不匹配时要有默认策略或日志提示;生产环境建议配合配置中心(Nacos/Apollo)做热更新,而非只读取本地 Properties。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

12077

6

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

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

2023.07.05

9162

9

java自学难吗
java自学难吗

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

2023.07.31

7852

8

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

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

2023.08.01

1284

3

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

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

2023.08.02

1028

3

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

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

2023.08.02

1516

5

java有什么用
java有什么用

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

2023.08.02

3169

5

java在线网站
java在线网站

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

2023.08.03

20411

3

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

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

2023.08.03

1375

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习