02_SpringBoot_配置

[TOC]

配置文件

Spring Boot 使用一个全局的配置文件，配置文件名是固定的：

• application.properties

  server.port=8081

• application.yml or application.yaml

  server:
    port: 8081

配置文件的作用：修改 Spring Boot 自动配置的默认值；Spring Boot 在底层都给我们自动配置好；

YAML

YML 文件格式是 YAML (YAML Aint Markup Language) 编写的文件格式，YAML 是一种直观的能够被电脑识别的的数据数据序列化格式，并且容易被人类阅读，容易和脚本语言交互的，可以被支持 YAML 库的不同的编程语言程序导入，比如：C/C++, Ruby, Python, Java, Perl, C#, PHP 等。YML 文件是以数据为核心的，比传统的 XML 方式更加简洁。

YML 文件的扩展名可以使用 .yml 或者 .yaml。

• YAML（YAML Ain't Markup Language）

  • YAML A Markup Language：是一个标记语言

  • YAML isn't Markup Language：不是一个标记语言；

• 标记语言：

  • 以前的配置文件；大多都使用的是 xxxx.xml文件；

  • YAML：以数据为中心，比json、xml等更适合做配置文件；

• e.g.

  • Yaml

  server:
    port: 8081

• XML

  <server>
  <port>8081</port>
  </server>

YAML语法

Spring Boot使用 snakeyaml 解析yml文件

参考语法规范

参考语法

yaml语法校验

基本语法

k:(空格)v表示一对键值对（空格必须有）;

以 空格 的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的。属性和值也是大小写敏感；次等级的前面是空格，不能使用制表符(tab)；冒号之后如果有值，那么冒号和值之间至少有一个空格，不能紧贴着

值的写法

字面量：普通的值（数字，字符串，布尔）

k: v

字符串默认不用加上单引号或者双引号；

""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

eg： name: "zhangsan \n lisi"：输出；zhangsan 换行 lisi

''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

eg： name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

对象、Map（属性和值）

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

1. person:
     name: 张三
     gender: 男
     age: 22

2. 行内写法

   person: {name: 张三,gender: 男,age: 22}

数组（List、Set）

1. fruits: 
     - 苹果
     - 桃子
     - 香蕉

2. 行内写法

   fruits: [苹果,桃子,香蕉]

配置文件值注入

配置文件

person:
  name: 张三
  last-name: 张三
  lastName: 张三
# 以上两种写法均表示统一值
  gender: 男
  age: 36
  boss: true
  birth: 1982/10/1
  maps: {k1: v1,k2: v2}
  lists:
    - apple
    - peach
    - banana
  pet:
    name: 小狗
    age: 12

Waring

配置文件处理器依赖，导入配置文件处理器，以后编写配置就有提示

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

JavaBean

JavaBean：

public class Pet {
  private String name;
  private Integer age;

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public Integer getAge() {
    return age;
  }

  public void setAge(Integer age) {
    this.age = age;
  }

