Boot项目的yaml配置

Boot项目的yaml配置

1.文件名

boot项目的配置文件application.properties，还支持其他后缀格式的文件
后缀名为：yml或者yaml，

2.语法要求：

1. 用缩进表示层级关系
2. 相同缩进表示同一级
3. 区分大小写

com:
  example:
    age:

3.具体配置对象说明

3.1Map对象、类对象

对于Map对象，key: value 值冒号后面必须有至少一个空格

对于类对象的属性名如果采用驼峰命名方式，在配置中可以有三种写法:
demoName----> demoName 、 demo-name 、demo_name

com:
  example:
    map:
        aaa: 456
        bbb: 789

案例：

pom.xml

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.3.4.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>maven1010</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>maven1010</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<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>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

MyConfig

@Component//注入到容器中
@Data  //利用lombok生成get/set方法
@ConfigurationProperties("com.example") //设置配置文件中的前缀
public class MyConfig {

    private String name;
    private Integer age;
    private Map map;
    private Demo1 demo1;

}

controller

@RestController
public class DemoController {
    @Autowired
    private MyConfig myConfig;
    @GetMapping("/demo1")
    public Map m1(){
        Map map = myConfig.getMap();
        return map;
    }
    @GetMapping("/demo2")
    public String m2(){
        return  myConfig.getDemo1().getDemoName();
    }
}

applicatrion

@SpringBootApplication
public class Maven1010Application {

    public static void main(String[] args) {
        SpringApplication.run(Maven1010Application.class, args);
    }

}

依赖类Demo1

@Data
public class Demo1 {
    private String demoName;
    private Integer demoAge;

}

application.yml

# 注释内容
com:
  example:
    map:
        aaa: 456
        bbb: 789

或者简化行内样式：

com:
  example:
    map: {aaa: 456, bbb: 789}
    demo1: {demo-name: demo, demo-age: 123}

显示结果：

3.2 数组、集合

数组配置：

com:
  example:
    map: {aaa: 456, bbb: 789}
    demo1: {demo-name: demo, demo-age: 123}
    arr:
     - 1
     - 2

或者简化方式：

com:
  example:
    map: {aaa: 456, bbb: 789}
    demo1: {demo-name: demo, demo-age: 123}
    arr: [1,2,3]

4.特殊字符

如果我们想要在配置文件中引入特殊字符而又不想进行转义如;"\n"

1. 直接写字符串，中间的特殊字符也正常写
2. 将要写的字符串整个用单引号包裹
3. 双引号包裹会将特殊字符串进行转义，“\n” 会进行换行

5.占位符

对于一些共用的字符或变量，在其他配置中使用需要${}进行引用，但占位符在行内样式中引用会失败

com:
  example:
    map: {aaa: 456, bbb: 789}
    demo1: {demo-name: demo, demo-age: 123}
    arr:
     - 1
     - ${server.port}
server:
  port: 8080