首页 > 资讯中心 > 手机教程 > 安卓教程
Spring Boot读取外部配置文件失败,原因绝对出乎你意料
2024-12-03 10:06:27 作者:佚名

开心一刻

今天和相亲对象见面,特意打扮了一番
见完面回到家后我给她发微信
我:我今天的形象怎么样
她:挺白净亮眼的
我:头发不油吧
她:反光,没看清
我:???

知识回顾

在我们的实际开发工程中,打包的 jar 通常会包含配置文件(例如: application.yml )来作为默认配置文件,然后在不同的环境用外部配置文件来覆盖 jar 包中配置文件配置的某些配置项,当然也可以全量覆盖;Spring Boot 关于外部配置( Externalized Configuration )有这么一段说明

我给大家翻译一下

应用启动时,Spring Boot会自动从以下位置查找并加载 application.properties application.yaml

  1. 从类路径

    a. 类路径根目录

    src/main/resources 下的文件,默认情况下会被打包到类路径(classpath)下

    b. 类路径下的 config

  2. 从当前目录

    a. 当前目录,也就 jar 所在目录

    b. 当前目录下的 config 目录

    c. 当前目录下的 config 目录的直接子目录

Spring Boot 会按如上顺序从上往下查找并加载 application.properties application.yaml ,如果配置项重命名了,后加载的值会覆盖掉之前加载的值。配置文件中的配置项会以 PropertySources 实例的形式添加到 Spring 环境中

我们来看个示例: spring-boot-external-config ,代码非常简单,我们只需要关注 ConfigDemo.java

/**
 * @author: 青石路
 */
@ComPONEnt
public class ConfigDemo implements InitializingBean {

    private static final Logger LOGGER = LoggerFactory.getLogger(ConfigDemo.class);

    @Value("${retry.times}")
    private Integer retryTimes;
    @Value("${http.url}")
    private String httpUrl;

    @Override
    public void afterPropertiesSet() throws Exception {
        LOGGER.info("retryTimes:{}, httpUrl:{}", retryTimes, httpUrl);
    }
}

application.yml 内容如下

retry:
  times: 6
http:
  url: http://localhost:8080

我相信你们都能看懂,通过 Spring 注入进来两个配置项( retry.times http.url )值,当应用中的全部属性都设置完成之后,Spring 会调用 afterPropertiesSet 方法,日志输出 retryTimes httpUrl 的值。结合上述的加载顺序,我们来验证下是否如 Spring Boot 官方所说

  1. 从类路径

    这个我们只验证一种情况:类路径下只存在 application.yml ;验证非常简单,直接在 jar 所在目录下

    执行

    java -jar spring-boot-external-config-1.0-SNAPSHOT.jar
    

    可以看到输出如下

    是不是没毛病?

  2. 从当前目录

    在 jar 所在目录下放一个 application.yml

    其内容如下

    retry:
      times: 2
    

    我特意拿掉了配置项 http.url ,同样直接执行

    java -jar spring-boot-external-config-1.0-SNAPSHOT.jar
    

    输出结果如下

    红框框住的值与蓝框框住的值,它们分别来自哪个配置文件,你们应该知道吧;也如 Spring Boot 官方所说,非常正常。我们再在当前目录下加个 config 目录

    其下放一个 application.yml ,内容如下

    retry:
      times: 9
    http:
      url: http://127.0.0.1:8080
    

    执行结果如下

    也如 Spring Boot 官方描述的那样,没有任何毛病

    为了保持部署结构的简单清晰,我们往往会采用 config 目录的这种方式来放外部配置文件,包括应用配置文件、日志配置文件等等;但如果外部配置文件跟当前目录没有直接关系了,比如在其他盘或者其他目录下,那么如何指定外部配置文件呢?有但不限于如下两种( 仔细斟酌如下写法是否正确

    1. java -jar spring-boot-external-config-1.0-SNAPSHOT.jar -Dspring.config.location=外部文件路径
    2. java -jar spring-boot-external-config-1.0-SNAPSHOT.jar --spring.config.location=外部文件路径

    外部文件按路径可以是绝对路径,也可以是相对路径,如果是相对路径,则以 jar 包所在的目录开始算

复现问题

一切准备就绪,我们往 Linux 服务器上部署,先将 spring-boot-external-config-1.0-SNAPSHOT.jar 上传到服务器,执行

java -jar spring-boot-external-config-1.0-SNAPSHOT.jar

日志输出如下

这是 jar 中默认配置文件的配置值,没问题吧?我们再上传 jar 同级目录下的 config 文件夹,上传后目录结构如下

执行后日志输出如下

也和在 windows 上的演示结果一样,很正常。绝大部分情况下,我们的配置文件不止一个,所以从命名的准确性考虑,我们往往会将 config 目录命名成 configs

那么此时启动命令就需要调整下了

java -jar spring-boot-external-config-1.0-SNAPSHOT.jar -Dspring.config.location=configs/application.yml

java -jar spring-boot-external-config-1.0-SNAPSHOT.jar --spring.config.location=configs/application.yml

我们以 -D 的形式启动下,日志输出如下

这输出的还是 jar 包中的配置项值,并非 configs 目录下 application.yml 中的配置项值,读取外部配置文件失败了?带着疑问我们尝试下 -- 方式

java -jar spring-boot-external-config-1.0-SNAPSHOT.jar --spring.config.location=configs/application.yml

发现能够正常加载

为什么 -D 的方式会失败?

解决问题

出题出在哪,就出在 java 命令参数的顺序上,我们看下 java 命令的帮助文档

也就是说 -D -- 需要在 -jar 前面,所以正确读取 configs 目录下配置文件的命令应该是

java -Dspring.config.location=configs/application.yml -jar spring-boot-external-config-1.0-SNAPSHOT.jar

执行结果如下

总结

  1. 常用加载外部配置文件的命令参数

    java -Dspring.config.location=configs/application.yml -jar spring-boot-external-config-1.0-SNAPSHOT.jar

    java -jar spring-boot-external-config-1.0-SNAPSHOT.jar --spring.config.location=configs/application.yml

    -D 紧随 java 之后,在 -jar 之前,是 JVM 参数; -- 在 jar 名称之后,是 Spring Boot 命令行参数。两种方式有其各自的顺序写法,切勿张冠李戴!

  2. 推荐做法

    在 jar 包所在目录创建 config 文件夹,将外部配置文件置于该 config 文件夹下,启动的时候可以减少启动参数,那么出错的概率就会降低

相关下载
相关文章

玩家评论