Spring Boot 是一种广泛使用的开源框架，它简化了基于 Spring 的应用程序的开发过程。Spring Boot 提供了大量的自动配置选项和开箱即用的功能，其中一个重要的特性就是外部配置文件的加载。通过外部配置文件，开发者能够轻松地管理应用程序的配置项，而无需在代码中硬编码这些值。本文将详细介绍 Spring Boot 如何加载外部配置文件，并通过代码示例进行说明。
一、Spring Boot 外部配置文件的加载机制
Spring Boot 支持多种来源的配置文件，主要包括：
- application.properties：默认的配置文件，位于
src/main/resources目录下。 - application.yml：YAML 格式的配置文件，也是默认配置文件。
- 外部配置文件：可以在运行时通过命令行参数、环境变量、JNDI、系统属性等方式指定外部配置文件。
外部配置文件的优先级高于默认的 application.properties 和 application.yml 文件。
二、加载外部配置文件的方式
1. 使用 --spring.config.location 指定外部配置文件
我们可以在启动 Spring Boot 应用时，通过命令行参数指定外部配置文件的位置。示例如下：
java -jar app.jar --spring.config.location=file:/path/to/config/application.properties
2. 使用环境变量
也可以通过设置环境变量 SPRING_CONFIG_LOCATION 来指定外部配置文件：
export SPRING_CONFIG_LOCATION=file:/path/to/config/application.properties
3. 通过 YAML 文件
Spring Boot 还支持使用 YAML 格式的配置文件，使用方式与 properties 文件相同。例如，我们可以创建一个 application.yml 文件，如下所示：
server:
port: 8081
spring:
datasource:
url: jdbc:mysql://localhost:3306/db
username: root
password: password
同样可以通过 --spring.config.location 参数加载。
三、示例代码
以下示例展示了如何读取外部配置文件中的配置项。假设我们有一个 application.properties 文件，内容如下：
app.name=My Spring Boot Application
app.version=1.0.0
首先，创建一个配置类来读取这些配置：
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
private String name;
private String version;
// Getters and setters
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getVersion() {
return version;
}
public void setVersion(String version) {
this.version = version;
}
}
接下来，在主应用类中使用 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) {
System.out.println("Application Name: " + appConfig.getName());
System.out.println("Application Version: " + appConfig.getVersion());
}
}
四、总结
通过以上步骤，我们可以轻松地在 Spring Boot 应用中加载外部配置文件。外部配置文件提供了灵活性，使得我们能够在不同的环境中使用不同的配置，而无需对代码进行修改。此外，Spring Boot 提供的多种方式来指定配置文件的位置，为应用的部署提供了极大的便利。希望通过本文的介绍，能够帮助大家更好地理解和运用 Spring Boot 加载外部配置文件的机制。
