学透Spring Boot — 007. 加载外部配置

Spring Boot会从多个目录下查找并加载配置。我们今天来学习这几种加载外部应用配置的方式。

默认目录 classpath

Spring Boot 默认会从 classpath 下加载application.properties或者application.yaml配置。这也是大部分项目默认使用的方式。

项目中最常用的也是默认的classpath是src/main/resources/

properties 复制代码
server.port=9001
默认目录 classpath下的config目录

在classpath下的config目录的配置,也会被Spring Boot 默认加载。

根目录下的config目录

项目根目录下的config目录的配置也会被默认加载,而且优先级比classpath下的更高。

修改默认加载目录 spring.config.location

有时候我们不想从classpath中加载,而是一个自定义的目录作为我们的配置目录,这时候 spring.config.location 这个配置项就起作用了。

我们可以在环境变量、系统变量或者命令行参数中使用这个配置项。

这样,Spring Boot就把项目根目录下的abc-test目录下的application.properties作为我们的配置。

特别注意的是,我们使用了这种配置后,src/main/resources这种classpath下的配置就失效了,Spring Boot不会去加载。

或者我们可以指定某个目录

复制代码
-Dspring.config.location=file:./abc-test/

像前面,我们可以根据文件相对路径和绝对路径file:./abc-test

我们也可以指定classpath下的某个folder

复制代码
-Dspring.config.location=classpath:custom-config/

不管配置file:./XXX 或者 classpath:XXX,如果XXX 目录不存在,应用启动会失败。

要解决这个问题,我们可以加上optional的选项。

加载额外配置 additional-location

前面说过 spring.config.location 会导致src/main/resources这个配置路径失效,这通常是我们不期望的。怎么保留src/main/resources的前提下,加载其它folder的配置呢?

这时候,我们可以使用spring.config.additional-location 这个配置项。

导入额外的配置 import

类似 spring.config.location 配置,我们还有一种方法,在保留加载classpath的前提下,还能加载外部配置。

src/main/resources/application.properties

复制代码
spring.config.import=file:./abc-test/

或者指定具体的配置文件

复制代码
spring.config.import=file:./abc-test/hello.properties

也可以是一个yaml格式的配置

复制代码
spring.config.import=file:./abc-test/hello.yaml

hello.yaml

复制代码
server:
  port: 9008
加载json作为配置

如果某些场景,我们需要加载一个json文件作为我们的应用配置,Spring Boot支持这种配置方式吗?

让我们来试试

然后我们来试试使用import的方式

src/main/resources/application.properties

复制代码
spring.config.import=file:./abc-test/hello.json

非常可惜的是,启动应用报错:

Unable to load config data from 'file:./abc-test/hello.json'

File extension is not known to any PropertySourceLoader. If the location is meant to reference a directory, it must end in '/' or File.separator

查看Spring Boot的源码可以知道,原来Spring boot的import只支持两种文件后缀

  • properties
  • yaml

还支持目录.

复制代码
spring.config.import=file:./abc-test/

这样能加载abc-test目录下的hello.json配置吗?很可惜,不支持。

后来我想当一种walkaround,把app.json的后缀改一下可以吗?

居然可以!!!!

根本原因

Json is subset of yaml

Json 是 Yaml的子集。

相关推荐
麻雀聊技术9 分钟前
一重启 AI 就失忆?用 Spring AI + PostgreSQL 3步搞定“长期记忆”持久化(附完整代码)
java·spring·openai
码农进化录18 分钟前
Java 程序员的 AI 进化论 | LangChain4j 入门,Java 开发者的 AI 应用框架
java·spring boot·openai
淡淡的香烟41 分钟前
AndroidAI使用心得
android
番茄炒鸡蛋加糖1 小时前
中级核心技术1--MySQL/Java 并发
java·数据库·mysql
he___H1 小时前
Spring-Configur注解
java·spring
chjif1 小时前
Android 设备管控开发实战:无障碍如何准确识别当前前台 App?
android
chjif1 小时前
Android 设备管控开发实战:企业受控终端的 DNS 域名策略实现
android·华为·harmonyos
SunnyDays10112 小时前
Java 如何为 PDF 添加、修改和删除书签
java·pdf
铃木之影2 小时前
Java 版本 RAG 示例(Spring AI + Milvus)
java·人工智能·spring
C++、Java和Python的菜鸟2 小时前
第14章 项目部署(Linux)
java