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的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA无法使用终端terminal问题的解决方案

    IDEA无法使用终端terminal问题的解决方案

    这篇文章主要介绍了IDEA无法使用终端terminal问题的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • Spring为何要用三级缓存来解决循环依赖问题

    Spring为何要用三级缓存来解决循环依赖问题

    这篇文章主要给大家介绍了关于Spring为何要用三级缓存来解决循环依赖问题的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • 解决MyEclipse10.7部署报错抛空指针异常问题的方法

    解决MyEclipse10.7部署报错抛空指针异常问题的方法

    这篇文章主要介绍了解决MyEclipse10.7部署报错抛空指针异常问题的方法,需要的朋友可以参考下
    2015-12-12
  • java中带参数的try(){}语法含义详解

    java中带参数的try(){}语法含义详解

    这篇文章主要介绍了java中带参数的try(){}语法含义详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • 详解MyBatis工作原理

    详解MyBatis工作原理

    近来想写一个mybatis的分页插件,但是在写插件之前肯定要了解一下mybatis具体的工作原理吧,本文就详细总结了MyBatis工作原理,,需要的朋友可以参考下
    2021-05-05
  • SpringBoot项目中处理返回json的null值(springboot项目为例)

    SpringBoot项目中处理返回json的null值(springboot项目为例)

    本文以spring boot项目为例给大家介绍SpringBoot项目中处理返回json的null值问题,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友参考下
    2019-10-10
  • 基于swagger参数与实体中参数不一致的原因分析

    基于swagger参数与实体中参数不一致的原因分析

    这篇文章主要介绍了基于swagger参数与实体中参数不一致的原因分析,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • spring boot 集成 swagger3及配置方法

    spring boot 集成 swagger3及配置方法

    Swagger 3是一种开源的API描述工具,它可以帮助开发人员设计、构建、文档化和测试API,这篇文章主要介绍了spring boot 集成 swagger3,需要的朋友可以参考下
    2023-05-05
  • Java将字符串转化为数组的两种方法

    Java将字符串转化为数组的两种方法

    Java中的String类是一种特殊的字符串,它可以被用于处理字符串,Java中的String类也可以将字符串转换为数组,下面这篇文章主要给大家介绍了关于Java将字符串转化为数组的两种方法,需要的朋友可以参考下
    2023-05-05
  • java多线程之线程同步七种方式代码示例

    java多线程之线程同步七种方式代码示例

    这篇文章主要介绍了java多线程之线程同步七种方式代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11

最新评论