Spring中的@ConfigurationProperties在方法上的使用详解

 更新时间:2024年01月31日 10:43:12   作者:搏·梦  
这篇文章主要介绍了Spring中的@ConfigurationProperties在方法上的使用详解,@ConfigurationProperties应该经常被使用到,作用在类上的时候,将该类的属性取值 与配置文件绑定,并生成配置bean对象,放入spring容器中,提供给其他地方使用,需要的朋友可以参考下

Java技术迷

前言

在学习spring的时候,@ConfigurationProperties应该经常被使用到,作用在类上的时候,将该类的属性取值 与配置文件绑定,并生成配置bean对象,放入spring容器中,提供给其他地方使用。

在工作中,或者看spring内部代码的时候,无意发现@ConfigurationProperties居然还可以用在方法上,点开@ConfigurationProperties注解的时候,我们发现:

1
2
3
4
5
6
// targer:可作用在类、方法上
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
}

似乎平时我们都是用在类上的,因此特意写这篇文章记录一下,记录@ConfigurationProperties的使用方式。

先说结论

  • @ConfigurationProperties无论是使用在类上,或用在方法上,其本质都是将某个配置类的属性值与配置文件application.yml中内容进行绑定。
  • 其使用场景用如下三种:
    • @ConfigurationProperties + @Component + 在类上使用的场景
    • @ConfigurationProperties + @EnableConfigurationProperties 在类上使用的场景
    • @ConfigurationProperties + @Bean 在方法上使用的场景

代码解释

@Component + @ConfigurationProperties

在类上使用@ConfigurationProperties效果:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@Component
@ConfigurationProperties(prefix = "test.config")
@Setter
@ToString
public class TestConfigDemo {
    private String username;
    private String pwd;
}
// yml
test:
  config:
    username: test-config-username
    pwd: test-config-pwd
// 测试代码
@Component
public class TestConfigAppRunner implements ApplicationRunner {
    @Autowired
    TestConfigDemo testConfigDemo;
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(testConfigDemo);
    }
}

在这里插入图片描述

从上述可看出@ConfigurationProperties的作用,而@ConfigurationProperties的使用则是在配置类上需要有set方法、以及是需要@Component

@EnableConfigurationProperties + @ConfigurationProperties

这里不做过多说明

@Bean + @ConfigurationProperties

直接看代码:

1
2
3
4
5
6
7
// 该配置类上 无 任何spring的注解
@Setter
@ToString
public class TestConfigDemo {
    private String username;
    private String pwd;
}
1
2
3
4
5
6
7
8
9
10
11
// 准备个@Configuration 配置类
@Configuration
public class ConfigurationDemo {
    // 这里将TestConfigDemo 配置类 生成bean对象
    // 此时:TestConfigDemo里面的属性将与配置文件yml内容进行绑定
    @Bean
    @ConfigurationProperties(prefix = "test.config")
    public TestConfigDemo testConfigDemo(){
        return new TestConfigDemo();
    }
}
1
2
3
4
5
6
7
8
9
10
11
@Component
public class TestConfigAppRunner implements ApplicationRunner {
 
    @Autowired
    TestConfigDemo testConfigDemo;
 
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(testConfigDemo);
    }
}

在这里插入图片描述

看到上述的例子,想必大家内心此时的想法是:@ConfigurationProperties使用在方法上的效果,跟使用在类上的完全没任何区别,只是将@ConfigurationProperties的位置换了一个地方,并无太大区别吧。

但其出现必然有其存在意义: 个人觉得,其作用就是,如果项目中有个@Configuration这种类的话,可以把config配置类的注解内容等都放入该类中,达到一种配置好管理的效果,之后如果要改什么内容,只要看@Configuration这种类即可,无需到处找。

到此这篇关于Spring中的@ConfigurationProperties在方法上的使用详解的文章就介绍到这了,更多相关@ConfigurationProperties的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

蓄力AI

微信公众号搜索 “ 脚本之家 ” ,选择关注

程序猿的那些事、送书等活动等着你

原文链接:https://blog.csdn.net/xueyijin/article/details/129229409

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权/违法违规/事实不符,请将相关资料发送至 reterry123@163.com 进行投诉反馈,一经查实,立即处理!

相关文章

  • Java类的继承原理与用法分析

    Java类的继承原理与用法分析

    这篇文章主要介绍了Java类的继承原理与用法,结合实例形式分析了java类的继承相关原理、使用方法及操作注意事项,需要的朋友可以参考下
    2020-02-02
  • Spring Kafka中如何通过参数配置解决超时问题详解

    Spring Kafka中如何通过参数配置解决超时问题详解

    这篇文章主要给大家介绍了关于Spring Kafka中如何通过参数配置解决超时问题的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-01-01
  • JAVA如何获取jvm和操作系统相关信息

    JAVA如何获取jvm和操作系统相关信息

    这篇文章主要介绍了JAVA获取jvm和操作系统相关信息,使用Java自带的类进行获取系统运行的相关信息,在这整理记录分享一下,需要的朋友可以参考下
    2022-10-10
  • java GUI实现加法计算器

    java GUI实现加法计算器

    这篇文章主要为大家详细介绍了java GUI实现加法计算器,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04
  • Java修饰符 abstract,static,final 的区别详解

    Java修饰符 abstract,static,final 的区别详解

    以下是对Java修饰符abstract,static,final的区别进行了详细的介绍,需要的朋友可以过来参考下
    2013-09-09
  • SpringBoot深入分析运行原理与功能实现

    SpringBoot深入分析运行原理与功能实现

    我们发现springBoot程序开发比spring程序编写起来容易的多。配置简洁,依赖关系简单,启动运行容易。那么结下了我们我们就要思考一下入门程序中的这些功能是怎么实现的
    2022-09-09
  • IDEA连接MySQL后管理数据库的操作指南

    IDEA连接MySQL后管理数据库的操作指南

    本节就来教大家如何在IDEA连接MySQL后管理数据库(创建/修改/删除数据库、创建/修改/删除表、插入/更新/删除/查询表记录),文中通过图文结合的方式给大家讲解的非常详细,需要的朋友可以参考下
    2024-05-05
  • Java后端Tomcat实现WebSocket实例教程

    Java后端Tomcat实现WebSocket实例教程

    WebSocket protocol 是HTML5一种新的协议。它实现了浏览器与服务器全双工通信(full-duplex)。一开始的握手需要借助HTTP请求完成握手。本文给大家介绍Java后端Tomcat实现WebSocket实例教程,感兴趣的朋友一起学习吧
    2016-05-05
  • Springboot集成mqtt客户端详解

    Springboot集成mqtt客户端详解

    MQTT是一个基于客户端-服务器的消息发布/订阅传输协议。MQTT协议是轻量、简单、开放和易于实现的,这些特点使它适用范围非常广泛。本文为大家分享了Springboot整合mqtt服务的示例代码,需要的可以参考一下
    2022-10-10
  • 详解Java编程中对线程的中断处理

    详解Java编程中对线程的中断处理

    这篇文章主要介绍了Java编程中对线程的中断处理,特别讲解了中断的时机与中断状态的管理,需要的朋友可以参考下
    2015-11-11

最新评论