SpringBoot 学习笔记3

Java配置

在入门案例中，我们没有任何的配置，就可以实现一个SpringMVC的项目了，快速、高效！

如果没有任何的xml，那么我们如果要配置一个Bean该怎么办？比如我们要配置一个数据库连接池，以前会这么玩：

<!-- 配置连接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
      init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />
</bean>

现在该怎么做呢？

回顾历史

• Spring1.0时代

  在此时因为jdk1.5刚刚出来，注解开发并未盛行，因此一切Spring配置都是xml格式，想象一下所有的bean都用xml配置，细思极恐啊，心疼那个时候的程序员2秒

  
  

• Spring2.0时代

  Spring引入了注解开发，但是因为并不完善，因此并未完全替代xml，此时的程序员往往是把xml与注解进行结合，貌似我们之前都是这种方式。

  
  

• Spring3.0及以后

  3.0以后Spring的注解已经非常完善了，因此Spring推荐大家使用完全的java配置来代替以前的xml，不过似乎在国内并未推广盛行。然后当SpringBoot来临，人们才慢慢认识到java配置的优雅。

尝试java配置

java配置主要靠java类和一些注解，比较常用的注解有：

• @Configuration：声明一个类作为配置类，代替xml文件
• @Bean：声明在方法上，将方法的返回值加入Bean容器，代替<bean>标签
• @value：属性注入
• @PropertySource：指定外部属性文件

接下来用java配置来尝试实现连接池配置：

首先引入Druid连接池依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.6</version>
</dependency>

创建一个jdbc.properties文件，编写jdbc属性：

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/leyou
jdbc.username=root
jdbc.password=123

然后编写代码：

@Configuration
@PropertySource("classpath:jdbc.properties")
public class JdbcConfig {

    @Value("${jdbc.url}")
    String url;
    @Value("${jdbc.driverClassName}")
    String driverClassName;
    @Value("${jdbc.username}")
    String username;
    @Value("${jdbc.password}")
    String password;

    @Bean
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(url);
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

解读：

• @Configuration：声明我们JdbcConfig是一个配置类

• @PropertySource：指定属性文件的路径是:classpath:jdbc.properties

• 通过@Value为属性注入值

• 通过@Bean将 dataSource()方法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值加入Spring容器中。

  
  

然后我们就可以在任意位置通过@Autowired注入DataSource了！

我们在HelloController中测试：

@RestController
public class HelloController {

    @Autowired
    private DataSource dataSource;

    @GetMapping("hello")
    public String hello() {
        return "hello, spring boot!" + dataSource;
    }
}

然后Debug运行并查看：

属性注入成功了！

SpringBoot的属性注入

在上面的案例中，我们实验了java配置方式。不过属性注入使用的是@Value注解。这种方式虽然可行，但是不够强大，因为它只能注入基本类型值。

在SpringBoot中，提供了一种新的属性注入方式，支持各种java基本数据类型及复杂类型的注入。

1. 我们新建一个类，用来进行属性注入：

   @ConfigurationProperties(prefix = "jdbc")
   @Data
   public class JdbcProperties {
       private String url;
       private String driverClassName;
       private String username;
       private String password;
   }
   

   
   
   • 在类上通过 @ConfigurationProperties 注解声明当前类为属性读取类
   • prefix="jdbc"读取属性文件中，前缀为jdbc的值。
   • 在类上定义各个属性，名称必须与属性文件中jdbc.后面部分一致
   
   

2. 把上例中的 jdbc.properties 名称改为 application.properties，这是SpringBoot默认读取的属性文件名：

   
   

3. 在JdbcConfig中使用这个属性：

   @Configuration
   @EnableConfigurationProperties(JdbcProperties.class)
   public class JdbcConfig {
   
       @Bean
       public DataSource dataSource(JdbcProperties jdbc) {
           DruidDataSource dataSource = new DruidDataSource();
           dataSource.setUrl(jdbc.getUrl());
           dataSource.setDriverClassName(jdbc.getDriverClassName());
           dataSource.setUsername(jdbc.getUsername());
           dataSource.setPassword(jdbc.getPassword());
           return dataSource;
       }
   }
   

   
   

   • 通过@EnableConfigurationProperties(JdbcProperties.class)来声明要用JdbcProperties这个类的对象

   • 然后可以通过以下方式注入JdbcProperties：

     1. @Autowired注入

        @Autowired
        private JdbcProperties prop;
        

        
        

     2. 构造函数注入

        private JdbcProperties prop;
        public JdbcConfig(Jdbcproperties prop){
            this.prop = prop;
        }
        

        
        

     3. 声明有@Bean的方法参数注入

        @Bean
        public Datasource dataSource(JdbcProperties prop){
            // ...
        }
        

     这里采用第三种方式进行注入。

   
   

4. 测试结果：

   
   

5. 大家会觉得这种方式似乎更麻烦了，事实上这种方式有更强大的功能，也是SpringBoot推荐的注入方式。两者对比关系：

   
   

   优势：

   • Relaxed binding：松散绑定

     不严格要求属性文件中的属性名与成员变量名一致。支持驼峰，中划线，下划线等等转换，甚至支持对象引导。比如：user.friend.name：代表的是 user 对象中的 friend 属性中的 name 属性，显然 friend 也是对象。 @value 注解就难以完成这样的注入方式。

     
     

   • meta-data support：元数据支持，帮助IDE生成属性提示（写开源框架会用到）。

更优雅的注入

事实上，如果一段属性只有一个Bean需要使用，我们无需将其注入到一个类（JdbcProperties）中。而是直接在需要的地方声明即可：

@Configuration
public class JdbcConfig {
    
    @Bean
    // 声明要注入的属性前缀，SpringBoot会自动把相关属性通过set方法注入到DataSource中
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}

我们直接把@ConfigurationProperties(prefix = "jdbc")声明在需要使用的@Bean的方法上，然后SpringBoot就会自动调用这个Bean（此处是DataSource）的set方法，然后完成注入。使用的前提是：该类必须有对应属性的set方法！

再次测试：