【Spring框架】@ConfigurationProperties注解深度解析,有两下子!

举报
bug菌 发表于 2024/07/28 16:35:02 2024/07/28
【摘要】 本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习,可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内,快速投入学习!!两不误。

📣前言

  在Spring框架中,配置外部化是一种常见的做法,它允许我们将配置数据从代码中抽离出来,提高应用程序的灵活性和可维护性。@ConfigurationProperties注解是Spring Boot提供的一个强大工具,用于将配置属性绑定到Java对象上。本文将深入探讨@ConfigurationProperties注解的使用方法和内部机制。

  那么,具体如何实现呢?这将又会是干货满满的一期,全程无尿点不废话只抓重点教,具有非常好的学习效果,拿好小板凳准备就坐!希望学习的过程中大家认真听好好学,学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信,bug菌将第一时间给予解惑,那么废话不多说,直接开整!Fighting!!

🌊环境说明

开发工具:IDEA 2021.3
JDK版本: JDK 1.8
Spring Boot版本:2.3.1 RELEASE
Maven版本:3.8.2


🏆本文收录于《Spring Boot从入门到精通》,专门攻坚指数提升,2023 年国内最系统+最强(更新中)。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习,可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内,快速投入学习!!两不误。


🌊摘要

  本文详细介绍了Spring框架中的@ConfigurationProperties注解,包括其定义、如何与Spring Environment结合、源码解析、案例分析、优缺点分析,以及如何编写测试用例。通过实际代码示例,引导读者掌握@ConfigurationProperties注解的使用,提高配置管理的效率和质量。

🌊正文

搭建Spring Boot应用

  首先,我们先创建个基础的Spring Boot项目,如果还不会点这里,此处就不详细赘述啦。

简介

  @ConfigurationProperties注解用于将配置属性注入到JavaBean中。它通常与@Component注解结合使用,使得配置的JavaBean可以被Spring容器管理,并自动装配配置属性。

  其次,@ConfigurationProperties是Spring框架提供的一个注解,用于将外部配置(如application.properties或application.yml文件中的属性)映射到一个Java对象的属性中。这个注解是Spring Boot项目中处理配置的一种非常便捷的方式,它使得配置的加载和管理变得更加自动化和类型安全。

主要特点

  • 类型安全:自动将字符串配置属性转换为相应的数据类型。
  • 自动绑定:根据注解的prefix属性,自动绑定具有相同前缀的配置属性到Java对象的字段。
  • 验证支持:可以结合使用@Valid@Validated注解来实现配置绑定对象的校验。
  • 转换服务:Spring提供了一系列转换器(Converter),用于将字符串转换为特定的数据类型。

使用方法

  1. 定义配置属性类:创建一个类,使用@ConfigurationProperties注解标记,并指定一个前缀。
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfigProperties {
    private String name;
    private int port;

    // 标准的getter和setter方法
}
  1. 配置文件中的属性:在application.propertiesapplication.yml中定义相应的配置项。
# application.properties
app.name=myapp
app.port=8080
  1. 注入和使用:Spring容器会自动创建配置属性类的一个实例,并注入到需要的地方。
@RestController
public class MyController {
    private final AppConfigProperties config;

    @Autowired
    public MyController(AppConfigProperties config) {
        this.config = config;
    }

    @GetMapping("/config")
    public Map<String, Object> getConfig() {
        return Collections.singletonMap("config", config);
    }
}

源码解析

  @ConfigurationProperties注解的定义如下:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ConfigurationPropertySource
public @interface ConfigurationProperties {
    String prefix() default "";
}
  • @Target(ElementType.TYPE) 指定注解应用于类。
  • @Retention(RetentionPolicy.RUNTIME) 指定注解在运行时有效。
  • @ConfigurationPropertySource 是一个元注解,用于激活配置属性的绑定。

  并附上部分相关注解源码截图,这里我就简单给附上,感兴趣的同学可以扒扒源码,深入去学习下开源框架的设计构思及理念,这也是掌握一个架构的核心目标,但是基础一般或者零基础的同学,建议先从使用上深入,而不是一口吃掉一个胖子,得不偿失。

  如下是我对该注解源码的一些解读,仅供参考:

@ConfigurationProperties 注解是 Spring Framework 中用于将配置属性注入到 Java 类中的一个强大工具。下面,我们来逐行解析这个注解的源码:

