Springboot的yml配置文件怎么使用

在Spring Boot项目中，配置文件是非常重要的一部分，它用于配置应用程序的各种参数和属性。Spring Boot支持多种配置文件格式，其中最常见的是properties文件和yml文件。本文将详细介绍如何在Spring Boot项目中使用yml配置文件。

1. YAML简介

YAML（YAML Ain’t Markup Language）是一种人类可读的数据序列化格式，通常用于配置文件。与properties文件相比，yml文件具有更好的可读性和结构化特性。YAML使用缩进来表示层级关系，因此它的格式更加清晰。

1.1 YAML的基本语法

• 键值对：使用:分隔键和值，键和值之间需要有一个空格。

  key: value
  

• 列表：使用-表示列表项。 “`yaml list:

  • item1
  • item2
  • item3

  ”`

• 嵌套结构：通过缩进来表示嵌套关系。

  parent:
  child:
    key: value
  

• 多行字符串：使用|表示多行字符串，保留换行符。

  description: |
  This is a multi-line
  string in YAML.
  

• 折叠字符串：使用>表示折叠字符串，换行符会被替换为空格。

  description: >
  This is a folded
  string in YAML.
  

2. Spring Boot中的YAML配置文件

在Spring Boot项目中，application.yml是默认的配置文件名称。Spring Boot会自动加载application.yml文件中的配置，并将其注入到应用程序中。

2.1 基本配置

在application.yml中，我们可以配置一些基本的属性，例如服务器端口、应用名称等。

server:
  port: 8080

spring:
  application:
    name: myapp

在上面的例子中，我们配置了服务器的端口为8080，应用的名称是myapp。

2.2 多环境配置

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

例如，我们可以创建以下配置文件：

• application-dev.yml：开发环境配置

  server:
  port: 8081
  

• application-prod.yml：生产环境配置

  server:
  port: 8082
  

在application.yml中，我们可以通过spring.profiles.active属性来指定当前激活的环境。

spring:
  profiles:
    active: dev

这样，当应用程序启动时，Spring Boot会自动加载application-dev.yml中的配置。

2.3 配置注入

Spring Boot允许我们将配置文件中的属性注入到Java类中。常用的注解有@Value和@ConfigurationProperties。

2.3.1 使用@Value注解

@Value注解可以将配置文件中的属性值直接注入到类的字段中。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConfig {

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

    public int getServerPort() {
        return serverPort;
    }
}

在上面的例子中，server.port的值会被注入到serverPort字段中。

2.3.2 使用@ConfigurationProperties注解

@ConfigurationProperties注解可以将配置文件中的一组属性绑定到一个Java类中。

myapp:
  name: My Application
  version: 1.0.0

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {

    private String name;
    private String version;

    // Getters and Setters
}

在上面的例子中，myapp.name和myapp.version的值会被绑定到MyAppProperties类的name和version字段中。

2.4 配置文件的优先级

Spring Boot支持多种配置文件的加载顺序，优先级从高到低依次为：

1. 命令行参数
2. application-{profile}.yml（特定环境的配置文件）
3. application.yml（默认配置文件）
4. application.properties（默认配置文件）

如果同一个属性在多个配置文件中被定义，优先级高的配置文件中的值会覆盖优先级低的配置文件中的值。

3. 高级配置

3.1 配置文件的占位符

在yml文件中，我们可以使用占位符来引用其他属性的值。

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

在上面的例子中，description的值会引用app.name的值。

3.2 配置文件的加密

在某些情况下，我们可能需要对配置文件中的敏感信息（如数据库密码）进行加密。Spring Boot本身不提供加密功能，但我们可以使用第三方库（如Jasypt）来实现配置文件的加密。

首先，我们需要在pom.xml中添加Jasypt的依赖：

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.4</version>
</dependency>

然后，在application.yml中配置加密的密码：

jasypt:
  encryptor:
    password: mysecretkey

spring:
  datasource:
    password: ENC(encryptedPassword)

在上面的例子中，spring.datasource.password的值是加密后的密码，Jasypt会在运行时自动解密。

3.3 配置文件的动态刷新

Spring Boot支持在运行时动态刷新配置文件中的属性。我们可以使用@RefreshScope注解来实现这一功能。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Component
@RefreshScope
public class MyConfig {

    @Value("${app.name}")
    private String appName;

    public String getAppName() {
        return appName;
    }
}

在上面的例子中，当配置文件中的app.name发生变化时，appName字段的值会自动刷新。

4. 总结

yml配置文件是Spring Boot项目中常用的配置文件格式，它具有结构清晰、可读性强的特点。通过本文的介绍，我们了解了如何在Spring Boot项目中使用yml配置文件，包括基本配置、多环境配置、配置注入、配置文件优先级、占位符、加密和动态刷新等高级功能。掌握这些知识，可以帮助我们更好地管理和维护Spring Boot项目的配置。