二、配置文件

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：配置例子

1
2
server:
   port: 8081

XML：

1
2
3
4
<server>
   <port>8081</port>
</server>

2、YAML语法：

2.1 基本语法

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

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

1
2
3
server:
  port: 8081
  path: /hello

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

2.2 值的写法

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

k: v：字面直接来写；

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

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

name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

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

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

对象、Map（属性和值）（键值对）：

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

对象还是k: v的方式

1
2
3
friends:
    lastName: zhangsan
    age: 20

行内写法：

1
friends: {lastName: zhangsan,age: 18}

**数组（List、Set）： **

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

1
2
3
4
pets:  
  ‐ cat  
  ‐ dog  
  ‐ pig

行内写法

1
pets: [cat,dog,pig]

3、配置文件值注入

配置文件

1
2
3
4
5
6
7
8
9
10
11
12
person:     
  lastName: hello     
  age: 18     
  boss: false     
  birth: 2017/12/12   maps: {k1: v1,k2: 12}     
  lists:       
    ‐ lisi       
    ‐ zhaoliu     
  dog:       
    name: 小狗       
    age: 12

javaBean：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/**  * 将配置文件中配置的每一个属性的值，映射到这个组件中
* @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
*      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射 
* 
* 只有这个组件是容器中的组件，才能容器提供的@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;

我们可以导入配置文件处理器，以后编写配置就有提示了

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

3.2@Value获取值和@ConfigurationProperties获取值比

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

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

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

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

3.3 配置文件注入值数据校验

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Component 
@ConfigurationProperties(prefix = "person") 
@Validated
public class Person {     
    /**    
    * <bean class="Person">    
    *  <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>    
    * <bean/>     
    */     
    //lastName必须是邮箱格式   
    @Email     
    //@Value("${person.last‐name}")   
    private String lastName;  
    //@Value("#{11*2}")  
    private Integer age;   
    //@Value("true")    
    private Boolean boss;   
    private Date birth;   
    private Map<String,Object> maps;  
    private List<Object> lists;  
    private Dog dog;

3.4 @PropertySource&@ImportResource&@Bean

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/**  
* 将配置文件中配置的每一个属性的值，映射到这个组件中  
* @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；  
*      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射  
*  
* 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；  
*  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；  
*  
*/ 
@PropertySource(value = {"classpath:person.properties"}) 
@Component 
@ConfigurationProperties(prefix = "person") 
//@Validated
public class Person {     
    /**    
    * <bean class="Person">    
    *  <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>    
    * <bean/>     
    */     
    //lastName必须是邮箱格式   
    //@Email     
    //@Value("${person.last‐name}")   
    private String lastName;  
    //@Value("#{11*2}")  
    private Integer age;   
    //@Value("true")    
    private Boolean boss;   
    private Date birth;   
    private Map<String,Object> maps;  
    private List<Object> lists;  
    private Dog dog;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；
Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；
想让Spring的配置文件生效，加载进来；**@ImportResource**标注在一个配置类上

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

不来编写Spring的配置文件

1
2
3
4
<?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.atguigu.springboot.service.HelloService"></bean> 

</beans>

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

  1. 配置类@Configuration——>Spring配置文件
  2. 使用@Bean给容器中添加组件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**  
* @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 */
 
@Configuration 
public class MyAppConfig {       

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

4 配置文件占位符

4.1 随机数

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

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

1
2
3
4
5
6
7
8
9
person.last‐name=张三${random.uuid} 
person.age=${random.int}
person.birth=2017/12/15 
person.boss=false 
person.maps.k1=v1 
person.maps.k2=14 
person.lists=a,b,c 
person.dog.name=${person.last‐name:hello}_dog #:hello为默认值，如果不存在${person.last‐name}
person.dog.age=15

5、Profile

##5.1多Profile文件
我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml

默认使用application.properties的配置

5.2 yml支持多文档块方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
server:
  port: 8081
spring:
  profiles:
    active: prod

-‐‐

server:
  port: 8083
spring:
  profiles: dev
  
---

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

5.3 激活指定profile

  1. 在配置文件中指定 spring.profiles.active=dev
  2. 命令行：java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar –spring.profiles.active=dev；可以直接在测试的时候，配置传入命令行参数
  3. 虚拟机参数；-Dspring.profiles.active=dev

6. 配置文件加载位置

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

–file:./config/

–file:./
–classpath:/config/
–classpath:/

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

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

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

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

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar –spring.config.location=G:/application.properties

下图这样也会加载配置文件 而且外部优先