@Target({ElementType.TYPE})
  • @Target(ElementType.TYPE): 这个元注解指定了 @ConfigurationProperties 可以应用于 Java 类或接口上。这意味着 @ConfigurationProperties 注解不能用于方法、构造函数或字段。
@Retention(RetentionPolicy.RUNTIME)
  • @Retention(RetentionPolicy.RUNTIME): 这个元注解定义了 @ConfigurationProperties 注解的保留策略。RetentionPolicy.RUNTIME 表示注解在 JVM 运行时依然有效,可以通过反射读取注解信息。
@Documented
  • @Documented: 这个元注解表明 @ConfigurationProperties 注解会被包含在 JavaDoc 中,有助于生成文档时展示这些注解信息。
@ConfigurationPropertySource
  • @ConfigurationPropertySource: 这是一个元注解,它本身也是 @ConfigurationProperties 注解的一部分。它的作用是激活配置属性的绑定功能,让 Spring 知道需要从配置源(如配置文件、环境变量等)中绑定属性到使用 @ConfigurationProperties 注解的类。
public @interface ConfigurationProperties {
    String prefix() default "";
}
  • public @interface ConfigurationProperties: 这行代码声明了 ConfigurationProperties 是一个注解类型。
  • String prefix() default "";: 这是 ConfigurationProperties 注解中定义的一个属性 prefix,它返回一个字符串类型的值。这个属性指定了配置项的前缀,Spring 将根据这个前缀从配置源中查找匹配的属性并绑定到类中。如果不指定(默认为空字符串),则绑定所有没有前缀的配置项。

源码解析的意义

通过理解 @ConfigurationProperties 注解的源码,我们可以知道:

  • 这个注解是专门设计来处理配置属性的自动绑定。
  • 它通过指定前缀来简化配置项的查找和绑定过程。
  • 它在运行时通过反射机制来实现属性的注入,因此注解的保留策略必须设置为 RUNTIME
  • 它通过 @ConfigurationPropertySource 元注解来激活 Spring 的配置属性绑定功能。

案例分析

  考虑一个配置类AppConfig,用于绑定application.properties中的相关属性:

@Component
@ConfigurationProperties(prefix = "app.config")
public class AppConfigProperties {
    private String dbUrl;
    private String dbUser;
    private String dbPassword;

    // 标准的getter和setter方法
}

  在这个示例中,AppConfigProperties 类通过 @ConfigurationProperties 注解绑定了以 app.config 为前缀的配置属性。Spring 容器会自动从配置文件中提取相应的属性并注入到这个类的字段中。

  接着我将对上述代码进行详细的一个逐句解读,希望能够帮助到同学们,能以更快的速度对其知识点掌握学习,这也是我写此文的初衷,授人以鱼不如授人以渔,只有将其原理摸透,日后应对场景使用,才能得心应手,所以如果有基础的同学,可以略过如下代码分析步骤,然而没基础的同学,还是需要加强对代码的理解,方便你深入理解并掌握其常规使用。

这段Java代码演示了如何在Spring框架中使用@Component@ConfigurationProperties注解来创建一个配置属性类AppConfigProperties。以下是对这段代码的详细解析:

类定义和注解使用

  • @Component: 这个注解标明AppConfigProperties类是一个Spring组件,Spring容器会扫描并自动注册这个类为一个Bean。

  • @ConfigurationProperties(prefix = "app.config"): 这个注解告诉Spring容器,AppConfigProperties类用于绑定前缀为app.config的配置属性。这意味着所有在配置文件中以app.config开头的属性都会被绑定到这个类的相应字段。

字段定义

  • private String dbUrl;: 定义了一个私有字符串字段dbUrl,用于存储数据库的URL地址。

  • private String dbUser;: 定义了一个私有字符串字段dbUser,用于存储数据库的用户名。

  • private String dbPassword;: 定义了一个私有字符串字段dbPassword,用于存储数据库的密码。

配置属性绑定

  在application.propertiesapplication.yml配置文件中,可以使用以下格式定义配置属性:

# application.properties
app.config.dbUrl=jdbc:mysql://localhost:3306/mydb
app.config.dbUser=root
app.config.dbPassword=secret

或者使用YAML格式:

