【Springboot】注解@ConfigurationProperties让配置整齐而简单

1 简介

前面我们用一篇文章《【Spring】只想用一篇文章记录@Value的使用，不想再找其它了(附思维导图)》

详细讲解了在Spring中如何使用@Value来实现我们对配置的需求，它功能强大、使用方便。但它也是有它的局限性的，比如对于邮件服务，我们配置有：

mail.hostname=smtp.qq.com
[email protected]
mail.password=123456
[email protected]
[email protected]

使用@Value，我们需要5个注解及5个独立的变量：

@Value("${mail.hostname}")
private String hostname;
@Value("${mail.username}")
private String username;
@Value("${mail.password}")
private String password;
@Value("${mail.to}")
private List<String> to;
@Value("${mail.cc}")
private List<String> cc;

这样非常不方便，容易出错，较难维护，不好传递。如果能把相同功能的配置组合起来，那配置就不会这么乱了。而Springboot为我们提供了注解@ConfigurationProperties完美解决了这个问题。现在我们来深入了解一下这个注解的强大之处。

2 启动注解的三种方式

启动@ConfigurationProperties有三种方式，分别是：

（1）属性类@ConfigurationProperties 属性类@Component

@Component
@ConfigurationProperties(prefix = "pkslow")
public class PkslowProperties {
    private String name;
    private List<String> emails;
    private Map<String, Integer> price;
  //getter and setter
}

在属性配置类上加注解@ConfigurationProperties是三种方式都需要的，第一种方式通过@Component声明为一个可用的Bean。实际不一定是@Component，@Service等也是可以的。

（2）属性类@ConfigurationProperties 配置类@Bean

在配置类中通过@Bean声明：

@Configuration
public class Config {
    @Bean
    public PkslowProperties pkslowProperties(){
        return new PkslowProperties();
    }
}

（3）属性类@ConfigurationProperties 配置类@EnableConfigurationProperties

我们可以在Springboot启动类中加上注解@EnableConfigurationProperties来声明：

@SpringBootApplication
@EnableConfigurationProperties(PkslowProperties.class)
public class ConfigurationPropertiesDemoApplication {
	public static void main(String[] args) {
		SpringApplication.run(ConfigurationPropertiesDemoApplication.class, args);
	}
}

3 两大优点

3.1 宽松的绑定规则

支持宽松的绑定规则，以下格式都可以识别为accountType属性：

pkslow.accountType=QQ
pkslow.accounttype=QQ
pkslow.account_type=QQ
pkslow.account-type=QQ
pkslow.ACCOUNT_TYPE=QQ

3.2 支持多种属性类型

支持多种属性类型，Java类如下：

@Component
@ConfigurationProperties(prefix = "pkslow")
@Data
public class PkslowProperties {
    private String name;
    private List<String> emails;
    private Map<String, Integer> price;
    private Account mainAccount;
    private List<Account> emailAccounts;
    private Map<String, Account> friendAccounts;
    private Duration activeTime;
    private DataSize appFileSize;
}

配置如下：

#普通类型
pkslow.name=Larry
#List
pkslow.emails[0][email protected]
pkslow.emails[1][email protected]
#Map
pkslow.price.shoe=200
pkslow.price.pen=10
pkslow.price.book=43
#Object
pkslow.mainAccount.username=larry
pkslow.mainAccount.password=123456
pkslow.mainAccount.accountType=Main
#List