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整合SQLite的超详细讲解
sqlite数据库是轻量化,易用的嵌入式数据库,用于设备端的数据管理,可以理解成单点的数据库,下面这篇文章主要给大家介绍了关于SpringBoot整合SQLite的超详细讲解,需要的朋友可以参考下
2024-03-03
SpringBoot基于Mybatis-Plus自动代码生成
这篇文章主要介绍了SpringBoot基于Mybatis-Plus自动代码生成，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-04-04
java如何获取本地操作系统进程列表
本文介绍了java中是如何获取当前本地操作系统正在运行的系统进程的信息,需要的朋友可以参考下
2015-07-07
Spring声明式事务@Transactional注解实现元数据驱动的事务管理
这篇文章主要为大家介绍了Spring声明式事务@Transactional注解实现元数据驱动的事务管理示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-10-10
Spring Boot 定制与优化内置的Tomcat容器实例详解
本文主要记录对内置容器优化和定制的方式,用于自己加深对SpringBoot理解。本文给大家介绍的非常详细，具有参考借鉴价值，需要的朋友参考下吧
2017-12-12
java获取优酷视频地址示例
使用JAVA解析优酷视频页，得到视频真实地址，还可以下载,需要的朋友可以参考下
2014-03-03
druid的keepalive机制源码解析
这篇文章主要为大家介绍了druid的keepalive机制源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-10-10
详解Spring如何解析占位符
Spring一直支持将属性定义到外部的属性的文件中，并使用占占位符的形式为使用"${}"包装的属性名称，为了使用属性占位符，我们必须配置一个PropertyPlaceholderConfigurer或PropertySourcesPlaceholderConfigurer实例，本文将介绍如何解析占位符
2021-06-06
Java Class 加密工具 ClassFinal详解
ClassFinal 是一款 java class 文件安全加密工具，支持直接加密jar包或war包，无需修改任何项目代码，兼容spring-framework；可避免源码泄漏或字节码被反编译，这篇文章主要介绍了Java Class 加密工具 ClassFinal,需要的朋友可以参考下
2023-03-03
Java面试题-实现复杂链表的复制代码分享
这篇文章主要介绍了Java面试题-实现复杂链表的复制代码分享，小编觉得还是挺不错的，具有参考价值，需要的朋友可以了解下。
2017-10-10