# application.yml
app:
  config:
    dbUrl: jdbc:mysql://localhost:3306/mydb
    dbUser: root
    dbPassword: secret

注意事项

  • 确保配置属性的名称和字段名称匹配,Spring将根据字段名称的驼峰式大小写来确定配置项的名称。
  • 如果配置属性在配置文件中不存在,而字段没有提供默认值,那么注入可能会失败。
  • 使用@ConfigurationProperties的类通常与@Validated注解结合使用,以实现配置属性的校验。

  通过上述解析,我们可以看到@ConfigurationProperties注解如何简化配置属性的绑定过程,使得配置管理变得更加灵活和易于维护。

  实际运用场景展示如下,这也是我日常项目开发中的实操之一,分享给大家看看,仅供参考:

应用场景案例列举

@ConfigurationProperties注解通常应用于以下场景:

  • 外部化配置:将应用程序的配置外部化到文件或环境变量中。
  • 类型安全配置:提供类型安全的配置属性访问。
  • 自动装配:自动装配配置属性到Spring管理的Bean中。

优缺点分析

使用@ConfigurationProperties注解的优点包括:

  • 简化配置管理:自动装配配置属性,减少手动设置。
  • 类型安全:编译时检查配置属性的类型。

缺点可能包括:

  • 过度依赖注解:可能导致代码与Spring框架的耦合度增加。
  • 配置分散:配置属性分散在多个配置类中,可能难以管理。

类代码方法介绍

  使用@ConfigurationProperties的类通常包含标准的JavaBean属性,以及对应的getters和setters。

测试用例

  编写测试用例以验证配置属性的正确绑定是重要的。以下是一个使用JUnit的测试示例:

public class AppConfigTest {
    
    @Test
    public void testConfigPropertiesBinding() {
        // 创建配置属性源
        Map<String, String> properties = new HashMap<>();
        properties.put("app.name", "TestApp");
        properties.put("app.timeout", "100");
        
        // 模拟Environment
        Environment environment = mock(Environment.class);
        when(environment.getProperty("app.name")).thenReturn("TestApp");
        when(environment.getProperty("app.timeout")).thenReturn("100");
        
        // 创建并测试AppConfig
        AppConfig appConfig = new AppConfig();
        appConfig.setTimeout(100);
        appConfig.setName("TestApp");
        
        // 断言或其他验证逻辑
        assertEquals("TestApp", appConfig.getName());
        assertEquals(100, appConfig.getTimeout());
    }
}

  接着我将对上述代码进行详细的一个逐句解读,希望能够帮助到同学们,能以更快的速度对其知识点掌握学习,这也是我写此文的初衷,授人以鱼不如授人以渔,只有将其原理摸透,日后应对场景使用,才能得心应手,所以如果有基础的同学,可以略过如下代码分析步骤,然而没基础的同学,还是需要加强对代码的理解,方便你深入理解并掌握其常规使用。

  这段Java代码是一个JUnit测试用例,用于验证AppConfig类是否能够正确地绑定配置属性。以下是对这段代码的详细解析:

测试类定义

  • public class AppConfigTest: 定义了一个名为AppConfigTest的测试类。

测试方法

  • @Test: 这个注解标记testConfigPropertiesBinding方法为JUnit测试方法。

配置属性源创建

  • Map<String, String> properties = new HashMap<>();: 创建了一个HashMap来模拟配置属性源。

  • properties.put("app.name", "TestApp");properties.put("app.timeout", "100");: 向属性源中添加模拟的配置项。

模拟Environment

  • Environment environment = mock(Environment.class);: 使用Mockito库模拟Environment对象,以便在测试中控制配置属性的获取。

  • when(environment.getProperty("app.name")).thenReturn("TestApp");when(environment.getProperty("app.timeout")).thenReturn("100");: 定义了模拟Environment对象的getProperty方法的行为,指定当获取特定属性时返回的值。

创建并测试AppConfig

  • AppConfig appConfig = new AppConfig();: 创建了AppConfig类的实例。

  • appConfig.setTimeout(100);appConfig.setName("TestApp");: 手动设置AppConfig实例的属性值,模拟配置属性注入。

断言验证

  • assertEquals("TestApp", appConfig.getName());assertEquals(100, appConfig.getTimeout());: 使用JUnit的assertEquals方法验证AppConfig实例的属性是否符合预期值。

