手动添加 Spring Boot 配置文件方法

Spring Boot 手动添加配置文件的方法

在 Spring Boot 项目中，配置文件是非常重要的部分，它定义了应用程序的各种配置参数，如数据库连接信息、日志设置等。默认情况下，Spring Boot 会自动加载位于 src/main/resources 目录下的 application.properties 或 application.yml 文件，但在一些复杂的场景中，可能需要手动添加或加载多个配置文件。本文将详细介绍如何在 Spring Boot 项目中手动添加和管理配置文件。

1. 默认配置文件的加载顺序

Spring Boot 默认会按照以下顺序加载配置文件（按优先级从高到低排列）：

1. 命令行参数：通过 -- 参数传递的配置值，例如 --server.port=8081。
2. application.properties 或 application.yml 文件：存放在 src/main/resources 目录下的默认配置文件。
3. 外部的 application.properties 或 application.yml 文件：例如通过环境变量或系统属性指定的外部文件。
4. 系统环境变量：例如 SERVER_PORT。
5. 默认属性：Spring Boot 内部的默认配置。

但是，开发者可以根据需要手动指定其他配置文件进行加载，并控制其优先级。

2. 手动添加和加载配置文件的方法

2.1 在 application.properties 中引用其他配置文件

Spring Boot 支持在默认的 application.properties 中通过 spring.config.import 引入其他配置文件。

步骤：

1. 在 src/main/resources 目录下创建多个配置文件，例如 application-prod.properties、application-dev.properties。
2. 在 application.properties 中通过 spring.config.import 引入这些文件。

# application.properties
spring.config.import=optional:classpath:application-dev.properties, optional:classpath:application-prod.properties

• 解释：optional: 表示配置文件是可选的，如果文件不存在也不会报错。这样做可以根据不同环境加载不同的配置文件。

2.2 通过 @PropertySource 注解加载自定义配置文件

如果需要在某个类中加载自定义的配置文件，可以使用 Spring 提供的 @PropertySource 注解。这种方式通常用于手动加载额外的配置文件。

步骤：

1. 创建自定义的配置文件，例如 custom-config.properties。
2. 在 Spring Boot 的配置类中使用 @PropertySource 注解加载该文件。

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:custom-config.properties")
public class CustomConfig {
    // 其他配置
}

• 解释：@PropertySource 注解可以加载指定的配置文件，文件路径可以是 classpath:、file: 等格式。

2.3 在启动时指定外部配置文件

在实际生产环境中，可能需要通过命令行参数指定外部配置文件。可以通过启动参数 --spring.config.location 来指定外部配置文件的位置。

步骤：

1. 在外部创建一个配置文件，例如 /etc/myapp/config/application-external.properties。
2. 在启动应用时，使用 --spring.config.location 指定该文件：

java -jar myapp.jar --spring.config.location=/etc/myapp/config/application-external.properties

• 解释：--spring.config.location 用于指定配置文件的完整路径，Spring Boot 会在启动时加载该文件并覆盖默认的配置。

2.4 使用 SpringApplication.setDefaultProperties 方法

开发者还可以通过编程方式手动设置默认配置。在应用启动时，可以调用 SpringApplication.setDefaultProperties 方法加载自定义的配置项。

示例代码：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import java.util.HashMap;
import java.util.Map;

@SpringBootApplication
public class MyApp {

    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(MyApp.class);

        // 手动设置默认配置
        Map<String, Object> defaultProps = new HashMap<>();
        defaultProps.put("server.port", "8081");
        defaultProps.put("spring.datasource.url", "jdbc:mysql://localhost:3306/mydb");

        app.setDefaultProperties(defaultProps);
        app.run(args);
    }
}

• 解释：通过 app.setDefaultProperties 设置的配置项会覆盖应用中默认的配置，适合在代码中手动调整一些动态配置。

3. 基于环境的多配置文件管理

在开发、测试和生产环境中，不同的环境可能需要不同的配置文件，Spring Boot 支持通过环境变量来区分不同的配置。

3.1 使用 application-{profile}.properties 文件

步骤：

1. 在 src/main/resources 目录下创建不同环境的配置文件，如 application-dev.properties、application-prod.properties。
2. 在 application.properties 中设置当前激活的配置文件：

# application.properties
spring.profiles.active=dev

当 spring.profiles.active=dev 时，application-dev.properties 文件中的配置会被加载。

3.2 通过命令行激活不同环境的配置

你还可以通过启动时的命令行参数来激活不同的环境：

java -jar myapp.jar --spring.profiles.active=prod

这种方式适合在部署时动态切换不同的环境配置。

4. 结合 YAML 格式管理配置

Spring Boot 除了支持 properties 文件外，也支持 YAML 格式的配置文件。YAML 格式比 properties 更加简洁和易读。

4.1 YAML 配置文件示例

# application.yml
server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: password

4.2 多环境配置的 YAML 文件

你可以在一个 application.yml 文件中同时管理多个环境的配置：

# application.yml
server:
  port: 8080

spring:
  profiles:
    active: dev

---
spring:
  profiles: dev
  datasource:
    url: jdbc:mysql://localhost:3306/devdb

---
spring:
  profiles: prod
  datasource:
    url: jdbc:mysql://localhost:3306/proddb

根据激活的 profile，Spring Boot 会自动加载对应的配置节，例如 spring.profiles.active=prod 时，prod 节点下的配置会被加载。

5. 总结

通过本文的介绍，你可以掌握多种在 Spring Boot 项目中手动添加和管理配置文件的方法。无论是通过命令行指定外部配置文件、使用 @PropertySource 动态加载，还是基于环境的多配置文件管理，Spring Boot 提供了灵活而强大的配置管理机制。合理运用这些方法，可以帮助开发者在复杂环境中更好地管理和维护应用配置。