09-SpringBoot属性配置文件
YAML类型的属性核心配置文件:application.yaml
YAML是 "YAML Ain't Markup Language"(YAML 不是一种标记语言)的递归缩写,虽然是这样说但是在开发中可以认为这是和XML一样一种标记语言进行使用。所谓的标记语言,就是使用许多的的标签来定义某些东西。
非常适合用来做以数据为中心的配置文件。
1、基本语法
-
格式为 :
key: value # k:和v之间有一个空格
-
key和value的值是区分大小写的
-
使用缩进表示层级关系,xml文件中是用一个标签的开闭表示一个级别,标签内部的开闭标签就是父子关系
-
缩进不允许使用tab,只允许使用空格
-
缩进的空格数不重要,只要相同层级的元素左对齐即可,所以,但是在idea中使用tab也没关系,对的齐就行
-
表示注释
-
当我们使用单引号和双引号来修饰value的值时,如果value中有\n这种在Java语言中表示转义的字符时:
双引号修饰的话,输出到控制台的value值,\是发挥转义的作用的,就是会换行。
单引号修饰的话,输出到控制台的value值,\是不发挥转义的作用的,会把\n输出来
2、valued的值为不同数据类型示例
-
字面量:单个、不可再分的值(就是一对一)。value的值是date、boolean、String、数据类型、null
k1: v1 k2: v2 k3: v3
-
对象:键值对的集合。value的值是map、hash、set、Object
#对象中是有属性的,这个对象中的属性在同一级,所以要对齐。但是属性如果也是个对象,属性的属性就是下一级 #行内写法: k: {k1: v1,k2: v2,k3: v3} #或这样,这样写k:的后面是可以不用加空格的 k: k1: v1 k2: v2 k3: v3
-
数组:一组按次序排列的值。array、list、queue。因为list集合部署键值对,所以和数组一样
#行内写法: k: [v1,v2,v3] #或这样,-表示k,k有多个值,就是数组。-后面要有空格然后加v,注意没有: k: - v1 - v2 - v3
3、示例:创建一个Person类,如下。然后进行配置绑定,创建一个application.yaml文件在resources目录下,和application.properties文件是可以共存的,但是application.properties配置的优先级是大于yaml的。
package com.studymyself.bean;
import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
@ConfigurationProperties(prefix = "person")//和配置文件中前缀为person的进行绑定
@Component//让容器创建这个组件
@ToString
@Data
public class Person {
private String userName;
private Boolean boss;
private Date birth;
private Integer age;
private Pet pet;
private String[] interests;
private List<String> animal;
private Map<String, Object> score;
private Set<Double> salary;
private Map<String, List<Pet>> allPets;
}
person:
userName: 朴智妍
boss: true
birth: 1991/02/15 #注解要和数据加个空格,默认的Date生日格式以/分隔
age: 30
pet:
name: Tomcat
#interests: [football,games,listening] #行内写法
interests:
- football
- games
- listening
animals: [阿猫,阿兔,成龙]
score: {数学: 126,英语: 125,语文: 130}
salary: [15893.00,48999.00,98653.00]
allPets:
生病动物:
- {name: 小猫}
- {name: 小兔}
健康动物: [name: 小狗,name: 小鸡] #List是集合,可以用{},但只能存储单面量。用[],可以存储对象
在Controller类中写一个接口,返回Person对象,测试接口。注意,我们要从容器中获取person组件,用依赖注入@Resource获取,测试的时候由于返回的是在方法中自己定义的一个Person参数,所以测试接口的时候,返回的json中person的属性一直是空
package com.studymyself.controller;
import com.studymyself.bean.Person;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
@Slf4j
@RestController
public class MyController {
//注意要从容器中获取person组件
@Resource
Person person;
@RequestMapping("/hello")
public String myController(){
//使用日志,log属性
log.error("警告:请求进来了");
return "你好啊!Spring Boot!";
}
@RequestMapping("/person")
public Person person(){
log.warn("提示:开始进行请求处理");
return person;
}
}
4、我们发现我们在yaml文件时,即使用@ConfigurationProperties注解将javabean和属性资源配置文件绑定了,在编写标签值时,却没有提示,所以我们要解决这个问题。而且我们的Person类上面也一直提示我们没有配置注释处理器
将注释处理器依赖添加到pom文件中,然后再maven打包插件中进行配置,具体如下
<!--注释处理器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<!--配置maven打包插件打包时忽略注释处理器的jar包-->
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
然后重启项目才会生效,重启后停掉项目到yaml文件中进行测试
5、JSR303数据校验
意思就是在属性字段上增加一层过滤器验证,可以保证数据的合法性。
使用方式:在需要属性赋值的类中添加一个@Validated注解,然后在需要验证的属性上添加各种不同的验证注解来约束这个字段应该填什么或是应该填什么格式
如下
其中这个@Email注解中的message的值是报错后的提示信息,其中有默认值的。
还有很多这样的校验注解,具体如下
//空检查
@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=) Validates that the annotated string is between min and max included.
//日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前,验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ,验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则,被注释的元素符合制定的正则表达式,regexp:正则表达式 flags: 指定 Pattern.Flag 的数组,表示正则表达式的相关选项。
//数值检查
建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为”“,Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)