注意事项

  • 测试中使用了Mockito库来模拟Environment对象,这是Spring测试中常用的技术,用于隔离测试环境和实际的Spring环境。

  • 测试用例中直接设置了AppConfig的属性值,这通常是为了验证属性绑定逻辑,但在实际使用中,这些属性将通过Spring的@ConfigurationProperties注解自动绑定。

  • 测试用例中缺少了import语句和Mockito的设置,实际使用时需要导入相应的类和Mockito库。

  • 测试方法应该独立于其他测试,不依赖于外部状态或数据库。

示例代码扩展

  在实际的测试中,我们可能会使用Spring的@ConfigurationPropertiesBindingPostProcessor来处理配置属性的绑定,并使用Mockito来验证Environment的行为:

@Test
public void testConfigPropertiesBinding() {
    // ... 省略上述代码 ...

    // 使用ConfigurationPropertiesBindingPostProcessor来绑定属性
    ConfigurationPropertiesBindingPostProcessor processor =
            new ConfigurationPropertiesBindingPostProcessor(environment);
    processor.postProcessBeforeInitialization(appConfig, "appConfig");

    // 断言或其他验证逻辑
    // ... 省略上述代码 ...
}

  这个扩展示例展示了如何在测试中使用Spring的后处理器来自动绑定配置属性,而不是手动设置属性值。这更接近于实际应用程序中@ConfigurationProperties注解的行为。

总结

  在当今快速发展的软件开发领域,Spring框架的@ConfigurationProperties注解扮演了一个至关重要的角色。它不仅提高了配置管理的效率,还增强了代码的可维护性和类型安全性。通过将外部配置与代码解耦,我们能够更灵活地应对需求变化,简化环境迁移和参数调整。

  本文深入浅出地剖析了@ConfigurationProperties注解的内部机制和使用方式。从注解的基本定义到实际编码中的应用,再到源码层面的解析,我们一步步揭开了它的神秘面纱。通过实际案例的分析,我们学会了如何将配置属性与Java对象绑定,实现自动化的配置注入。

  此外,文中还探讨了@ConfigurationProperties注解的优缺点,指出了其在简化配置管理、提高开发效率方面的优势,同时也提醒了我们潜在的过度依赖和配置分散问题。测试用例的编写示例进一步强化了我们对注解正确使用的认识,确保了配置的正确性和应用的稳定性。

小结

  通过本文的学习,我们不仅掌握了@ConfigurationProperties注解的使用,更深入理解了Spring框架在配置外部化方面的设计理念。我们认识到,合理利用这一工具可以极大地提升我们的开发效率和应用质量。同时,我们也意识到了在实际开发中需要对配置进行合理规划和管理,避免因配置不当导致的系统问题。

  随着技术的不断演进,@ConfigurationProperties注解将继续作为Spring生态中不可或缺的一部分,助力开发者构建更加健壮、灵活和易于维护的应用程序。让我们持续关注和学习,掌握更多高效工具和最佳实践,共同推动软件行业的发展。


  本文的探讨和分析旨在提供一个全面的视角,帮助开发者深入理解并有效利用@ConfigurationProperties注解。希望每位读者都能从中获得有价值的信息和启发,将这些知识应用到实际开发中,不断提升自己的技术水平和专业能力。
… …

  ok,以上就是我这期的全部内容啦,若想学习更多,你可以持续关注我,我会把这个多线程篇系统性的更新,保证每篇都是实打实的项目实战经验所撰。只要你每天学习一个奇淫小知识,日积月累下去,你一定能成为别人眼中的大佬的!功不唐捐,久久为功!

「赠人玫瑰,手留余香」,咱们下期拜拜~~

🌊热文推荐

滴~如下推荐【Spring Boot 进阶篇】的学习大纲,请小伙伴们注意查收。

Spring Boot进阶(01):使用Spring Boot和Redis轻松实现高性能、高可用的缓存服务。

Spring Boot进阶(02):防止程序员疯狂 Debug:快速掌握 Validation 参数校验技巧,让你的代码健康起来!

Spring Boot进阶(03):【实战教程】MyBatis-Plus秒级实现字段自动填充,让你的代码更优雅!

