SpringBoot基础教程(2)--yaml/配置文件注入/数据校验/多环境配置

1、yaml配置注入

1.1、SpringBoot配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的

application.properties
- 语法结构：key=value
application.yml 或 application.yaml
- 语法结构：key：空格 value

【说明】

.yml 和 .yaml 只是文件扩展名不同 ，语法规则、解析器、功能特性完全一致。

二者都遵循 YAML 1.2 规范。
同一套 SnakeYAML / Jackson Dataformat YAML 解析器处理。
Spring Boot 加载逻辑对二者无差别，仅按文件名排序决定优先级（application.yml 优先于 application.yaml）。

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

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！

properties 复制代码

server.port=8081

或者

yaml 复制代码

server:
  port: 8081

1.2、yaml概述

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

这种语言以数据作为中心，而不是以标记语言为重点！

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

传统xml配置：

xml 复制代码

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

yaml配置：

yaml 复制代码

server:
  port: 8081

1.3、yaml基础语法

说明：语法要求严格！

1、空格不能省略

2、以**缩进(即两个空格)**来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

1.3.1、字面量：普通的值 [ 数字，布尔值，字符串 ]

字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

yaml 复制代码

k: v

注意：

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

比如：name: "lingbo \n li" 输出：lingbo 换行 li
'' **单引号：**会转义特殊字符，特殊字符最终会变成和普通字符一样输出

比如：name: 'lingbo \n li' 输出：lingbo \n li

1.3.2、对象、Map（键值对）

yaml 复制代码

#对象、Map格式
k:
  v1:
  v2:

在下一行来写对象的属性和值得关系，注意缩进；比如：

yaml 复制代码

student:
  name: lingbo
  age: 18

行内写法

yaml 复制代码

student: {name: lingbo,age: 18}

1.3.3、数组（ List、set ）

用 - 值表示数组中的一个元素,比如：

yaml 复制代码

pets:
  - cat
  - dog
  - rabbit

行内写法

yaml 复制代码

pets: [cat,dog,rabbit]

2、注入配置文件

2.1、yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml

2、编写一个实体类 Dog；

java 复制代码

@Component //注册bean到容器中
public class Dog {

    private String name;
    private Integer age;

    //有参无参构造、get、set方法、toString()方法 
}

3、思考，我们原来是如何给bean注入属性值的！@Value，给狗狗类测试一下：

java 复制代码

@Component
public class Dog {

    @Value("小金毛")
    private String name;
    @Value("1")
    private Integer age;
}

4、在SpringBoot的测试类下注入狗狗输出一下；

java 复制代码

@SpringBootTest
class Springboot02ConfigApplicationTests {


    @Autowired //将狗狗自动注入进来
    private Dog dog;

    @Test
    void contextLoads() {
        System.out.println(dog.toString());//打印看下狗狗对象

    }

}

结果成功输出，@Value注入成功，这是我们原来的办法对吧。

5、我们再编写一个复杂一点的实体类：Person 类

java 复制代码

@Component //注册bean到容器中
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    //有参无参构造、get、set方法、toString()方法 
}

6、我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！

yaml 复制代码

person:
  name: lingbo
  age: 18
  happy: true
  birth: 2007/08/08
  maps: {k1: v1, k2: v2}
  lists:
    - code
    - music
    - basketball

  dog:
    name: 小白
    age: 3

7、我们刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！

java 复制代码

/*
@ConfigurationProperties
作用：将配置文件中配置的每一个属性的值，映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = "person": 将配置文件中的person前缀下面的所有属性一一对应
*/

@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    //...
}

8、确认以上配置都OK之后，我们去测试类中测试一下：

java 复制代码

@SpringBootTest
class Springboot02ConfigApplicationTests {


    @Autowired //将person自动注入进来
    private Person person;

    @Test
    void contextLoads() {
        System.out.println(person.toString());//打印看下person对象

    }

}

结果：所有值全部注入成功！

2.3、配置文件占位符

配置文件还可以编写占位符生成随机数

yaml 复制代码

person:
  name: lingbo${random.uuid} # 随机uuid
  age: ${random.int} # 随机int
  happy: true
  birth: 2007/08/08
  maps: {k1: v1, k2: v2}
  lists:
    - code
    - music
    - basketball

  dog:
    name: ${person.hello:other}_小白
    age: 3

2.4、properties配置文件注入

