SpringBoot配置文件

1、配置文件

SpringBoot使用一个全局的配置文件,配置文件名是固定的; •application.properties
•application.yml
配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
YAML(YAML Ain't Markup Language)
YAML A Markup Language:是一个标记语言
YAML isn't Markup Language:不是一个标记语言;
标记语言:
以前的配置文件,大多都使用的是 xxxx.xml文件;
YAML:以数据为中心,比json、xml等更适合做配置文件;
YAML:配置例子

server:
  port: 8081

2、YAML语法

1、基本语法

k:(空格)v:表示一对键值对(空格必须有); 以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

server:
  port: 8081
  path: /hello

属性和值也是大小写敏感;

2、值的写法

字面量:普通的值(数字,字符串,布尔)：

k: v:字面直接来写;
字符串默认不用加上单引号或者双引号;
" ":双引号;不会转义字符串里面的特殊字符;
特殊字符会作为本身想表示的意思
name: "zhangsan \n lisi":输出;zhangsan 换行 lisi
' ':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi

对象、Map(属性和值)(键值对)：

k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是k: v的方式

person:
  age: 22
  last-name: zhangsan

行内写法：

person: {age: 22,name: zhangsan}

数组(List、Set):

用- 值表示数组中的一个元素

list:
   - wangwu
   - lisi
   - zhaoliu

行内写法：

list: [wangwu,lisi,zhaoliu]

3、配置文件注入

配置文件application.yml：

person:
  age: 22
  last-name: zhangsan
  boss: false
  map: {k1: v1,k2: v2}
  list:
   - wangwu
   - lisi
  dog:
    name: huihui
    age: 5

application.properties

person.last-name=张三
person.age=22
person.boss=false
person.map.k1=v1
person.map.k2=15

person.list=lisi,wangwu,zhaoliu

person.dog.name=花花
person.dog.age=5

javaBean:@ConfigurationProperties(prefix = "person")注解方式

/**
 * 将配置文件中每一个属性的值，映射到这个组件中
 * @configurationProperties：告诉springboot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *   prefix = "person"：配置文件中哪个下面的所有属性进行一一对应
 * @Component：只有这个组件是spring容器中的组件，才能用spring容器提供的configurationProperties功能，
 *  所以需要@Component注解标注加载到spring容器中
 */
@Data
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Map<String,Object> map;
    private List<Object> list;

    private Dog dog;
}

pom文件导入依赖：

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

测试（结果成功）：

image.png

4、相关注解

1、properties配置文件在idea中默认utf-8可能会乱码

image.png

解决方式：

image.png

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

image.png

配置文件yml还是properties他们都能获取到值;
如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value; 如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;

3、指定读取某一个配置文件 @PropertySource

@PropertySource(value = {"classpath:person.properties"})
@SpringBootApplication
public class Myspringboot02Application {

    public static void main(String[] args) {
        SpringApplication.run(Myspringboot02Application.class, args);
    }

}

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

/**
 * 将配置文件中每一个属性的值，映射到这个组件中
 * @configurationProperties：告诉springboot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *   prefix = "person"：配置文件中哪个下面的所有属性进行一一对应
 * @Component：只有这个组件是spring容器中的组件，才能用spring容器提供的configurationProperties功能，
 *  所以需要@Component注解标注加载到spring容器中
 */
@Data
@Component
@ConfigurationProperties(prefix = "person")
@Validated  // JSR303数据校验注解
public class Person {

    /**
     * @value("")类似于
     * <bean id="Person" class="com.mystudy.entity.Person">
     *      <property name="lastName" value="值是${key(person.last-name)}从环境变量、配置文件中获取值 或者#{spEL(2*5)}"/>
     * </bean>
     */
    // @Value("${person.last-name}")
    @Email // lastName必须是邮箱格式
    private String lastName;
    // @Value("#{2*5}")
    private Integer age;
    // @Value("true")
    private Boolean boss;
    private Map<String,Object> map;
    private List<Object> list;

    private Dog dog;

}

5、导入spring配置文件，让配置文件生效 @ImportResource

SpringBoot里面没有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="helloService" class="com.mystudy.service.HelloService"></bean>
</beans>

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

@ImportResource(locations = {"classpath:bean.xml"})
@SpringBootApplication
public class Myspringboot02Application {

    public static void main(String[] args) {
        SpringApplication.run(Myspringboot02Application.class, args);
    }
}

6、SpringBoot推荐配置类 @Configuration

springboot不推荐使用配置文件给容器中添加组件方式，推荐使用全注解方式

import org.springframework.context.annotation.Configuration;

/**
 * @Configuration注解指明该类是一个配置类，用来代替spring配置文件
 */
@Configuration
public class MyConfig {

    /**
     * 将方法返回值添加到容器中
     * @Bean注解相当于<bean></bean>,默认的id为方法名
     * @return
     */
    @Bean
    public HelloService helloService(){
        System.out.println("是否添加到容器中");
        return new HelloService();
    }

}

7、配置文件占位符

1.随机数

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

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

# 结果是 TomAndJerry@163.comd89c6e63-612f-4c3a-b6c4-cc829c093d25
person.last-name=TomAndJerry@163.com${random.uuid}
# 结果 25
person.age=${random.int[10,30]}
person.boss=false
person.map.k1=v1
person.map.k2=15

person.list=lisi,wangwu,zhaoliu

# 结果是 TomAndJerry@163.com354c5644-f14c-441b-91fd-9cfbad049c28_dog
#person.dog.name=${person.last-name}_dog

# 结果是 hello_dog
# ${person.hello:hello}这样的写法是如果person.hello没有值，默认值为：后边的hello
person.dog.name=${person.hello:hello}_dog
person.dog.age=5

8、profile文件

1.多profile文件
在主配置文件编写的时候,文件名可以是
application-{profile}.properties/yml
springboot默认使用application.properties的配置;

image.png

# 指定使用哪个配置文件
spring.profiles.active=dev

2.yml支持多文档块方式

server:
  port: 8080

# 指定使用哪个环境
spring:
  profiles:
    active: prod

# "---"文档块分隔符
---
server:
  port: 8083

# 声明文档块名称
spring:
  profiles: dev

---
server:
  port: 8084

# 声明文档块名称
spring:
  profiles: prod

3.指定profile配置文件
1、在配置文件中指定 spring.profiles.active=dev
2、命令行:
java -jar myspringboot02-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

image.png
3、虚拟机参数;
-Dspring.profiles.active=dev
image.png

9、配置文件加载位置及顺序

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/
–file:./
–classpath:/config/
–classpath:/
优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件
不同属性配置会--互补配置;

我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;
指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;

java -jar myspringboot02-0.0.1-SNAPSHOT.jar 
--spring.config.location=/Users/wangshuqi/Downloads/application.properties

image.png

10、外部配置加载顺序

SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会互补配置
1.命令行参数
所有的配置都可以在命令行上进行指定
java -jar myspringboot02-0.0.1-SNAPSHOT.jar --server.port=8090 多个配置用空格分开; 格式：--配置项=值
2.来自java:comp/env的JNDI属性
3.Java系统属性(System.getProperties())
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性值由jar包外向jar包内进行寻找;
优先加载带profile
6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
再来加载不带profile
8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10.@Configuration注解类上的@PropertySource
11.通过SpringApplication.setDefaultProperties指定的默认属性所有支持的配置加载来源
具体参考官方文档：https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-external-config