SpringBoot的配置文件篇

上篇：最佳实践-SpringBoot应用如何编写

一、配置文件

1、文件类型

（1）properties

（2）yaml 

简介

• YAML 是 "YAML Ain't Markup Language"（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。
• 非常适合用来做以数据为中心的配置文件

基本语法

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

 数据类型

• 字面量：单个的、不可再分的值。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、代码案例

（1）实体类

package org.apache.springboot.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")  //配置文件前缀绑定
@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> salarys;
    private Map<String, List<Pet>> allPets;
}

宠物类

package org.apache.springboot.bean;

import lombok.Data;
import lombok.ToString;

/**
 * 宠物
 */
@ToString
@Data
public class Pet {
    private String name;
    private Double weight;
}

（2）全局配置文件参数

person:
  userName: zhangsan
  boss: true
  birth: 2021/09/02
  age: 18
#    interests: [篮球,足球]
  interests:
      - 篮球
      - 足球
      - 18
  animal: [阿猫,阿狗]
#      score:
#        english: 80
#        math: 90
  score: {english: 80,math: 90}
  salarys:
        - 9999.98
        - 9999.99
  pet:
        name: 阿狗
        weight: 99.99
  allPets:
       sick:
          - {name: 阿狗,weight: 99.99}
          - name: 阿猫
            weight: 88.88
          - name: 阿虫
            weight: 77.77
       health:
         - {name: 阿花,weight: 199.99}
         - {name: 阿明,weight: 199.99}
# user-Name: zhangsan  #这样写也是可以的

（3）控制类

package org.apache.springboot.controller;

import org.apache.springboot.bean.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @Autowired
    Person person;
    @RequestMapping("/persion")
    public Person person(){
       return person;
    }
}

（4）启动类

package org.apache.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

/**
 * 主程序类
 * @SpringBootApplication：这是一个SpringBoot应用
 */
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class,args);
    }
}

 启动主程序，访问：http://localhost:8080/person

 说明：

• 单引号会将”\n“作为字符串输出，双引号会将”\n“作为换行输出，
• 双引号不会转义，而单引号不会转义

二、自定义类绑定的配置提示 

1、问题

（1）解决该问题，引进pom文件

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

该配置器与与业务无关，只是为了开发方便 

 （2）引进来之后，发现有该提示

 打包加入处理器，pom文件如下：

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

打包不想加入处理器：pom文件如下：【由于自己前面已经引入该文件，所以此次做排除引入】

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.2.2.RELEASE</version>
             <!--   <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
                -- >
            </plugin>
        </plugins>
    </build>

但是，如果需要打包，还是不建议排除