前言

最近在思考使用java config的方式进行配置,java config是指基于java配置的spring。传统的Spring一般都是基本xml配置的,后来spring3.0新增了许多java config的注解,特别是spring boot,基本都是清一色的java config。

Spring配置方式

第一阶段:xml配置

在spring 1.x时代,使用spring开发满眼都是xml配置的bean,随着项目的扩大,
我们需要把xml配置文件分放到不同的配置文件中,那时候需要频繁地在开发的类和配置文件间切换。

第二阶段:注解配置

在spring 2.x时代,随着JDK1.5带来的注解支持,spring提供了声明bean的注解,
大大减少了配置量。这时spring圈子存在一种争论:注解配置和xml配置究竟哪个更好?我们最终的选择是应用
的基本配置用xml,业务配置用户注解。

第三阶段:Java配置(java config)

从spring 3.x到现在,spring提供了Java配置的能力,使用Java配置更好的理解
配置的bean。spring 4.x和spring boot都推荐使用Java配置。

Spring IOC有一个非常核心的概念——Bean。由Spring容器来负责对Bean的实例化,装配和管理。XML是用来描述Bean最为流行的配置方式。但随着Spring的日益发展,越来越多的人对Spring提出了批评。“Spring项目大量的烂用XML”就是最为严励的一个批评。由于Spring会把几乎所有的业务类都以Bean的形式配置在XML文件中,造成了大量的XML文件。使用XML来配置Bean失去了编译时的类型安全检查。大量的XML配置使得整个项目变得更加复杂。

随着JAVA EE 5.0的发布,其中引入了一个非常重要的特性——Annotations(注释)。注释是源代码的标签,这些标签可以在源代码层进行处理或通过编译器把它熔入到class文件中。在JAVA EE5以后的版本中,注释成为了一个主要的配置选项。Spring使用注释来描述Bean的配置与采用XML相比,因类注释是在一个类源代码中,可以获得类型安全检查的好处。可以良好的支持重构。

JavaConfig就是使用注释来描述Bean配置的组件。JavaConfig 是Spring的一个子项目, 比起Spring,它还是一个非常年青的项目。目前的版本是1.0 M2。使用XML来配置Bean所能实现的功能,通过JavaConfig同样可以很好的实现。

下面具体讲一讲@ConfigurationProperties使用方法

@ConfigurationProperties

Spring源码中大量使用了ConfigurationProperties注解,比如server.port就是由该注解获取到的,通过与其他注解配合使用,能够实现Bean的按需配置。

该注解有一个prefix属性,通过指定的前缀,绑定配置文件中的配置,该注解可以放在类上,也可以放在方法上

@ConfigurationProperties使用方法 - 图1

可以从注解说明中看到,当将该注解作用于方法上时,如果想要有效的绑定配置,那么该方法需要有@Bean注解且所属Class需要有@Configuration注解。

简单一句话概括就是:Sring的有效运行是通过上下文(Bean容器)中Bean的配合完成的,Bean可以简单理解成对象,有些对象需要指定字段内容,那么这些内容我们可以通过配置文件进行绑定,然后将此Bean归还给容器

作用于方法

比较常见的就是配置读写分离的场景。

配置文件内容

  1. Copy#数据源
  2. spring.datasource.druid.write.url=jdbc:mysql://localhost:3306/jpa
  3. spring.datasource.druid.write.username=root
  4. spring.datasource.druid.write.password=1
  5. spring.datasource.druid.write.driver-class-name=com.mysql.jdbc.Driver
  6. spring.datasource.druid.read.url=jdbc:mysql://localhost:3306/jpa
  7. spring.datasource.druid.read.username=root
  8. spring.datasource.druid.read.password=1
  9. spring.datasource.druid.read.driver-class-name=com.mysql.jdbc.Driver

