SpringBoot---(8) SpringBoot配置文件

SpringBoot配置文件

1、配置文件

• SpringBoot使用一个全局的配置文件，配置文件名是固定的：
• application.properties
• application.yml

作用：
修改SpringBoot自动配置文件的默认值，因为SpringBoot在底层都已经给我们自动配置好了

2、yaml语法

• yml 是一种 yaml 格式的配置文件，主要采用一定的空格、换行等格式排版进行配置。
• K:(空格)v ：表示一对键值对（空格必须有的）；用缩进来控制层级关系的，只要是左对齐的一列数据都是同一层级关系的。
  

注意：当两种格式配置文件同时存在，使用的是.properties 配置文件，为了演示 yml，可以 先将其改名，重新运行 Application，查看启动的端口及上下文根

值的写法

1、 字面量：普通的值(数字，字符串，布尔值)

k: v ：字面直接来写

• 字符串默认不用加上单引号或者双引号
• “”：不会转义字符串里面的特殊字符
  Name:”zhangs \n lisi” 输出：zhangs 换行 lisi
• ‘ ’：不会转义字符串里面的特殊字符
  Name:’zhangs \n lisi’ 输出：zhangs \n lisi

2、对象、Map：

• k: v ：在下一行来写对象的属性和值的关系，注意缩进

person:
  lastName: zs
  age: 15
  boss: false
  birth: 2021/5/1

行内写法：

maps: {k1: v1,k2: v2}

3、数组(List、Set)：

• k: v ：用值表示数组中的一个元素

lists:
  - lisi
  - hcz

3、配置文件值的注入

• 配置文件yml和properties格式：

person:
  lastName: zs
  age: 15
  boss: false
  birth: 2021/5/1
  maps: {k1: v1,k2: 33}
  lists:
    - lisi
    - hcz
  dog:
    name: 小狗
    age: 2

person.last-name=张三
person.age=24
person.birth=1999/12/4
person.boss=true
person.maps.k1=v2
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=3

• 实体类对象：
• 第一种方法@ConfigurationProperties

在该类加上@Component 和 @ConfigurationProperties 注解，并在 @ConfigurationProperties 注解中添加属性 prefix， 作用可以区分同名配置

/**
 * 将配置文件中配置的每一个属性的值映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和
 * 配置文件中相关配置进行绑定
 * prefix：配置文件中哪个对象下的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能提供@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;

• 第二种方法@Value 注解（不推荐使用）

@Component
//第一种方法
//@ConfigurationProperties(prefix = "person")
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="值"></property>
     *</bean>
     */

    //第二种方法
    @Value("${person.last-name}")
    private String lastName;
    @Value("${person.age}")
    private Integer age;
    @Value("${person.boss}")
    private Boolean boss;
    @Value("${person.birth}")
    private Date birth;

• 测试：使用@Autowired注解注入配置类

@RunWith(SpringRunner.class)
@SpringBootTest
class ApplicationTests {
    @Autowired
    Person person;

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

（1）@Value获取值和@ConfigurationProperties获取值的区别

总结：

• （1）如果只是在某一个业务逻辑中需要获取一下配置文件中的某一项值，使用@Value。例如：

@Controller
public class IndexController {

    @Value("${person.last-name}")
    private String name;
    
    @RequestMapping(value = "/say")
    @ResponseBody
    public Object say(){
        return "Say:hello"+name;
    }
}

• （2）如果是专门编写了一个实体类来和配置文件进行映射，这时就需要用@ConfigurationProperties，例如上面实体类对象获取值的第一种方法。

（2）配置文件注入数据校验

@Component
//第一种方法
@ConfigurationProperties(prefix = "person")
//第一种方法支持-数据校验
@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="值"></property>
     *</bean>
     */

    //第二种方法
    //@Value("${person.last-name}")
    @Email
    private String lastName;
    //@Value("${person.age}")
    private Integer age;
    //@Value("${person.boss}")
    private Boolean boss;
    //@Value("${person.birth}")
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;

    private Dog dog;

（3）@PropertySource和@ImportResource注解

1、@PropertySource：加载指定properties配置文件，不支持yaml文件

/**
 * 将配置文件中配置的每一个属性的值映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和
 * 配置文件中相关配置进行绑定,
 * 但是它默认从全局配置中获取值
 *
 * prefix：配置文件中哪个对象下的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能提供@ConfigurationProperties功能
 *
 */
//获取指定配置文件中的值
@PropertySource(value = {"classpath:person.properties"})
@Component
//第一种方法
@ConfigurationProperties(prefix = "person")
//第一种方法支持-数据校验
//@Validated

public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="值"></property>
     *</bean>
     */

    //第二种方法
    //@Value("${person.last-name}")
    //@Email
    private String lastName;
    //@Value("${person.age}")
    private Integer age;
    //@Value("${person.boss}")
    private Boolean boss;
    //@Value("${person.birth}")
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;

    private Dog dog;

注意：

• 如果properties和yml文件也同时存在，则执行的顺序为properties > yml >指定配置文件

2、@ImportResource：（SpringBoot不推荐该方法）

• 导入Spring的xml配置文件，让配置文件中的内容生效
• SpringBoot里面没有Spring配置文件，如果我们自己编写则不会识别；这时如果想让该配置文件加载进来，则@ImportResource标注在主配置类上即可。
• Spring配置文件：

<?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="indexService" class="com.hcz.services.IndexService"/>
</beans>

• 主配置类：

/**
 * SpringBoot项目启动入口类
 */
//加载Springing配置文件
@ImportResource(locations = {"classpath:spring.xml"})
//SpringBoot核心注解，主要用于开启spring自动配置
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        //让Spring应用启动起来
        SpringApplication.run(Application.class, args);
    }
}

• 测试类中的测试方法：

@Autowired
ApplicationContext ioc;

@Test
public void testIndexService(){
    //查看容器中是否有indexService这个对象
    boolean indexService = ioc.containsBean("indexService");
    System.out.println(indexService);
}

3、@Configuration：Spring推荐给容器中添加组件的方式

• 使用配置类@Configuration代替Spring配置文件；使用@Bean给容器中添加组件，例如：

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

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

4、配置文件占位符

（1）随机数

${random.int}${random.uuid}${random.value}......

（2）占位符获取之前配置的值，如果没有可以用“指定默认值”

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=1999/12/4
person.boss=true
person.maps.k1=v2
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hellow:hellow}_dog
person.dog.age=3

5、Profile配置

（1）多环境配置

• 在实际开发的过程中，我们的项目会经历很多的阶段（开发->测试->上线），每个阶段 的配置也会不同，例如：端口、上下文根、数据库等，那么这个时候为了方便在不同的环境 之间切换，SpringBoot 提供了多环境配置，文件名命名规则为：application-{profile}.properties/yml
• 但是默认使用application.properties的配置文件。
  

（2）激活指定profile

1、在总配置文件 application.properties 进行环境的激活

#激活开发环境
#spring.profiles.active=dev

#激活测试环境
#spring.profiles.active=test

#激活生产环境 
spring.profiles.active=product

等号右边的值和配置文件的环境标识名一致，可以更改总配置文件的配置

2、命令行参数指定环境

• 其优先级高于配置文件中指定环境的方法
  

3、虚拟机参数指定环境

• 其优先级高于配置文件中指定环境的方法