第二章：（2）使用配置文件

一、配置文件值注入

　　1、JavaBean

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}


public class Dog {

    private String name;
    private Integer age;
}

　　2、配置文件

　　　　yml 格式：

person:
#  lastName: hello
  last-name: 张三
  age: 18
  boss: false
  birth: 2017/12/12
  maps: {k1: v1,k2: 12}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    age: 12

　　　　properties 格式：

#配置person的值
person.last-name=张三
person.age=18
person.birth=2021/11/20
person.boss=false
person.maps.k1=v1
person.maps.k2=k2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=5

　　3、插件

　　　　我们可以导入配置文件处理器，以后编写配置就有提示了

        <!--导入配置文件处理器，配置文件进行绑定就会有提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

　　4、测试

/**
 * SpringBoot 单元测试
 * 可以在测试期间很方便的类似编码一样进行自动注入的功能
 *
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot02ConfigApplicationTests {

    @Autowired
    Person person;

    @Test
    public void contextLoads() {
        System.out.println(person);
    }

}

　　5、其他示例

　　　　                       

Pets{name='zhangsan \n', username='张三', age=18, pet={name=小狗, gender=male}, animal=[dog, cat, fish],
interests=[足球, 篮球], friends=[[zhangsan is my best friend, lisi
]], childs=[{age=18, name=xiaozhang}, {pets={1=b, 0=a}, name=xiaoli}, {age=18, name=lisi}]}

二、@Value获取值和@ConfigurationProperties获取值比较 

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

　　1、批量与单个注入

　　　　使用 @ConfigurationProperties 写在类上，可以将配置文件与实体类的属性完成一一的绑定；

　　　　使用 @Value 写在属性上，用于从环境变量、配置文件中获取值；

　　　　示例：

@Component
public class Person {
    @Value("${person.last-name}")
    private String lastName;
    @Value("#{11*2}")
    private Integer age;
    @Value("true")
    private Boolean boss;
}

　　2、松散语法

　　　　属性名匹配规则（Relaxed binding）

– person.firstName：使用标准方式
– person.first-name：大写用-
– person.first_name：大写用_
– PERSON_FIRST_NAME：推荐系统属性使用这种写法

　　　　@ConfigurationProperties 可以使用这种写法，配置文件值与属性满足这种规则即可。

　　　　    

　　　　@Value 不支持这种语法，必须配置文件key要与属性名称一致：

    @Value("${person.last-name}")  //不支持
    private String lastName;

　　3、SpEL 表达式

　　　　@ConfigurationProperties 不支持使用 SpEL 表达式，@Value 可以使用

    @Value("#{11*2}")
    private Integer age;

　　4、配置文件注入值数据校验

　　　　@ConfigurationProperties 支持 JSR303 进行配置文件值校验；@Value 注解不支持；

　　　　

 　　　　示例：

@Component
@ConfigurationProperties(prefix= "person")
@Validated
public class Person {

    @Email  //必须是邮箱格式
    private String lastName;
}

　　5、复杂类型

　　　　@ConfigurationProperties 支持对复杂类型的解析；@Value 注解不支持；

　　　　示例：

    @Value("${person.maps}")  //不支持
    private Map<String, Object> maps;

　　小结：配置文件yml还是properties他们都能获取到值

　　　　如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

　　　　如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

三、导入配置文件

　　1、@ConfigurationProperties：默认从全局配置文件获取值

　　　　该注解默认从全局配置文件中获取值；

　　　　可是如果把所有的配置信息都放在默认的配置，全局配置文件就会非常冗余；

　　2、@PropertySource：加载指定的配置文件

　　　　我们把上面的person信息抽取出来，放在 person.properties中，在配置类上使用该注解加载文件

@PropertySource(value = "classpath:person.properties") //从指定配置文件中加载属性
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {}

　　3、@ImportResource：导入 spring 的配置文件

　　　　@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

　　　　Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

　　　　想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上

　　　　编写 spring 的配置文件 beans.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="helloService" class="com.njf.service.HelloService"></bean>
</beans>

　　　　导入配置文件：

@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效

 

四、给容器中添加组件

　　SpringBoot推荐给容器中添加组件的方式：推荐使用全注解的方式

　　1、配置类 @Configuration ——> Spring 配置文件

　　2、使用 @Bean 给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

五、配置文件占位符

　　1、RandomValuePropertySource：配置文件中可以使用随机数

　　　　

　　2、属性配置占位符

　　　　　

　　　　可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）

　　　　${app.name:默认值} 来指定找不到属性时的默认值

　　　　占位符获取之前配置的值，如果没有可以是用 : 指定默认值

　　　　示例：

#配置person的值
#person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2021/11/20
person.boss=false
person.maps.k1=v1
person.maps.k2=k2
person.lists=a,b,c
person.dog.name=${person.last-name:hello}_dog
person.dog.age=5