我提交的 PR #52666 被 Spring Boot 合并了。这个坑自己配项目时就可能碰到。我用 Spring Boot 4.0.9 复现时,把应用放在 app/,把要读的配置放在同一级的 config/,从 app/ 启动。在 application.properties 里只写这一行。Spring Boot PR #52666

spring.config.import=configtree:../config/

目录在,导入阶段也没抛异常,demo.banner 却读不到。我把 ../config/ 换成指向同一处的绝对路径,就改了这一行,值回来了。假如这个属性有默认值,程序还可能继续跑,直到结果不对才发现配置没读进来。

我怎么注意到这两个点

那天我在翻 Spring Boot 的外部配置源码,读到了配置树把「文件路径」变成「属性名」的地方。用过 Kubernetes 挂载配置的话,configtree: 这写法可能很眼熟:一个文件对应一个值。例如文件叫 demo.banner,里面写着 hello-configtree,就能从 Environment 里取到 demo.banner。子目录也会成为属性名的一部分。Spring Boot 配置树文档

我看到扫描文件时有一条过滤规则,路径里某一段只要以 .. 开头就跳过。想到 Kubernetes 目录里会有 ..data,这条规则很好理解。顺着调用往上看,我才发现传进去的是整条访问路径。

这里就有个问题:如果两个点出现在配置目录外面呢?比如从应用目录写 ../config/。我把问题缩成一个文件,用两种写法指向同一处,看 Spring 实际读出什么。

用 Spring Boot 4.0.9 复现 configtree 漏读

下面用 macOS、JDK 21 和 Spring Boot 4.0.9 跑过。不需要启动 Web 服务,只跑 Spring Boot 自己的 Config Data 加载流程。

先建目录。后面的命令都在 app/ 运行。

mkdir -p configtree-demo/app configtree-demo/config
printf '%s\n' hello-configtree > configtree-demo/config/demo.banner
cd configtree-demo/app

在 app/ 下新建 pom.xml,只加 Spring Boot 这一项依赖:

<project xmlns="http://maven.apache.org/POM/4.0.0">
  <modelVersion>4.0.0</modelVersion>
  <groupId>example</groupId>
  <artifactId>configtree-demo</artifactId>
  <version>1.0.0</version>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot</artifactId>
      <version>4.0.9</version>
    </dependency>
  </dependencies>
</project>

再建 Demo.java。我特意加了 <missing> 这个默认值,一眼就能看出属性有没有被导入。

import org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor;
import org.springframework.core.env.StandardEnvironment;

public class Demo {
    public static void main(String[] args) {
        var env = new StandardEnvironment();
        ConfigDataEnvironmentPostProcessor.applyTo(env);
        System.out.println("demo.banner=" + env.getProperty("demo.banner", "<missing>"));
    }
}
mvn -q dependency:build-classpath -Dmdep.outputFile=classpath.txt
javac -cp "$(cat classpath.txt)" Demo.java

java -Dspring.config.import=configtree:../config/ \
  -cp ".:$(cat classpath.txt)" Demo
# demo.banner=<missing>

java "-Dspring.config.import=configtree:$(cd ../config && pwd -P)/" \
  -cp ".:$(cat classpath.txt)" Demo
# demo.banner=hello-configtree

这里用 JVM 参数是为了方便对照。开头的 application.properties 写法也实测过,结果一样。这个非通配符路径从进程工作目录解析,末尾的 / 保留。

目录找到了,文件是在下一步丢的

ConfigTreeConfigDataResource 会对传入的路径调用 toAbsolutePath()。在这次测试里,它在前面补上了工作目录,.. 仍留在路径里。系统照样能找到目录,Loader 的存在性检查顺利通过。路径解析源码

接着 ConfigTreePropertySource 用 Files.find 遍历。旧版会先检查整条访问路径,然后才把通过筛选的路径转成相对于配置根目录的路径。假设例子建在 /demo 下,候选文件的路径长这样:

/demo/configtree-demo/app/../config/demo.banner
                          ^^

这一段刚好满足 element.toString().startsWith("..")。而且每个候选文件都带着同样的路径前缀,整棵树没有一个文件通过筛选。结果是配置源创建成功,属性表却是空的。修复前的筛选逻辑

最后修的是检查范围

合入版让 Files.find 先按文件类型选出普通文件或符号链接,接着用 sourceDirectory.relativize(path) 得到树内路径,对上面的例子就是 demo.banner。隐藏项规则放进 getName(relativePath)。树内任意一段以 .. 开头,getName 返回 null,那条属性就跳过。合入后的实现

这样,拿 .. 找目录不会再把整个目录的文件筛掉,目录里面的 ..data 仍按原规则处理。我在同一套 4.0.9 依赖里,把修复前和修复后源码各编译一次,只替换 ConfigTreePropertySource 做对照。相对路径前者输出 <missing>,后者输出 hello-configtree。再放一个 ..data/linked.banner 和一个指向它的 linked.banner,修复版能读到正常链接,但不会把 ..data 里的文件另外注册一遍。

上游回归测试也很直接:临时目录里写一个 a,再用 <目录名>/../<目录名> 指到同一处,检查 getPropertyNames() 是否只返回 a。合入的回归测试

这处修复在 11 月 13 日(北京时间)合进了 4.0.x,PR 的里程碑是 4.0.10。还在用受影响版本、眼下需要让配置生效的话,可以先把导入地址换成不含 .. 的实际绝对路径。

来群里聊开源

下次想写的是 Drools 那次大写注解被忽略的问题。你如果也在翻源码、想提一个上游 PR,或者手里正好有个复现卡住了,欢迎来群里聊。微信扫码加我,备注「进群」,我拉你进来。

扫码加多吃鸭的个人微信,备注进群

想看后续的开源复盘,也可以扫码关注公众号 多吃鸭。

微信公众号「多吃鸭」二维码

eatmoreduck 多吃鸭