spring boot 配置文件扫描

原创

mob64ca12f49f4b 2024-01-07 11:40:45 ©著作权

文章标签 配置文件 Bootstrap ci 文章分类 spring boot 后端开发

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

Spring Boot配置文件扫描

介绍

在使用Spring Boot开发项目时，我们经常需要配置一些参数和属性，这些配置文件通常以.properties或.yml的格式保存。Spring Boot提供了自动加载配置文件的功能，只需按照一定的规则将配置文件放置在指定的位置，就可以自动加载并注入到相应的Bean中。

配置文件的扫描规则

Spring Boot的配置文件扫描规则如下：

默认情况下，Spring Boot会自动加载application.properties或application.yml文件作为默认配置文件。
配置文件的加载顺序为：application.properties > application.yml > application-{profile}.properties > application-{profile}.yml，其中profile为当前激活的profile。
可以通过在application.properties或application.yml中指定spring.config.name和spring.config.location属性来指定其他的配置文件名和位置。
配置文件中的属性可以通过@Value注解或@ConfigurationProperties注解来注入到Bean中。

示例

假设我们有一个名为MailProperties的配置类，用于保存邮件相关的配置信息。

@Configuration
@ConfigurationProperties(prefix = "mail")
public class MailProperties {
    private String host;
    private int port;
    private String username;
    private String password;
    
    // 省略getter和setter方法
}

我们可以通过在application.properties或application.yml中配置相关属性来注入到MailProperties中。

mail.host=smtp.example.com
mail.port=587
mail.username=test@example.com
mail.password=secret

或者使用application.yml的格式：

mail:
  host: smtp.example.com
  port: 587
  username: test@example.com
  password: secret

然后我们可以在其他的Bean中使用@Autowired注解将MailProperties注入进来。

@Service
public class MailService {
    private final MailProperties mailProperties;
    
    @Autowired
    public MailService(MailProperties mailProperties) {
        this.mailProperties = mailProperties;
    }
    
    public void sendMail(String to, String subject, String text) {
        // 使用mailProperties中的配置信息发送邮件
    }
}

这样，我们就可以直接在MailService中使用mailProperties对象来获取配置的属性。

序列图

下面是一个使用Spring Boot加载配置文件的流程的序列图：

sequenceDiagram
    participant Client
    participant Bootstrap
    participant SpringApplication
    participant Environment
    participant Configuration
    participant Bean
    
    Client->>Bootstrap: 启动应用程序
    Bootstrap->>SpringApplication: 创建SpringApplication实例
    SpringApplication->>Environment: 加载默认配置文件
    Environment-->>SpringApplication: 返回默认配置
    SpringApplication->>Configuration: 创建配置类
    Configuration->>Environment: 获取配置属性
    Environment-->>Configuration: 返回配置属性值
    Configuration->>Bean: 注入配置属性
    Bean-->>Configuration: 返回Bean实例
    SpringApplication-->>Bootstrap: 返回ApplicationContext
    Bootstrap-->>Client: 返回ApplicationContext

旅行图

下面是一个使用Spring Boot加载配置文件的旅行图：

journey
    title Spring Boot配置文件扫描
    
    section 启动应用程序
        Client->Bootstrap: 启动应用程序
    
    section 加载配置文件
        Bootstrap->SpringApplication: 创建SpringApplication实例
        SpringApplication->Environment: 加载默认配置文件
        Environment-->>SpringApplication: 返回默认配置
    
    section 创建配置类
        SpringApplication->Configuration: 创建配置类
        Configuration->Environment: 获取配置属性
        Environment-->>Configuration: 返回配置属性值
        Configuration->Bean: 注入配置属性
        Bean-->>Configuration: 返回Bean实例
    
    section 返回ApplicationContext
        SpringApplication-->>Bootstrap: 返回ApplicationContext
        Bootstrap-->>Client: 返回ApplicationContext
    end