二、Spring Boot - java配置应用

目标：
可以使用@Value获取配置文件配置项并结合@Bean注册组件到Spring
分析：

需求：
使用Java代码配置数据库连接池，并可以在处理器中注入并使用

步骤：

1. 添加依赖；
2. 创建数据库；
3. 创建数据库连接参数的配置文件jdbc.properties；
4. 创建配置类；
5. 改造处理器类注入数据源并使用

1. 尝试 java 配置

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

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

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

1. 在 pom.xml 文件中添加Druid连接池依赖如下

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

2. 使用数据操作工具创建数据库 springboot_test
3. 创建 jdbc.properties 文件

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

4. 编写 com\example\config\JdbcConfig.java 如下

package com.example.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.sql.DataSource;

@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.setDriverClassName(driverClassname);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

}

解读：

• @Configuration ：声明我们 JdbcConfig 是一个配置类
• @PropertySource ：指定属性文件的路径是: classpath:jdbc.properties
• 通过 @Value 为属性注入值
• 通过@Bean将 dataSource() 方法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值加入Spring容器中。

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

5. 在 HelloController 中注入DataSource进行测试，改造代码如下：

@RestController
public class HelloController {

    @Autowired
    private DataSource dataSource;

    @GetMapping("hello")
    public String hello() {
        System.out.println("DataSource = " + dataSource);
        return "Hello, Spring Boot!";
    }

}

6. 打断点，Debug运行并查看：
   

2. Spring Boot的属性注入

在上面的案例中，我们实验了java配置方式。不过属性注入使用的是@Value注解。这种方式虽然可行，但是不够强大，因为它只能注入基本类型值。
在Spring Boot中，提供了一种新的属性注入方式，支持各种java基本数据类型及复杂类型的注入。

目标：能够使用@ConfigurationProperties实现Spring Boot配置文件配置项读取和应用

分析：

需求：将配置文件中的配置项读取到一个对象中；

实现：可以使用Spring Boot提供的注解@ConfigurationProperties，该注解可以将Spring Boot的配置文件（默认必须为application.properties或application.yml）中的配置项读取到一个对象中。

实现步骤：

1. 创建配置项类JdbcProperties类，在该类名上面添加@ConfigurationProperties；
2. 将jdbc.properties修改名称为application.properties；
3. 将JdbcProperties对象注入到JdbcConfig；
4. 测试

注意：
属性文件的名称有变化，默认的文件名必须是：application.properties或application.yml

1）新建com\example\config\JdbcProperties.java

package com.example.config;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @ConfigurationProperties 从application配置文件中读取配置项
 * prefix表示 配置项的前缀
 * 配置项类中的类变量名必须要与 前缀之后的配置项名称保持 松散绑定（相同）
 */
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {

    private String url;
    private String driverClassName;
    private String username;
    private String password;

	//getter和setter方法
	...
}

• 在类上通过@ConfigurationProperties注解声明当前类为属性读取类
• prefix=“jdbc” 读取属性文件中，前缀为jdbc的值。
• 在类上定义各个属性，名称必须与属性文件中 jdbc. 后面部分一致
• 需要注意的是，这里我们并没有指定属性文件的地址，所以我们需要把jdbc.properties名称改为
  application.properties，这是Spring Boot默认读取的属性文件名：
  
  

2）将 JdbcConfig 类原来全部注释掉或删除，修改为如下内容：

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

• 通过 @EnableConfigurationProperties(JdbcProperties.class) 来声明要使用 JdbcProperties 这个类的
  对象
• 然后要使用配置的话；可以通过以下方式注入JdbcProperties：
• 
  3）测试结果；与前面的测试一样的。

与@Value对比关系：

优势：
Relaxed binding：松散绑定

• 不严格要求属性文件中的属性名与成员变量名一致。支持驼峰，中划线，下划线等等转换，甚至支持对象引导。比如：user.friend.name：代表的是user对象中的friend属性中的name属性，显然friend也是对象。@value注解就难以完成这样的注入方式。
• meta-data support：元数据支持，帮助IDE生成属性提示（写开源框架会用到）。

3. 更优雅的注入

事实上，如果一段属性只有一个Bean需要使用，我们无需将其注入到一个类（JdbcProperties，将该类上的所有注解去掉）中。而是直接在需要的地方声明即可；再次修改 JdbcConfig 类为如下代码：

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

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

4. Yaml配置文件

配置文件除了可以使用application.properties类型，还可以使用后缀名为：.yml或者.yaml的类型，也就是：
application.yml或者application.yaml

基本格式：

jdbc: 
	driverClassName: com.mysql.jdbc.Driver 
	url: jdbc:mysql://localhost:3306/springboot_test
	username: root 
	password: root

目标：可以将多个yml文件在application.yml文件中配置激活

分析：

yaml与properties配置文件除了展示形式不相同以外，其它功能和作用都是一样的；在项目中原路的读取方式不需要改变。

1）yml配置文件的特征：

1. 树状层级结构展示配置项；
2. 配置项之间如果有关系的话需要分行空两格；
3. 配置项如果有值的话，那么需要在 :之后空一格再写配置项值；

将application.properties配置文件修改为application.yml的话：

jdbc:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1:3306/heima
  username: root
  password: root
​
key:
  abc: cba
  def:
    - g
    - h
    - j

2）多个yml配置文件；在spring boot中是被允许的。这些配置文件的名称必须为application-***.yml，并且这些配置文件必须要在application.yml配置文件中激活之后才可以使用。

3）如果properties和yml配置文件同时存在在spring boot项目中；那么这两类配置文件都有效。在两个配置文件中如果存在同名的配置项的话会以properties文件的为主。

5. 多个Yaml配置文件

当一个项目中有多个yml配置文件的时候，可以以application-**.yml命名；在application.yml中配置项目使用激活这些配置文件即可。

创建 application-abc.yml 文件如下：

liuxiaohan:
  url: http://www.lxh.cn

创建 application-def.yml 文件如下：

lxh:
  url: http://www.lxh.cn

在 application.yml 文件中添加如下配置：

#激活配置文件：需要指定其它的配置文件名称
spring:
  profiles:
    active: abc,def

多个文件名只需要写application-之后的名称，在多个文件之间使用 , 隔开。

修改代码测试：