聊聊 SpringBoot 中的两种占位符：@@ 和 ${}

2021 年 12 月 11 日
本文字数：3748 字
阅读完需：约 12 分钟

前言

在 SpringBoot 项目中，我们经常会使用两种占位符（有时候还会混用），它们分别是：

@*@
${*}

如果我们上网搜索「SpringBoot 的占位符 @」，大部分答案会告诉你，SpringBoot 的默认占位符由 ${*}变成 @*@了，更好一点的答案会引用 SpringBoot官网中的描述：

On the last point: since the default config files accept Spring style placeholders (${…}) the Maven filtering is changed to use @..@ placeholders (you can override that with a Maven property resource.delimiter).

于是我们得到了答案，并心安理得地开始使用 @*@占位符。但如果有探索欲比较强的同学问起：Spring 中的占位符本来是 ${*}，为啥 SpringBoot 中的占位符就变成 @*@了呢？有时候这两种占位符还能混用，这又是为什么呢？

今天，我们就来一探究竟，这两种占位符到底是如何实现的。

场景

首先要说明两种场景：

使用 @Value 注解注入属性时，只能使用 ${*}占位符解析。
处理资源文件中的属性时，这两种占位符就有点意思了：它们既有可能都有效，还有可能都不生效，甚至你可以扩展自己的占位符！当然这一切都要看你是怎么配置的。下文会进行详细讲述。

我们先简单看下第一种场景，@Value 注解的梳理属于 Spring 核心框架逻辑，可以参见 PropertySourcesPlaceholderConfigurer 这个类，最终会执行 ${}占位符的解析。其中的冒号后面可以写默认值。

由于这种场景不是本文重点，因此不再展开。有兴趣的同学可自行探索详细解析流程。可以参考文章：[SpringBoot 中 @Value 源码解析](https://www.jianshu.com/p/933669270a9f)

下面我们重点看看第二种场景：处理资源文件中的属性占位符。为方便说明，我们搭建一个 Demo 项目。

前置知识

用过 Maven 的同学应该都知道，插件 maven-resources-plugin 就是用来处理资源文件的。结合前文中提到的 resource.delimite，我们在 spring-boot-starter-parent 中可以找到对应的配置：

可以看到 resource.delimite 是 maven-resources-plugin 插件中的一个配置项，用于控制占位符的类型。稍后我们会更改其中的一些配置项进行实验。

项目搭建

我们创建一个 SpringBoot Demo 项目，环境信息如下：

spring-boot 2.6.1
maven-resources-plugin 3.2.0

我们需要准备一些配置数据，如下所示：

它们会被 application.properties 引用：

为进行对比，这里我们使用了三种占位符，分别是 Spring 默认占位符 ${*}、SpringBoot 默认占位符 @*@，以及我随便写的一种占位符 #*#。可以预知的是，#*#这种占位符一定不会被解析。

然后我们还需要在 pom.xml 配置一下，确保资源被正确解析：

此时 pom.xml 的完整内容如下：

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-parent</artifactId>        <version>2.6.1</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <groupId>com.example</groupId>    <artifactId>resource.placeholder.demo</artifactId>    <version>0.0.1-SNAPSHOT</version>    <name>resource.placeholder.demo</name>    <description>Demo project for Spring Boot</description>    <properties>        <java.version>1.8</java.version>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter</artifactId>        </dependency>    </dependencies>
    <profiles>        <profile>            <id>product</id>            <properties>                <env>product</env>            </properties>        </profile>    </profiles>
    <build>        <filters>            <!-- 指定配置读取路径 -->            <filter>src/main/filters/${env}.properties</filter>        </filters>        <resources>            <!-- 把资源文件中的占位符替换为配置数据 -->            <resource>                <directory>src/main/resources</directory>                <filtering>true</filtering>                <excludes>                    <exclude>static/**</exclude>                </excludes>            </resource>        </resources>        <plugins>            <plugin>                <groupId>org.springframework.boot</groupId>                <artifactId>spring-boot-maven-plugin</artifactId>            </plugin>        </plugins>    </build>
</project>

复制代码

注：上面我们准备了一个非常简单的配置文件 product.properties 用于演示。在实际项目中，一般会为不同的 Profile 配置不同的数据，比如还可能会有 dev.properties 等等。

现在，我们 build 一下项目，看看 target 中的资源文件内容：

很明显，只有 @*@ 这种占位符被解析了，而 ${*} 和 #*# 都没有被解析。

回忆前面提到的：spring-boot-starter-parent 中指定了 maven-resources-plugin 的占位符 resource.delimite，那我们自己引入 maven-resources-plugin，修改配置：

Reimport Maven 后，再次 build，看看效果：

可以发现 ${*} 占位符也可以解析了。

那我们继续改，把 delimite 改成 #，看看 #*# 这种占位符能否被解析：

Reimport Maven 后，再次 build，看看效果：

可以看到，我们自定义的占位符也可以解析了。

我们继续实验一个场景，把 useDefaultDelimiters 改回 false：

Reimport Maven 后，再次 build，看看效果：

我们发现，现在只能解析自定义占位符 #*# 了，而 ${*} 和 @*@ 没有被解析。

因此我们可以大胆推测，maven-resources-plugin 插件的：

默认占位符有两种，分别是 ${*} 和 @*@
配置项 useDefaultDelimiters，可以控制是否使用默认占位符
配置项 delimiter，既可以写默认占位符，也可以自定义占位符

好了，现在我们需要到 maven-resources-plugin 插件中找一下对应的源码，验证上述猜测是否正确。

源码解析

首先我们要下载 maven-resources-plugin 的源码。URL 为https://archive.apache.org/dist/maven/plugins/

我们直接通过关键词 useDefaultDelimiters，找到关键代码 org.apache.maven.shared.filtering.AbstractMavenFilteringRequest#setDelimiters，打上断点进行调试。

PS：可以参考文章如何调试 Maven 源码和插件源码学习 Maven 插件的调试方法。具体到本项目，我们执行命令 mvnDebug -Pproduct resources:resources 以启动调试。其中的-P 是为了指定 profile，从而能够找到 ${env}.properties 文件读取配置数据。

停在断点后，可以看到开始解析 delimiter：

进到方法内部看看：

可以看到逻辑非常简单：

首先检查是否传入了自定义 delimiters：

如果没有，setDelimiters 执行将没有任何效果；也就是说，一定还有默认的值，稍后我们去验证。
如果有，那么进行解析（如果为 null，默认使用 ${*} ）。同时会判断 useDefaultDelimiters 是否为 true，若为 true，就把默认 delimiters 加到结果集中。

那么我们顺着找一下默认 delimiters：