SpringBoot读取配置文件

最新推荐文章于 2025-04-25 10:28:45 发布

小海子l

最新推荐文章于 2025-04-25 10:28:45 发布

阅读量1.4k

点赞数

分类专栏： SpringBoot 文章标签： java spring springboot

本文链接：https://blog.youkuaiyun.com/lhc_makefunny/article/details/123973245

版权

SpringBoot 专栏收录该内容

13 篇文章

订阅专栏

本文介绍了SpringBoot项目中外部配置的使用方法，包括配置文件在Jar包内外的启动方式及其问题。针对配置更新不便和配置分散的问题，提出了使用@ConfigurationProperties注解进行优化，增强了代码的可读性和配置的提示功能。同时，文章强调了配置管理的重要性，并提供了配置文件管理和校验的实践建议。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

最近入职了新公司也接触了几个项目。由于单体项目居多数，生产和测试环境使用外置配置文件的方式启动SpringBoot。虽然在此前也接触过上述启动方式，但在使用操作过程中，也出现了知识盲区，导致在晚上上线的时候耽误了很多时间，并产生误判。综上所述，针对SpringBoot外部参数配置做出如下记录。如果错误欢迎指正，谢谢！

使用

在开始之前，先说说我之前如何启动一个SpringBoot项目的。

配置文件在Jar包内

当只有一个application.properties或application.yml文件时，项目启动时会读取其中的相关配置；
针对项目部署环境指定不同的配置文件，例如：application-dev.yml、application-test.yml和application-prod.yml，在主配置文件application.yml中使用spring.profiles.active指定环境即可；

配置文件在Jar包外

在启动Jar包时，通过命令行指定配置文件路径，例如：

java -jar app.jar --spring.config.location=/mnt/app/application.yml

存在的问题

当配置文件在Jar包内，在服务器端部署时需要临时修改某个配置，此时就需要后端开发人员重新打包才可以；
spring.config.location可以指定为文件夹或文件，这里涉及到配置文件合并问题；

针对第一个问题可以在启动的命令中加入指定变量的值，例如：

# 修改启动端口;
java -jar app.jar --server.port=8081

# 修改变量name的值
java -jar app.jar --name='张三'

针对第二个问题就要依据实际情况处理，若将公共配置保存在单独的配置文件，可以指定为文件夹否则指定为具体文件，如下：

# 指定为文件夹下的所有配置文件
java -jar --spring.config.location=/mnt/config/*

# 指定为具体的文件夹
java -jar app.jar --spring.config.location=/mnt/config/application-prod.properties

原理

SpringBoot是如何找到配置文件的

在ConfigDataEnvironment类中定义了配置文件应该存放的路径

在这里插入图片描述

以及通过日志查看搜寻记录
在这里插入图片描述

优化及改善

在编写配置文件时，总存在一些自定义配置，例如：

FTP相关配置，host、port等
开关配置,switch=true
与对接外部系统的参数配置

上述配置可以通过@Value()注解引入到具体的类中，但在这个过程中，配置零散的分布在不同的类中，且容易出现人为失误（大小写问题），在配置文件中编写时没有提示，造成了不确定性。为了解决这个问题，我个人更推荐使用@ConfigurationProperties注解，以类的形式注入并在编辑配置文件时出现完整的提示。

使用

添加相关依赖

<dependency>  
 <groupId>org.springframework.boot</groupId>  
 <artifactId>spring-boot-configuration-processor</artifactId>  
 <optional>true</optional>  
</dependency>

编写配置类

@Getter
@Setter
@Validated
@ConfigurationProperties(prefix = ServerConstant.OSS_PREFIX + CharPool.DOT + "qiniu", ignoreInvalidFields = true)
public class QiNiuOssProperties {
    /**
     * accessKey
     */
    @NotBlank(message = "[accessKey]不可为空")
    private String accessKey;
    /**
     * secretKey
     */
    @NotBlank(message = "[secretKey]不可为空")
    private String secretKey;
    /**
     * bucket
     */
    @NotBlank(message = "[bucket]不可为空")
    private String bucket;

    /**
     * 访问文件的域名
     */
    @NotBlank(message = "[domainOfBucket]不可为空")
    private String domainOfBucket;
}