java代码

  1. @Configuration
  2. public class DruidDataSourceConfig {
  3. /**
  4. * DataSource 配置
  5. * @return
  6. */
  7. @ConfigurationProperties(prefix = "spring.datasource.druid.read")
  8. @Bean(name = "readDruidDataSource")
  9. public DataSource readDruidDataSource() {
  10. return new DruidDataSource();
  11. }
  12. /**
  13. * DataSource 配置
  14. * @return
  15. */
  16. @ConfigurationProperties(prefix = "spring.datasource.druid.write")
  17. @Bean(name = "writeDruidDataSource")
  18. @Primary
  19. public DataSource writeDruidDataSource() {
  20. return new DruidDataSource();
  21. }
  22. }

也许有的人看到这里会比较疑惑,prefix并没有指定配置的全限定名,那它是怎么进行配置绑定的呢?

相信大家肯定了解@Value注解,它可以通过全限定名进行配置的绑定,这里的ConfigurationProperties其实就类似于使用多个@Value同时绑定,绑定的对象就是DataSource类型的对象,而且是 隐式绑定 的,意味着在配置文件编写的时候需要与对应类的字段名称 相同,比如上述spring.datasource.druid.write.url=jdbc:mysql://localhost:3306/jpa ,当然了,你也可以随便写个配置,比如 spring.datasource.druid.write.uuu=www.baidu.com,此时你只需要在注解中加上以下参数即可

@ConfigurationProperties使用方法 - 图2

以上就完成了多个数据源的配置,为读写分离做了铺垫

作用于Class类及其用法

配置文件内容

  1. Copyspring.datasource.url=jdbc:mysql://127.0.0.1:8888/test?useUnicode=false&autoReconnect=true&characterEncoding=utf-8
  2. spring.datasource.username=root
  3. spring.datasource.password=root
  4. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
  5. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

java代码

  1. @ConfigurationProperties(prefix = "spring.datasource")
  2. @Component
  3. public class DatasourcePro {
  4. private String url;
  5. private String username;
  6. private String password;
  7. // 配置文件中是driver-class-name, 转驼峰命名便可以绑定成
  8. private String driverClassName;
  9. private String type;
  10. public String getUrl() {
  11. return url;
  12. }
  13. public void setUrl(String url) {
  14. this.url = url;
  15. }
  16. public String getUsername() {
  17. return username;
  18. }
  19. public void setUsername(String username) {
  20. this.username = username;
  21. }
  22. public String getPassword() {
  23. return password;
  24. }
  25. public void setPassword(String password) {
  26. this.password = password;
  27. }
  28. public String getDriverClassName() {
  29. return driverClassName;
  30. }
  31. public void setDriverClassName(String driverClassName) {
  32. this.driverClassName = driverClassName;
  33. }
  34. public String getType() {
  35. return type;
  36. }
  37. public void setType(String type) {
  38. this.type = type;
  39. }
  40. }

用法

  1. @Controller
  2. @RequestMapping(value = "/config")
  3. public class ConfigurationPropertiesController {
  4. @Autowired
  5. private DatasourcePro datasourcePro;
  6. @RequestMapping("/test")
  7. @ResponseBody
  8. public Map<String, Object> test(){
  9. Map<String, Object> map = new HashMap<>();
  10. map.put("url", datasourcePro.getUrl());
  11. map.put("userName", datasourcePro.getUsername());
  12. map.put("password", datasourcePro.getPassword());
  13. map.put("className", datasourcePro.getDriverClassName());
  14. map.put("type", datasourcePro.getType());
  15. return map;
  16. }
  17. }

总结

  1. @ConfigurationProperties 和 @value 有着相同的功能,但是 @ConfigurationProperties的写法更为方便
  2. @ConfigurationProperties 的 POJO类的命名比较严格,因为它必须和prefix的后缀名要一致, 不然值会绑定不上, 特殊的后缀名是“driver-class-name”这种带横杠的情况,在POJO里面的命名规则是下划线转驼峰 就可以绑定成功,所以就是 “driverClassName”