之前翻译了一篇不怎么样的文章,主要是翻译的水平有限,自己翻译的云里雾里,发现平时只会有@ConfigurationProperties注解,对SpringBoot强大的属性绑定知之甚少,所以以那篇文章为线索,重新学习了一遍。

@ConfigurationProperties

在使用的时候,我们往往只关心两件事,属性怎么绑定,即属性文件中的值和配置类中字段的映射关系;其次是类实例化的时机。故而衍生开来ConfigurationProperties有三种用法。

@Component + @ConfigurationProperties

这种用法最简单,直接在POJO类上加上注解即可,Spring容器初始化时就会生成配置类实例了。适合POJO类是自定义的。

  1. @Component
  2. @ConfigurationProperties(prefix = "kaka.cream.mail-a",ignoreUnknownFields = false)
  3. public class MailPropertiesA {
  4. private String name;
  5. private String sex;
  6. private Integer age;

@Bean + @ConfigurationProperties

在配置类中进行装配,这两个注解均出现在Configuration中,对POJO无侵入,使用灵活,且集中(均在配置类中处理)

  1. @Bean
  2. @ConfigurationProperties(prefix = "kaka.cream.mail-b",ignoreUnknownFields = false)
  3. public MailPropertiesB mailPropertiesB(){
  4. MailPropertiesB b = new MailPropertiesB();
  5. return b;
  6. }

@EnableConfigurationProperties + @ConfigurationProperties

Pojo类上注解@ConfigurationProperties,在启动类上注解@EnableConfigurationProperties

  1. @Data
  2. @ConfigurationProperties(prefix = "kaka.cream.mail-c",ignoreUnknownFields = false)
  3. public class MailPropertiesC {
  4. private String name;
  5. private String sex;
  6. private Integer age;
  7. }
  8. @EnableConfigurationProperties(MailPropertiesC.class)
  9. public class GomvcApplicationTests {
  10. ...
  11. }

可以在启动类上一目了然的看到启动的配置,且不需要配置类,对第三方使用者比较友好,但是灵活性上没有第二种好。在这三种里面,推荐使用第二种方式。

Environment

存在于spring boot首个版本的元老类,它继承自PropertyResolver,通过它,我们能知道激活的配置文件,以及获取对应参数的值,结合上面第二种在配置类中一起用。较常用的主要有

  1. //判断是否包含键值
  2. boolean containsProperty(String key);
  3. //获取属性值,如果获取不到返回null
  4. String getProperty(String key);
  5. //获取属性值,如果获取不到返回缺省值
  6. String getProperty(String key, String defaultValue);
  7. //获取属性对象
  8. <T> T getProperty(String key, Class<T> targetType);

其中最后一个转换是和Converter有关的,会依据sourceType和targetType查找转换器,这个打算下一个章节进行分析,不在这里展开。所以Environment适合简单属性值的获取,不知何复杂对象的绑定。

Binder

Binder是在Spring Boot2新引入的API,从字面就可以看出来,“主打”绑定,可以非常方便的进行类型转化,以及提供回调方法介入绑定的各个阶段进行深度定制,结合上面第二种在配置类中一起用其主要的类有Binder, BindResult和BindHandler。比Environment好用很多,必备好类。

  1. //绑定对象
  2. MailPropertiesC propertiesC = Binder.get(environment).bind("kaka.cream.mail-c", Bindable.of(MailPropertiesC.class)).get();
  3. //绑定Map
  4. Map<String,Object> propMap = Binder.get(environment).bind("fish.jdbc.datasource",Bindable.mapOf(String.class, Object.class)).get();
  5. //绑定列表
  6. List<String> list = Binder.get(environment).bind("kaka.cream.list",Bindable.listOf(String.class)).get();
  7. //转换以及默认值
  8. String datestr = (String) Binder.get(environment).bind("kaka.cream.date",Bindable.of(String.class))
  9. .map(String::toUpperCase)
  10. /** .map(new Function(){
  11. @Override
  12. public Object apply(Object o) {
  13. String str = (String)o;
  14. return str.toUpperCase();
  15. }
  16. })**/
  17. .orElse("bad date string");
  18. //绑定过程回调函数,高度定制
  19. LocalDate str = Binder.get(environment).bind("kaka.cream.date", Bindable.of(LocalDate.class), new BindHandler() {
  20. @Override
  21. public <T> Bindable<T> onStart(ConfigurationPropertyName name, Bindable<T> target,
  22. BindContext context) {
  23. log.info("绑定开始{}",name);
  24. return target;
  25. }
  26. @Override
  27. public Object onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) {
  28. log.info("绑定成功{}",target.getValue());
  29. return result;
  30. }
  31. @Override
  32. public Object onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) throws Exception {
  33. log.info("绑定失败{}",name);
  34. return "没有找到匹配的属性";
  35. }
  36. @Override
  37. public void onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) throws Exception {
  38. log.info("绑定结束{}",name);
  39. }
  40. }).get();