Spring Boot中的yaml怎么配置

在Spring Boot中，配置文件是应用程序的重要组成部分。Spring Boot支持多种配置文件格式，其中YAML（YAML Ain’t Markup Language）是一种非常流行的格式。YAML以其简洁、易读的语法而著称，特别适合用于配置文件的编写。本文将详细介绍如何在Spring Boot中使用YAML进行配置。

1. YAML简介

YAML是一种人类可读的数据序列化格式，通常用于配置文件。它的设计目标是易于阅读和编写，同时支持复杂的数据结构。YAML文件使用缩进来表示层次结构，使用冒号来分隔键值对。

1.1 YAML的基本语法

• 键值对：使用冒号分隔键和值，例如 key: value。
• 列表：使用短横线 - 表示列表项，例如： “`yaml list:
  • item1
  • item2
  • item3
  ”`
• 嵌套结构：通过缩进来表示嵌套关系，例如：

  
  parent:
  child1: value1
  child2: value2
  

1.2 YAML的优势

• 易读性：YAML的语法简洁明了，易于阅读和编写。
• 层次结构：通过缩进表示层次结构，使得配置文件的结构更加清晰。
• 支持复杂数据类型：YAML支持列表、字典等复杂数据类型，适合用于配置文件的编写。

2. Spring Boot中的YAML配置

Spring Boot默认支持YAML格式的配置文件，文件名为 application.yml 或 application.yaml。Spring Boot会自动加载这些文件，并将其中的配置项注入到应用程序中。

2.1 基本配置

在 application.yml 文件中，可以定义各种配置项。例如：

server:
  port: 8080
  servlet:
    context-path: /myapp

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver

在这个例子中，我们配置了服务器的端口号、上下文路径，以及数据库的连接信息。

2.2 配置环境变量

Spring Boot支持通过环境变量来覆盖配置文件中的值。例如，可以通过设置环境变量 SPRING_DATASOURCE_URL 来覆盖 spring.datasource.url 的值。

export SPRING_DATASOURCE_URL=jdbc:mysql://localhost:3306/mydb

2.3 配置多环境

在实际开发中，通常需要为不同的环境（如开发、测试、生产）配置不同的参数。Spring Boot支持通过 application-{profile}.yml 文件来配置不同环境的参数。

例如，可以创建以下文件：

• application-dev.yml：开发环境配置
• application-test.yml：测试环境配置
• application-prod.yml：生产环境配置

在 application.yml 中，可以通过 spring.profiles.active 来指定当前激活的环境：

spring:
  profiles:
    active: dev

2.4 配置列表和对象

YAML支持列表和对象的配置。例如，可以配置一个包含多个数据源的列表：

spring:
  datasource:
    sources:
      - url: jdbc:mysql://localhost:3306/db1
        username: user1
        password: pass1
      - url: jdbc:mysql://localhost:3306/db2
        username: user2
        password: pass2

在Java代码中，可以通过 @ConfigurationProperties 注解将这些配置项注入到Bean中：

@Configuration
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {
    private List<DataSource> sources;

    // getters and setters

    public static class DataSource {
        private String url;
        private String username;
        private String password;

        // getters and setters
    }
}

2.5 配置占位符

Spring Boot支持在YAML配置文件中使用占位符来引用其他配置项。例如：

app:
  name: MyApp
  description: The name of the application is ${app.name}

在这个例子中，description 的值将会是 The name of the application is MyApp。

2.6 配置默认值

Spring Boot还支持在占位符中指定默认值。如果引用的配置项不存在，则使用默认值。例如：

app:
  name: MyApp
  description: The name of the application is ${app.name:DefaultApp}

如果 app.name 不存在，description 的值将会是 The name of the application is DefaultApp。

3. YAML配置的加载顺序

Spring Boot在加载配置文件时，会按照一定的顺序进行加载。以下是配置文件的加载顺序：

1. application.yml 或 application.yaml：主配置文件。
2. application-{profile}.yml 或 application-{profile}.yaml：特定环境的配置文件。
3. 命令行参数：通过命令行传递的参数会覆盖配置文件中的值。
4. 环境变量：通过环境变量传递的参数会覆盖配置文件中的值。

4. YAML配置的验证

Spring Boot提供了对YAML配置的验证功能。可以通过 @Validated 和 @ConfigurationProperties 注解来验证配置项的有效性。例如：

@Configuration
@ConfigurationProperties(prefix = "app")
@Validated
public class AppConfig {
    @NotNull
    private String name;

    @Size(min = 5, max = 100)
    private String description;

    // getters and setters
}

在这个例子中，name 和 description 配置项将会被验证。如果配置项不符合要求，应用程序启动时会抛出异常。

5. 总结

YAML是一种非常适合用于配置文件的格式，Spring Boot对YAML的支持使得配置文件的编写更加简洁和灵活。通过本文的介绍，你应该已经掌握了如何在Spring Boot中使用YAML进行配置，包括基本配置、多环境配置、列表和对象的配置、占位符的使用以及配置的验证等。

在实际开发中，合理使用YAML配置文件可以大大提高应用程序的可维护性和可扩展性。希望本文对你有所帮助，祝你在Spring Boot的开发中取得更大的成功！