[SpringBoot] SpringBoot-04-读取yaml配置文件

1. 单个属性

yaml 内的属性如下：

server:
  port: 80
1
2

只需在成员变量上注解 @Value(“${属性名}”) 即可，用美元符号获取属性值

如下例：

@RestController
@RequestMapping("/")
public class DemoController {

    @Value("${server.port}")
    private String port;

    @GetMapping
    public String func() {
        return "server port: " + port;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

2. 全部属性

yaml 内的属性如下：

server:
  port: 80
logging:
  level: 
    root: warn
1
2
3
4
5

定义 Environment 成员变量，注解 @Autowired 即可，通过 .gerProperty(属性名) 函数来获取属性值

如下例：

@RestController
@RequestMapping("/")
public class DemoController {

    @Autowired
    private Environment environment;

    @GetMapping
    public String func() {
        String port = environment.getProperty("server.port");
        String level = environment.getProperty("logging.level.root");
        return "server port: " + port + "\n"
                + "logging level: " + level;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

3. 对象属性

yaml 内的属性如下：

mybook:
  name: 《SpringBoot入门》
  price: 28.00
  tags: [编程, Java, Spring]
1
2
3
4

首先要定义一个 bean，给类注解 @Component 表示添加到 Spring 容器，注解 @ConfigurationProperties 设置属性 prefix 为配置中的对象名，如下例：

@Component
@ConfigurationProperties(prefix = "mybook")
public class Book {
    private String name;
    private Double price;
    private String[] tags;

	// 省略了成员方法
}
1
2
3
4
5
6
7
8
9

使用自动装配填充即可，如下例：

@RestController
@RequestMapping("/")
public class DemoController {

    @Autowired
    private Book book;

    @GetMapping
    public String func() {
        return book.toString();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

[补充]

• 当有多个类注解 prefix 的值为同一个对象时，IDEA会报错 Duplicated prefix，但不影响项目运行

补充

在刚才自定义 bean 时，IDEA 会报一个警告 Spring Boot Configuration Annotation Processor not configured，显示在页面的顶部，这个警告不会影响项目运行

在 pom.xml 中添加下面的依赖就可以解决：

<dependency>
	<groupId>org.springframework.bootgroupId>
	<artifactId>spring-boot-configuration-processorartifactId>
dependency>
1
2
3
4