微服务 springBoot配置文件properties与yml

微服务 springBoot配置文件properties与yml

1、文件类型

SpringBoot两种全局配置文件类型
application.properties
application.yaml或者application.yml

两者同时生效，优先加载application.properties

2、properties

properties文件没有配置则采用默认值，配置优先。

3、yaml

3.1、简介

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

3.2、基本语法

key: value；kv之间有空格
大小写敏感
使用缩进表示层级关系
缩进不允许使用tab，只允许空格
缩进的空格数不重要，只要相同层级的元素左对齐即可
'#'表示注释
字符串无需加引号，如果要加，''与""表示字符串内容 会被 转义/不转义

注意：
key: value中冒号是英文冒号，冒号后空格不要忘记。

3.3、数据类型

字面量：单个的、不可再分的值。date、boolean、string、number、null
k: v

对象：键值对的集合。map、hash、set、object
行内写法：  k: {k1:v1,k2:v2,k3:v3}
#或
k: 
  k1: v1
  k2: v2
  k3: v3

数组：一组按次序排列的值。array、list、queue
行内写法：  k: [v1,v2,v3]
#或者
k:
 - v1
 - v2
 - v3

2、配置提示

自定义的类和配置文件绑定一般没有提示。通过添加依赖可以提示信息，方便开发，但是引入的依赖不是业务开发需要，只是方便开发，所以可以定义打包排除。

		<!-- 添加yml提示信息依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>


 <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <!-- 打包排除多余依赖 -->
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

3、案例验证

1. 项目结构
   
2. maven

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.springboot</groupId>
    <artifactId>springboot01</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

3. 对象

/**
 * @author zrj
 * @date 2021/1/14
 * @since V1.0
 **/
@Data
@ToString
@Component
@ConfigurationProperties(prefix = "person")
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> salarys;
    private Map<String, List<Pet>> allPets;
}

@Data
class Pet {
    private String name;
    private Double weight;
}

/**
 * @author zrj
 * @date 2021/1/11
 * @since V1.0
 **/
@RestController
public class HelloController {

    @Autowired
    Person person;

    @RequestMapping("/person")
    public Person handler() {
        return person;
    }
}

/**
 * 主程序类
 *
 * @author zrj
 * @date 2021/1/11
 * @since V1.0
 **/
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run( MainApplication.class, args );
    }
}

4. application.yml

# yaml表示以上对象
person:
  boss: false
  birth: 2019/12/12 20:12:33
  age: 18
  # 对象表示
  pet:
    name: tomcat
    weight: 23.4
  # 数组表示
  interests: [篮球,游泳]
  # List表示
  animal:
    - jerry
    - mario
  # Map表示
  score:
    english:
      first: 30
      second: 40
      third: 50
    math: [131,140,148]
    chinese: {first: 128,second: 136}
  # Set表示
  salarys: [3999,4999.98,5999.99]
  #  Map<String, List<Pet>> allPets
  allPets:
    sick:
      - {name: tom}
      - {name: jerry,weight: 47}
    health: [{name: mario,weight: 47}]
  user-name: zhangsan

5. 输出结果