spring boot properties 切换 yaml

原创

mob649e8166858d 2023-09-24 15:50:26 ©著作权

文章标签 配置文件 java xml 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e8166858d的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot Properties 切换 YAML 实现流程

1. 概述

在Spring Boot应用中，我们通常使用.properties文件或者.yaml文件来配置应用的属性。而有时候，我们需要在不同的环境中切换或者覆盖这些属性，以满足不同环境下的需求。本文将介绍如何使用Spring Boot来实现.properties文件和.yaml文件的切换。

2. 实现步骤

下面是整个实现流程的步骤表格：

步骤	操作
1	添加依赖
2	创建不同环境的配置文件
3	创建配置类
4	注入配置属性
5	使用配置属性

接下来我们来逐步进行操作。

2.1 添加依赖

首先，我们需要在pom.xml文件中添加相应的依赖。Spring Boot提供了专门的依赖管理，我们只需要添加以下依赖即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

2.2 创建不同环境的配置文件

在src/main/resources目录下创建不同环境的配置文件，以.yaml或.properties为后缀。比如我们创建application-dev.yaml和application-prod.yaml两个文件，分别表示开发环境和生产环境的配置文件。

2.3 创建配置类

创建一个配置类，用于加载配置文件中的属性。该类需要使用@ConfigurationProperties注解，并指定前缀，以便将配置文件中的属性与该类的属性进行匹配。

@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    // 其他属性
    
    // 省略 getter 和 setter 方法
}

2.4 注入配置属性

在Application类中，使用@EnableConfigurationProperties注解来启用配置属性的注入。并将配置类作为参数传入。

@SpringBootApplication
@EnableConfigurationProperties(MyAppProperties.class)
public class Application {
    // 程序入口
    
    // 省略其他代码
}

2.5 使用配置属性

在需要使用配置属性的地方，通过注入的方式来使用。比如在一个Service类中：

@Service
public class MyService {
    private final MyAppProperties myAppProperties;
    
    public MyService(MyAppProperties myAppProperties) {
        this.myAppProperties = myAppProperties;
    }
    
    public void doSomething() {
        String appName = myAppProperties.getName();
        // 使用配置属性
    }
}

3. 类图

下面是相关类的类图，使用Mermaid语法进行表示：

classDiagram
    class Application
    class MyAppProperties
    class MyService
    Application --> MyAppProperties
    MyService --> MyAppProperties