SpringBoot配置文件

zoeil

已于 2023-09-29 09:24:11 修改

阅读量6.9k

点赞数 2

分类专栏： spring boot学习文章标签： java 前端 html

于 2023-01-01 08:45:00 首次发布

本文链接：https://blog.csdn.net/m0_62946761/article/details/128500876

版权

spring boot学习专栏收录该内容

20 篇文章 1 订阅

订阅专栏

文章详细介绍了SpringBoot中配置文件的两种类型——properties和yaml。yaml作为一种适合数据为中心的配置文件格式，其特点包括键值对、空格表示层级、支持多种数据类型等。文章提供了yaml的基本语法、数据类型示例，并展示了如何映射到Java对象。同时，提到了使用spring-boot-configuration-processor来实现自定义配置类的提示功能。

摘要由CSDN通过智能技术生成

1、文件类型

1.1、properties

同以前的properties用法

1.2、yaml

1.2.1、简介

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

非常适合用来做以数据为中心的配置文件

1.2.2、基本语法

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

1.2.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

1.2.4、示例

@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;
}

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

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

结果

Person(userName=zhangsan, boss=false, birth=Thu Dec 12 20:12:33 CST 2019, age=18, pet=Pet(name=tomcat, weight=23.4), interests=[篮球, 游泳], animal=[jerry, mario], score={english={first=30, second=40, third=50}, math={0=131, 1=140, 2=148}, chinese={first=128, second=136}}, salarys=[3999.0, 4999.98, 5999.99], allPets={sick=[Pet(name=tom, weight=null), Pet(name=jerry, weight=47.0)], health=[Pet(name=mario, weight=47.0)]})

2、配置提示

自定义的类和配置文件绑定一般没有提示，加入spring-boot-configuration-processor可以实现自定义类的提示。

        <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-processor打包进去-->
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

根据提示重启服务

总结

（1）SpringBoot支持两种配置文件，properties和yaml(yml)，但是当两个文件都有同一个配置时优先properties文件

（2）yaml文件中字符串无需加双引号或者单引号，但如果为了实现转义就需要加上双引号。双引号会将原本的转义字符转义

单引号会\n 作为字符串输出；双引号会将\n 作为换行输出

双引号不会转义原本的转义性质，单引号会转义原本的转义性质