spring boot 项目启动修改配置文件属性

原创

mob64ca12d97dad 2025-01-02 04:25:04 ©著作权

文章标签 java spring 自定义 文章分类 spring boot 后端开发

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

如何在 Spring Boot 项目启动时修改配置文件属性

当我们在使用 Spring Boot 开发项目时，通常需要对配置文件中的属性进行修改，以满足不同环境或需求的要求。本文将教你如何在 Spring Boot 项目启动时修改配置文件的属性。我们将按照一定的流程逐步进行讲解，并提供代码示例和注释。

整体流程

首先，我们需要理清楚整个流程。下面是修改 Spring Boot 项目配置的基本步骤：

步骤	描述
1	创建 Spring Boot 项目
2	添加配置属性
3	创建自定义配置类
4	在应用启动时修改属性
5	验证修改是否成功

接下来，我们将逐步解释每个步骤。

步骤详解

1. 创建 Spring Boot 项目

你可以使用 Spring Initializr ( 创建一个新的 Spring Boot 项目，选择合适的依赖项，生成项目并下载到本地。解压后导入你的 IDE（如 IntelliJ IDEA 或 Eclipse）。

2. 添加配置属性

在 src/main/resources/application.properties 文件中，添加你需要的配置属性。例如，我们添加一个名为 app.custom.prop 的配置属性：

# src/main/resources/application.properties
app.custom.prop=default_value

3. 创建自定义配置类

在项目中创建一个配置类，使用 @ConfigurationProperties 注解来绑定配置属性。我们先创建一个简单的 POJO 类来映射我们的配置属性。

// src/main/java/com/example/demo/config/AppConfig.java
package com.example.demo.config;

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

@Component
@ConfigurationProperties(prefix = "app.custom")
public class AppConfig {
    private String prop;

    public String getProp() {
        return prop;
    }

    public void setProp(String prop) {
        this.prop = prop;
    }
}

代码说明：

@ConfigurationProperties(prefix = "app.custom"): 该注解用于指明该类为配置属性类，并将 app.custom 前缀的属性映射到该类的字段。
getProp() 和 setProp(String prop): 这两个方法用于获取和设置 prop 属性值。

4. 在应用启动时修改属性

我们可以使用 @PostConstruct 注解或实现 ApplicationRunner 接口，在 Spring Boot 应用启动时修改属性。以下是使用 ApplicationRunner 的示例：

// src/main/java/com/example/demo/MyApplication.java
package com.example.demo;

import com.example.demo.config.AppConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication implements CommandLineRunner {

    @Autowired
    private AppConfig appConfig;

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

    @Override
    public void run(String... args) throws Exception {
        // 修改配置属性
        appConfig.setProp("modified_value");
        System.out.println("Modified Property: " + appConfig.getProp());
    }
}

代码说明：

CommandLineRunner: 这是一个 Spring Boot 提供的接口，可以在应用启动后进行一些操作。
@Autowired: 注入 AppConfig 类，以便访问它的属性。
在 run 方法中，我们将 prop 属性的值修改为 "modified_value"。

5. 验证修改是否成功

你可以通过在 MyApplication 类的 run 方法中打印出修改后的属性值，来验证修改是否成功。在控制台中，你会看到以下输出：

Modified Property: modified_value

类图

我们可以用 UML 类图来展示这个示例中的类结构：

classDiagram
    class AppConfig {
        +String prop
        +String getProp()
        +void setProp(String prop)
    }
    class MyApplication {
        +static void main(String[] args)
        +void run(String... args)
    }
    MyApplication --> AppConfig : injects