Spring中的@ConfigurationProperties详解

更新时间：2023年09月25日 09:52:52 作者：骑个小蜗牛

这篇文章主要介绍了Spring中的@ConfigurationProperties详解,ConfigurationProperties注解主要用于将外部配置文件配置的属性填充到这个Spring Bean实例中,需要的朋友可以参考下

@ConfigurationProperties

ConfigurationProperties注解主要用于将外部配置文件配置的属性填充到这个** Spring Bean实例 **中。

需要注意：它自己单独使用无效，需要配合其它注解一起使用。且对于Spring Bean才生效，普通的new 对象不生效。

ConfigurationProperties的使用方式：

@ConfigurationProperties + @Component（或其它实例化Bean的注解）注解到bean定义类上
@ConfigurationProperties + @Bean注解到配置类的bean定义方法上
@ConfigurationProperties注解到普通类，然后通过@EnableConfigurationProperties定义为bean

使用方式

配置文件：

sftp:
  host: 127.0.0.1
  port: 22
  username: admin
  password: 123456

1. @ConfigurationProperties + @Component

@ConfigurationProperties + @Component（或其它实例化Bean的注解）注解到bean定义类上

@Data
@Component
// @Configuration
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

2. @ConfigurationProperties + @Bean

@ConfigurationProperties + @Bean注解到配置类的bean定义方法上

@Data
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@Configuration
public class BeanConfig {
    @Bean
    @ConfigurationProperties(prefix = "sftp")
    public Sftp sftp() {
        return new Sftp();
    }
}

此种用法遇到的坑：重复使用@ConfigurationProperties 如果将代码改成这样：

@Data
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@Configuration
public class BeanConfig {
    @Bean
    @ConfigurationProperties(prefix = "aaaa")
    public Sftp sftp() {
        return new Sftp();
    }
}

这种方式上有@ConfigurationProperties注解，且类上也有@ConfigurationProperties注解的，只有方法上的@ConfigurationProperties会生效（可以理解为类上的注解方法的给重写了）。

3. @ConfigurationProperties + @EnableConfigurationProperties

@ConfigurationProperties注解到普通类，然后通过@EnableConfigurationProperties定义为bean

@Data
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@SpringBootApplication
@EnableConfigurationProperties(value = {Sftp.class})
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}

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

您可能感兴趣的文章:

Springboot使用POI进行excel文件的导出与下载方式
这篇文章主要介绍了Springboot使用POI进行excel文件的导出与下载方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-08-08
详解Jackson 使用以及性能介绍
这篇文章主要介绍了详解Jackson 使用以及性能介绍，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
java JDBC主要组件连接数据库及执行SQL过程示例全面详解
这篇文章主要为大家介绍了java JDBC主要组件连接数据库及执行SQL的过程示例全面详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-06-06
Spring Boot 2.x 把 Guava 干掉了选择本地缓存之王 Caffeine(推荐)
这篇文章主要介绍了Spring Boot 2.x 把 Guava 干掉了选择本地缓存之王 Caffeine,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
SpringBoot创建线程池的六种方式小结
本文主要介绍了SpringBoot创建线程池的六种方式小结,包括自定义线程池,固定长度线程池,单一线程池,共享线程池,定时线程池,SpringBoot中注入异步线程池,感兴趣的可以了解一下
2023-11-11
Java中字符串与日期类型的相互转换示例代码
这篇文章主要给大家介绍了关于Java中字符串与日期类型的相互转换的相关资料,将Java(或任何编程语言)中的字符串转换为日期是一项基本技能,对于在项目上进行工作很有用需要的朋友可以参考下
2023-08-08
Java多线程之Semaphore实现信号灯
这篇文章主要给大家分享的是Java多线程之Semaphore实现信号灯的练习，emaphore是计数信号量。Semaphore管理一系列许可证。每个acquire方法阻塞，直到有一个许可证可以获得然后拿走一个许可证；下面一起进入文章学习Semaphore的具体内容
2021-10-10
idea配置spring项目ApplicationContext.xml自动生成实践
本文简述Spring配置步骤：通过文件设置添加配置项,创建applicationContext.xml文件,并验证配置成功,为个人经验总结,供开发者参考
2025-09-09
Java设计模式中的工厂模式详解
这篇文章主要介绍了Java设计模式中的工厂模式详解,工厂方法模式（Factory Method Pattern）：创新型模式之一,简称工厂模式,通过定义工厂父类负责定义创建对象的公共接口,而子类则负责生成具体的对象,需要的朋友可以参考下
2023-09-09
POI XSSFSheet shiftRows bug问题解决
这篇文章主要介绍了POI XSSFSheet shiftRows bug问题解决，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07