读取配置文件的顺序 spring boot

原创

mob64ca12ee66e3 2024-10-10 04:37:39 ©著作权

文章标签 配置文件 spring 流程图 文章分类 spring boot 后端开发

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

读取配置文件的顺序：Spring Boot

在使用Spring Boot的时候，配置文件的管理非常重要。Spring Boot 提供了多种方式来读取和管理应用的配置，这些配置可以影响到应用的各个方面，包括数据库连接、服务端口等等。理解配置文件的读取顺序，对于调试和优化应用至关重要。

配置文件的默认位置

Spring Boot 默认的配置文件位置是 classpath:/ 和 file:./。这意味着你可以在类路径下的根目录或者项目根目录下放置配置文件。

默认配置文件名

Spring Boot 默认支持以下文件名格式的配置文件：

application.properties
application.yml
application.yaml
application.json

如果你的项目包含多个配置文件，可以通过不同的文件名来区分不同的环境，比如 application-dev.properties、application-test.properties。

读取配置文件的顺序

Spring Boot 在启动时会按照一定的顺序读取这些配置文件，具体顺序如下：

application-{profile}.properties 或 application-{profile}.yml
application.properties 或 application.yml
外部配置文件，通常是在命令行参数中传递的文件路径
系统环境变量
JNDI属性
ServletContext初始化参数
@Value 注解中的默认值
应用启动时通过 -D 参数设置的属性

流程图

下面是配置文件读取顺序的流程图，用 mermaid 语法表示：

flowchart TD
    A[application-{profile}.properties/yml] --> B[application.properties/yml]
    B --> C[外部配置文件]
    C --> D[系统环境变量]
    D --> E[JNDI属性]
    E --> F[ServletContext初始化参数]
    F --> G[@Value注解中的默认值]
    G --> H[-D参数设置的属性]

使用示例

除了默认的配置文件，Spring Boot 还允许您通过 @ConfigurationProperties 注解来集中管理配置信息。以下是一个简单的示例：

1. 创建配置类

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

@Component
@ConfigurationProperties(prefix = "user")
public class UserProperties {
    private String name;
    private int age;

    // getters and setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

2. 创建配置文件

在 application.properties 文件中添加以下内容：

user.name=John Doe
user.age=30

3. 使用配置

在你的服务类中，你可以通过依赖注入来使用这些配置：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    private final UserProperties userProperties;

    @Autowired
    public UserService(UserProperties userProperties) {
        this.userProperties = userProperties;
    }

    public void printUserInfo() {
        System.out.println("User Name: " + userProperties.getName());
        System.out.println("User Age: " + userProperties.getAge());
    }
}