Spring Boot进阶(04):震惊!使用MyBatis-Plus,快速实现自定义SQL分页功能!

Spring Boot进阶(05):Spring Boot与RabbitMQ完美融合,打造高效消息队列服务!

Spring Boot进阶(06):【超详细】Windows10搭建RabbitMQ Server服务端,让你轻松实现消息队列管理!

Spring Boot进阶(07):如何使用EasyPoi实现Java中Excel的导入导出?完整教程请收藏,让你的Excel操作更高效!

Spring Boot进阶(08):使用EasyPoi实现Excel/Word携带图片导出,打造精美的报表

Spring Boot进阶(09):用EasyPoi实现Excel多sheet导入导出,轻松管理海量数据!

Spring Boot进阶(10):「从Excel到PDF,EasyPoi助你一键完美转换!」

Spring Boot进阶(11):实现纯文本转成.csv格式文件,Spring Boot轻松搞定!附完整代码

Spring Boot进阶(12):如何快速获取Excel文件中的Sheet页数量?Spring Boot教程带你一步步实现

Spring Boot进阶(13):如何优雅获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值,附源码

Spring Boot进阶(14):Spring Boot高级应用:手把手教你连接数据库并获取指定表结构!一文教会你

Spring Boot进阶(15):用Spring Boot实现动态数据库分页查询表结构信息!

Spring Boot进阶(16):使用Redis实现手机验证码功能,让你的用户注册更加便捷!

Spring Boot进阶(17):Swagger2高级配置:定制header请求头等参数

Spring Boot进阶(18):轻松管理定时任务!Spring Boot@Scheduled让你事半功倍

Spring Boot进阶(19):探索ElasticSearch:如何利用Spring Boot轻松实现高效数据搜索与分析

Spring Boot进阶(20):「打造高性能Web应用」——使用Jetty容器配置Spring Boot

Spring Boot进阶(21):优化Spring Boot应用性能,使用Undertow容器提升响应速度

Spring Boot进阶(22):决战容器之巅:Tomcat vs Undertow!性能对比分析揭秘最佳选择!

Spring Boot进阶(23):终极解决方案!教你实现高效文件上传!

Spring Boot进阶(24):秒传!快速实现高效多文件上传的最佳解决方案

Spring Boot进阶(25):如何写出高效的文件上传单元测试?让你的测试更智能更高效!

Spring Boot进阶(26):从小白到高手,掌握Mybatis中resultType和resultMap的秘密!

Spring Boot进阶(27):Spring Boot进阶(27):Kafka大显身手,快速构建消息驱动应用!(环境搭建+演示)

Spring Boot进阶(28):如何让Spring Boot应用在Linux中以后台服务方式启动,并实现滚动日志查看及保存至实体文件?

Spring Boot进阶(29):如何正确使用Spring Boot注解@PathVariable、@RequestParam和@RequestBody: Postman演示教程

Spring Boot进阶(30):@RestController与@Controller的区别及使用场景详解,附带精彩实战演示

… …

  若想系统性的从0到1的入门进阶学习,可以参考这篇专栏总结《2024最新首发,全网最全 Spring Boot 学习宝典(附思维导图)》本专栏致力打造全网最硬核 Spring Boot 学习及进阶SpringBoot 系列教学内容,🚀均为全网独家首发,致力打造精品硬核干货,专栏永持续更新。欢迎大家订阅学习。一分耕耘一份收获!

  如果想快速定位学习,可以看这篇【一站式教程导航】,你想学习的都被收录系统整理在内,以最快的速度投入并学习掌握!!你值得拥有。

  在入门及进阶之途,我必助你一臂之力,系统性学习,从入门到精通,带你不走弯路,直奔终点!投资自己,性价比永远最高,都这么说了,你还不赶紧来白嫖??

  本文涉及所有源代码,均已上传至GitHub开源,供同学们一对一参考 GitHub传送门,同时,原创开源不易,欢迎给个star🌟,想体验下被🌟的感jio,非常感谢❗

📣文末

我是bug菌,CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家,C站博客之星Top30,华为云2023年度十佳博主,掘金多年度人气作者Top40,掘金等各大社区签约作者,51CTO年度博主Top12,掘金/InfoQ/51CTO等社区优质创作者;全网粉丝合计 30w+;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料,你想要的我都有,关键是你不来拿哇。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。