4. 配置文件详细讲解

一、配置文件

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

application.properties
application.yml

配置文件的作用：

　　修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

YAML（YAML Ain’t Markup Language）

　　YAML是“YAML不是一种标记语言”的外语缩写 [1] （见前方参考资料原文内容）；但为了强调这种语言以数据做为中心，而不是以置标语言为重点，而用返璞词重新命名。它是一种直观的能够被电脑识别的数据序列化格式，是一个可读性高并且容易被人类阅读，容易和脚本语言交互，用来表达资料序列的编程语言。

标记语言：

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

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

　　YAML：配置例子

```
server:
    port: 8080
```

　　如果是xml：

<server>
    <port>8080</port>
</server>

二、YAML语法介绍

1、基本语法

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

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

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

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

2、值的写法

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

　　k: v：字面直接来写；
　　字符串默认不用加上单引号或者双引号；

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

```
name: "sihai\n lisi"
```
输出： sihai换行 lisi”：单引号：会转义特殊字符，特殊字符最终只是一个普通的字符串数据

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

name: 'sihai\n lisi'

输出；sihai\n lisi

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

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

```
user：
    name: sihai
    age: 20
```
行内写法：
```
user: {name: sihai, age: 18}
```

　　数组（List、Set）

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

```
pets:
 - cat
 - dog
 - pig
```
行内写法：
```
pets: [cat,dog,pig]
```

属性名匹配规则（Relaxed binding）

　　– person.firstName：使用标准方式

　　– person.first-name：大写用-

　　– person.first_name：大写用_

　　– PERSON_FIRST_NAME：

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

配置文件占位符
• 使用随机数

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

person.firstName=张
person.fullName=${person.firstName}三

• 属性配置占位符
– 可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。

– ${app.name:默认值}来指定找不到属性时的默认值

三、配置文件值注入

配置文件

user:
    name: sihai
    age: 20
    lists:
        - lisi
        - zhangsan
    pig:
        name: 小猪
        age: 10

JavaBean

/**
* 将配置文件中配置的每一个属性的值，映射到这个组件中
* 
* @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
* 
* prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
*
*/
@Component
@ConfigurationProperties(prefix = "user")
public class User{
    private String name;
    private int age;

    private List<Object> lists;
    private Pig pig;
}

导入配置文件处理器，编写配置有提示

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

1、properties配置文件在idea中默认utf-8乱码解决

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

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

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

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

3、配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "user")
public class User{
    //使用value获取一个值
    @Value("${user.name}")
    private String name;
    private int age;

    private List<Object> lists;
    private Pig pig;
}

@PropertySource　&　@ImportResource　&　@Bean

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

/**
* 将配置文件中配置的每一个属性的值，映射到这个组件中
* @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
* prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
* @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
*
*/
@PropertySource(value = {"classpath:user.properties"})
@Component
@ConfigurationProperties(prefix = "user")
public class User{
    //使用value获取一个值
    @Value("${user.name}")
    private String name;
    private int age;

    private List<Object> lists;
    private Pig pig;
}

　　2. @ImportResource：导入Spring的配置文件，让配置文件里面的内容生效<import />

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

```
//导入Spring的配置文件让其生效
@ImportResource(locations = {"classpath:beans.xml"})
```
由于springboot推荐使用全注解的方式，所以我们可以使用全注解的方式来改造以前的bean 的配置方式

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.sihai.springboot.service.HelloService"></bean>
</beans>

　　3.springboot全注解方式：

　　　　1、配置类@Configuration对应Spring配置文件

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

/**
* @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
* 在配置文件中用<bean><bean/>标签添加组件
*/
@Configuration
public class MyAppConfig {
    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

四、profile讲解

1、多Profile文件

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

默认使用application.properties的配置。

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 spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
```
可以直接在测试的时候，配置传入Run As ——> Run Configurations

3）命令行参数：Program arguments
```
--server.port=8765
```
4）虚拟机参数：VM arguments
```
-Dspring.profiles.active=dev
```

七、外部配置加载顺序

Spring Boot 支持多种外部配置方式
这些方式优先级如下： https://docs.spring.io/spring-boot/docs/currentSNAPSHOT/reference/htmlsingle/#boot-features-external-config

1. 命令行参数

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

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

4. 操作系统环境变量

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

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

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

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

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

10. @Configuration注解类上的@PropertySource

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

posted @ 2018-10-31 16:02 超轶绝尘阅读(1007) 评论(0) 收藏举报

刷新页面返回顶部

超轶绝尘