Gradle中使用ReplaceTokens从外部文件读取动态令牌实现模板替换

你当前代码中令牌替换不生效的核心原因是：ReplaceTokens 过滤器的 tokens 参数仅接收 Map 类型的键值对集合，不会自动将传入的字符串识别为文件路径读取内容。你写的tokens:"placeholders.txt"相当于给所有占位符传入了固定的替换目标字符串placeholders.txt，自然无法匹配到模板中的令牌。

ReplaceTokens本身没有提供类似Ant replacefilterfile的直接读取外部令牌文件的配置参数，Ant任务的该能力本质是任务内部封装了读取外部文件解析为键值对的逻辑，这一步在Gradle中需要手动实现。

前置约定 #

外部令牌文件placeholders.txt使用和Ant兼容的标准Properties格式，每行按键=值书写即可，示例：

db.address=127.0.0.1
db.port=3306
service.name=demo-service

模板文件中的令牌默认使用@键名@格式（和ReplaceTokens默认规则匹配），比如模板中写@db.address@就会被替换为127.0.0.1。

完整任务代码 #

import org.apache.tools.ant.filters.ReplaceTokens

tasks.register('demoPlaceholders', Copy)  {
    from 'config-sets'
    // 注意：强烈建议不要将源目录和输出目录设为同一个，避免覆盖原始模板文件，推荐输出到构建产物目录
    into layout.buildDirectory.dir('generated/config-sets')
    include '**/*.template'
    rename '(.+).template', '$1'

    // 1. 读取外部令牌文件，解析为键值对Map
    def placeholderProps = new Properties()
    file('placeholders.txt').withInputStream { placeholderProps.load(it) }
    Map<String, String> tokenMap = placeholderProps as Map<String, String>

    // 2. 将解析完成的键值对传入ReplaceTokens过滤器
    filter(ReplaceTokens, tokens: tokenMap)
    filteringCharset = 'UTF-8'

    // 可选：标记令牌文件为任务输入，实现增量构建，文件变更时任务才会重跑
    inputs.file('placeholders.txt')
}

自定义令牌格式 #

如果你需要使用${键名}这类和Ant默认一致的令牌格式，只需要在配置ReplaceTokens时指定前后缀即可：

filter(ReplaceTokens,
    tokens: tokenMap,
    beginToken: '${',
    endToken: '}'
)

• 如果确实需要将生成的文件输出回源目录，请严格通过include规则限定仅处理.template后缀的文件，首次运行前务必备份源文件，避免误覆盖。
• 如果你的外部令牌文件是YAML、JSON等其他格式，只需要替换第一步中读取文件解析为Map的逻辑即可，核心逻辑始终是先拿到完整的键值对Map，再传给过滤器的tokens参数。

内容的提问来源于stack exchange，提问作者Miguel Costa