【注意】properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8；

settings-->FileEncodings 中配置；

测试步骤：

1、新建一个实体类User

java 复制代码

@Component
public class User {
    private String name;
    private int age;
    private String sex;
}

2、编辑配置文件 user.properties

properties 复制代码

user1.name=绫波
user1.age=18
user1.sex=女

3、我们在User类上使用@Value来进行注入！

java 复制代码

@Component
@PropertySource("classpath:user.properties")
public class User {
    @Value("${user1.name}")//从配置文件中取值
    private String name;
    @Value("#{9*2}") // #{SPEL} Spring表达式
    private int age;
    @Value("女") //字面量
    private String sex;
}

4、Springboot测试

java 复制代码

@SpringBootTest
class Springboot02ConfigApplicationTests {

    @Autowired //将user自动注入进来
    private User user;

    @Test
    void contextLoads() {
        System.out.println(user.toString());//打印看下user对象

    }

}

结果正常输出：

2.5、对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；

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

1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象，使用value就不支持

结论：

配置yml和配置properties都可以获取到值，强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！

3、JSR303数据校验

已过时，仅做了解即可

Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。

首先添加依赖：

xml 复制代码

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>

或是

xml 复制代码

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

我们这里来写个注解让我们的name只能支持Email格式；

java 复制代码

@Component
@ConfigurationProperties(prefix = "dog")
@Validated //开启数据校验
public class Dog {

    @Email(message = "字段与邮箱格式不匹配") //name必须是邮箱格式
    private String name;
    private Integer age;

	//...
}

运行结果：default message [字段与邮箱格式不匹配];

使用数据校验，可以保证数据的正确性；

常见参数

java 复制代码

@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;
空检查
    @Null       验证对象是否为null
    @NotNull    验证对象是否不为null, 无法查检长度为0的字符串
    @NotBlank   检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
    @NotEmpty   检查约束元素是否为NULL或者是EMPTY.    
Booelan检查
    @AssertTrue     验证 Boolean 对象是否为 true  
    @AssertFalse    验证 Boolean 对象是否为 false      
长度检查
    @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内  
    @Length(min=, max=) string is between min and max included.
日期检查
    @Past       验证 Date 和 Calendar 对象是否在当前时间之前  
    @Future     验证 Date 和 Calendar 对象是否在当前时间之后  
    @Pattern    验证 String 对象是否符合正则表达式的规则
    
.......等等
除此以外，我们还可以自定义一些数据校验规则

4、多环境配置

profiles是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境；

4.1、多配置文件

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml , 用来指定多个环境版本；

例如：

application-test.properties 代表测试环境配置

application-dev.properties 代表开发环境配置

application-prod.properties 代表生产环境配置

但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置文件；

我们需要通过一个配置来选择需要激活的环境：

properties 复制代码

#比如在配置文件中指定使用dev环境，我们可以通过设置不同的端口号进行测试；
#我们启动SpringBoot，就可以看到已经切换到dev下的配置了；
spring.profiles.active=dev

4.2、yaml的多文档块

和properties配置文件中一样，但是使用yaml去实现不需要创建多个配置文件，更加方便了 !

yaml 复制代码

server:
  port: 8081

#选择要激活那个环境块
spring:
  profiles:
    active: dev
---
server:
  port: 8082
spring:
  profiles: dev #配置环境的名称

---
server:
  port: 8083
spring:
  profiles: prod #配置环境的名称

注意：如果yaml和properties同时都配置了端口，并且没有激活其他环境，默认会使用properties配置文件的！

4.3、配置文件加载位置

外部加载配置文件的方式十分多，我们选择最常用的即可，在开发的资源文件中进行配置！

官方外部配置文件说明参考文档

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

yaml 复制代码

优先级1：项目根路径下的config文件夹配置文件
优先级2：项目根路径下配置文件
优先级3：资源路径(/resource)下的config文件夹配置文件
优先级4：资源路径(/resource)下配置文件

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

SpringBoot会从这四个位置全部加载主配置文件；互补配置；

4.4、拓展，运维小技巧

指定位置加载配置文件

我们还可以通过spring.config.location来改变默认的配置文件位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；这种情况，一般是后期运维做的多，相同配置，外部指定的配置文件优先级最高。

bash 复制代码

java -jar spring-boot-config.jar --spring.config.location=F:/application.properties