首页 > 软件编程 > java > @ConfigurationProperties详解

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