  @Override
  public String toString() {
    return "Pets{" +
      "name='" + name + '\'' +
      ", age=" + age +
      '}';
  }
}

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 *
 * ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 * @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Character gender;
    private Integer age;
    private boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Pet pet;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Character getGender() {
        return gender;
    }

    public void setGender(Character gender) {
        this.gender = gender;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public boolean isBoss() {
        return boss;
    }

    public void setBoss(boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Pet getPet() {
        return pet;
    }

    public void setPet(Pet pet) {
        this.pet = pet;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", gender=" + gender +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", pet=" + pet +
                '}';
    }
}

测试

package cn.clboy.helloworldquickstart;

import cn.clboy.helloworldquickstart.model.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

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

    @Autowired
    private Person person;

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

Properties 写法

上面yaml对应的properties配置文件写法

# idea properties 默认使用 utf-8
person.name=李四
person.age=34
person.birth=1986/09/12
person.boss=true
person.gender=女
person.lists=cat,dog,pig
person.maps.k1=v1
person.maps.k2=v2
person.pet.name="小黑"
person.pet.age=10

测试，发现中文会乱码，而且char类型还会抛出Failed to bind properties under 'person.gender' to java.lang.Character异常

中文乱码解决方法

在设置中找到File Encodings，将配置文件字符集改为UTF-8，并勾选：

• Transparent native-to-ascii conversion

yaml和properties配置文件同时存在，properties配置文件的内容会覆盖yaml配置文件的内容

Annotation 写法

@Component
// @ConfigurationProperties(prefix = "person")
public class Person {
  /**
   * <bean class="Person">
   *         <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
   * </bean>
   */
  @Value("${person.last-name}")
  private String name;
  @Value(11*2)
  private Character gender;
  @Value("true")
  private Integer age;
  private boolean boss;
  private Date birth;
  private Map<String,Object> maps;
  private List<Object> lists;
  private Pet pet;
}

<bean class="Person">
  <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
</bean>

配置文件值注入两种方式对比

• @Value和@ConfigurationProperties为属性注值对比

  • 配置文件值注入有两种方式，一个是Spring Boot的@ConfigurationProperties注解，另一个是spring原先的@value注解

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

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

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

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

松散绑定：例如Person中有lastName属性，在配置文件中可以写成

lastName或lastname或last-name或last_name等等

• 属性名匹配规则（Relaxed binding）

  • person.firstName：使用标准方式

  • person.first-name：大写用-

  • person.firstname：大写用``

  • PERSON_FIRST_NAME

    • 推荐系统属性使用这种写法

• @ConfigurationProperties

  • 与@Bean结合为属性赋值

  • 与@PropertySource（只能用于properties文件）结合读取指定文件

  • 默认从全局配置文件中获取值

• @PropertySource & @ImportResource

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

    @PropertySource(value = {"classpath:person.properties"})

    @PropertySource注解的作用是加载指定的配置文件，值可以是数组，也就是可以加载多个配置文件

    springboot默认加载的配置文件名是application，如果配置文件名不是这个是不会被容器加载的，所以这里Person并没有被注入任何属性值

    使用@PropertySource({"classpath:person.properties"})指定加载person.properties配置文件

    使用这个注解加载配置文件就需要配置类使用@component等注解而不是等待@EnableConfigurationProperties激活m，而且不支持yaml，只能是properties

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

    @ImportResource注解用于导入Spring的配置文件，让配置文件里面的内容生效；(就是以前写的springmvc.xml、applicationContext.xml)

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

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

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

      注意！这个注解是放在主入口函数的类上，而不是测试类上

    • 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"
             xmlns:schemaLocation="http://www.springframework.org/schema/beans">
          <!--       xmlns:schemaLocation="http://www.springframework.org/schema/beans"-->
          <!--       xmlns:schemaLocation="http://www.springframework.org/schema/beans/spring-beans.xsd">-->
      
          <bean id="user" class="com.kevinkda.test.domain.User"></bean>
      </beans>

    • SpringBoot 推荐的全注解形式

      • @Configuration

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

        配置类@Configuration ---equals---> Spring配置文件

      • @Bean：使用@Bean给容器中添加组件

      • 配置类 ---- Spring 配置文件

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

      package com.kevinkda.springboot.demo.config;
      /**
       * Configuration：指明当前类是一个配置类；就是来营代之前的 Spring 配置文件
       * 在配置文件中用 <bean> </bean>标签添加组件
       */
      @configuration
      public class Config {
        // 将方法的返回值添加到容中；容器中这个组件默认的 id 就是方法名
        @Bean
        public Pet myPet() {
              Pet pet = new Pet();
              pet.setName("嘟嘟");
              pet.setAge(3);
              return pet;
          }
      }

• @ConfigurationProperties Validation

  • 支持JSR303进行配置文件值校验；

    @ConfigurationProperties
    @Validated
    public class FooProperties {
      @NotNull
      private InetAddress remoteAddress;
      @NotNull
      private final Security security = new Security();
    }

• @ImportResource读取外部配置文件

SpEL：

##　properties配置文件
persion.age=#{2019-1986+1}

# Person类
#--------------------使用@ConfigurationProperties注解，会抛出异常--------------------
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private Integer age;


#--------------------使用@value注解 OK--------------------
@Component
public class Person {
    @Value("${person.age}")
    private Integer age;

JSR303数据校验

@ConfigurationProperties支持校验，如果校验不通过，会抛出异常

@value注解不支持数据校验

复杂类型封装

@value`注解无法注入map等对象的复杂类型，但`list、数组可以

配置文件占位符

随机数

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

${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}

可以引用在配置文件中配置的其他属性的值，如果使用一个没有在配置文件中的属性，则会原样输出

可以使用:指定默认值

person.dog.name=${person.hello:hello}_dog

占位符

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

person.last-name=张三${random.uuid}
person.dog.name=${person.last-name}_dog

Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、 指定参数等方式快速切换环境

1. 多profile文件形式：

   1. 格式：application-{profile}.properties/yml

      1. application-dev.properties

      2. application-prod.properties

2. yaml支持多profile文档块模式：

   每个文档块使用 --- 分割

   server:
       port: 8081
   spring:
       profiles:
           active: prod
   ---
   server:
       port: 8081
   spring:
       profiles: dev
   ---
   server:
       port: 8084
   spring:
       profiles: prod # 指定属于哪个环境

3. 激活方式

   1. – 命令行 --spring.profiles.active=dev

      java -jar xxx.jar --spring.profiles.active=dev;

   2. – 配置文件 spring.profiles.active=dev

   3. – jvm 参数 –Dspring.profiles.active=dev

配置文件加载位置

• spring boot 启动会扫描以下位置的application.properties或者 application.yml文件作为Spring boot的默认配置文件

  1. file:./config/

  2. file:./

  3. classpath:/config/

  4. classpath:/

• 以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容。互补配置

  这里项目根路径下的配置文件maven编译时不会打包过去，需要修改pom

  <resources>
    <resource>
      <directory>.</directory>
      <filtering>true</filtering>
      <includes>
        <include>**/*.properties</include>
        <include>**/*.yaml</include>
      </includes>
    </resource>
  </resources>

我们也可以通过配置spring.config.location来改变默认配置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；

java -jar xxx.jar --spring.config.location=/home/cloudlandboy/application.yaml

外部配置加载顺序

SpringBoot也可以从以下位置加载配置；优先级从高到低 ；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

优先级

所有支持的配置加载来源：参考官方文档

1. 命令行参数 ⤴️

   所有的配置都可以在命令行上进行指定

   java -jar xxx.jar --server.port=8087  --server.context-path=/abc

   多个配置用空格分开； --配置项=值

2. 来自java:comp/env的JNDI属性 ⤴️

3. Java系统属性（System.getProperties()） ⤴️

4. 操作系统环境变量 ⤴️

5. RandomValuePropertySource配置的random.*属性值 ⤴️

   ==由jar包外向jar包内进行寻找==

   ==再来加载不带profile==

6. jar包外部的application.properties或application.yml(不带spring.profile)配置文件 ⤴️

7. jar包内部的application.properties或application.yml(不带spring.profile)配置文件 ⤴️

   优先加载带profile

8. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件 ⤴️

9. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件 ⤴️

10. @Configuration注解类上的@PropertySource ⤴️

11. 通过SpringApplication.setDefaultProperties指定的默认属性 ⤴️