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

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

前言

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

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

// 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效果:

@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

直接看代码:

// 该配置类上 无 任何spring的注解
@Setter
@ToString
public class TestConfigDemo {
    private String username;
    private String pwd;
}
// 准备个@Configuration 配置类
@Configuration
public class ConfigurationDemo {
	// 这里将TestConfigDemo 配置类 生成bean对象
    // 此时:TestConfigDemo里面的属性将与配置文件yml内容进行绑定
    @Bean
    @ConfigurationProperties(prefix = "test.config")
    public TestConfigDemo testConfigDemo(){
        return new TestConfigDemo();
    }
}
@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的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Springboot热部署实现原理及实例详解

    Springboot热部署实现原理及实例详解

    这篇文章主要介绍了Springboot热部署实现原理及实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05
  • 这么设置IDEA中的Maven,再也不用担心依赖下载失败了

    这么设置IDEA中的Maven,再也不用担心依赖下载失败了

    今天给大家带来一个IDEA中Maven设置的小技巧.这个技巧可以说非常有用,学会设置之后,再也不用担心maven依赖下载变慢的问题,需要的朋友可以参考下
    2021-05-05
  • SpringMVC打印请求参数和响应数据最优方案

    SpringMVC打印请求参数和响应数据最优方案

    项目中经常需要打印http请求的参数和响应数据,本文给大家讲解如何在SpringMVC打印请求参数和响应数据最优方案,感兴趣的朋友跟随小编一起看看吧
    2023-07-07
  • IDEA2022.2的简介、下载与安装、配置教程

    IDEA2022.2的简介、下载与安装、配置教程

    IDEA是JetBrains公司推出一个集成开发工具,是Java开发工具中的翘楚,基于这个开发工具可以快速开发我们的Java相关项目,本文重点给大家介绍IDEA2022.2的简介、下载与安装、初步配置,感兴趣的朋友一起看看吧
    2022-11-11
  • Java中数据库常用的两把锁之乐观锁和悲观锁

    Java中数据库常用的两把锁之乐观锁和悲观锁

    这篇文章主要介绍了数据库常用的两把锁之乐观锁和悲观锁,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Kotlin中常见的List使用示例教程

    Kotlin中常见的List使用示例教程

    filter 就像其本意一样,可以通过 filter 对 Kotlin list 进行过滤,本文重点给大家介绍Kotlin中常见的List使用,感兴趣的朋友一起看看吧
    2023-11-11
  • 异常解决SpringBoot项目启动卡住,无任何异常信息问题

    异常解决SpringBoot项目启动卡住,无任何异常信息问题

    这篇文章主要介绍了异常解决SpringBoot项目启动卡住,无任何异常信息问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • Java基础之删除文本文件中特定行的内容

    Java基础之删除文本文件中特定行的内容

    这篇文章主要介绍了Java基础之删除文本文件中特定行的内容,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Kotlin Coroutines执行异步加载示例详解

    Kotlin Coroutines执行异步加载示例详解

    这篇文章主要给大家介绍了关于Kotlin Coroutines执行异步加载的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-01-01
  • MyBatisPlus-QueryWrapper多条件查询及修改方式

    MyBatisPlus-QueryWrapper多条件查询及修改方式

    这篇文章主要介绍了MyBatisPlus-QueryWrapper多条件查询及修改方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06

最新评论