在构建之前替换文件中的令牌，但将令牌保留在源中

Question

我想用构建之前的版本替换 java 源文件中的 @VERSION@ 标记（Gradle 是我选择的构建系统）。

在我当前的脚本ant.replace(file: 'src/main/java/randers/notenoughvocab/main/Reference.java', token: '@VERSION@', value: version) 中，它替换了实际源文件中出现的@VERSION@，因此在构建后，所有出现的模式都被版本替换，如果我更改版本，gradle 构建文件它将不再在那里找到任何模式，并且版本不会更新。

我还看到了一个任务here，但我不知道我的具体项目需要应用什么值。

我的项目的项目布局，如果需要的话：

Answer 1

在向公众发布您的软件之前，您只需替换 @VERSION@ 令牌。这里我定义了一个任务compileForRelease 来完成它：

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

task sourcesForRelease(type: Copy) {
    from 'src/main/java'
    into 'build/adjustedSrc'
    filter(ReplaceTokens, tokens: [VERSION: '2.3.1'])
}

task compileForRelease(type: JavaCompile, dependsOn: sourcesForRelease) {
    source = sourcesForRelease.destinationDir
    classpath = sourceSets.main.compileClasspath
    destinationDir = file('build/adjustedClasses')
}

我不建议使用 Java 插件定义的标准任务，因为这会给每个构建增加不必要的开销。

Answer 2

我发现现有的答案有些不满意，所以这是我的解决方案：

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

task processSource(type: Sync) {
    from sourceSets.main.java
    inputs.property 'version', version
    filter(ReplaceTokens, tokens: [VERSION: version])
    into "$buildDir/src"
}

compileJava {
    source = processSource.outputs
}

这解决了以下各种问题：

1. 与@Opal 的回答不同，主要来源仍然不受干扰；相反，它通过processSource 任务对$buildDir/src 进行了修改，这反映了标准processResources。
2. 与@Gregory Stachowiak 的回答不同，sourceSets.main.java.srcDirs 仍然是默认值，并且在指定（尚）不存在的位置时没有任何技巧
3. 与@Raffaele 的回答不同，发布与其他版本没有单独的任务集。我不同意将它们分开是可取的；我认为增加的复杂性是不值得的，除非您测量了任何性能损失并发现它是不可接受的。在使用 @Raffaele 的解决方案之前，我什至更喜欢使用包含/排除模式来限制 filter 的范围。
4. 任务依赖是通过输出隐式定义的。
5. 所有位置都取自默认值，没有任何内容是字符串类型的。这里唯一的魔法值是src，$buildDir 下的目录，处理过的源文件存放在其中。
6. （编辑：添加于 2019/1/12）其他答案无法正确处理仅版本更改的情况。更改版本本身应该会使任务输出无效。这是通过inputs.property 完成的。
7. （编辑 2019/5/20）使用 Sync 而不是 Copy，以便从源中删除的文件也会从过滤后的源中删除（感谢 @Earthcomputer）。

Answer 3

警告：@Raffaele 在 cmets 中指出，过滤源代码可能会导致严重问题。此答案假定您很清楚自己在做什么，并且意识到可能发生的潜在问题。

问题在于 java 源文件没有被复制——它们只是被编译——就地。所以你需要：

1. 编译前-复制包含@VERSION@的文件
2. 过滤文件。
3. 编译
4. 恢复原始文件。

不确定路径，但以下代码应该会有所帮助：

apply plugin: 'java'

version = '0.0.1'
group = 'randers.notenoughvocab'
archivesBaseName = 'NotEnoughVocab'

def versionFile = 'src/main/java/randers/notenoughvocab/main/Reference.java'
def tempDir = 'build/tmp/sourcesCache'
def versionFileName = 'Reference.java'

compileJava.doFirst {
    copy {
        from(versionFile)
        into(tempDir)
    }
    ant.replace(file: versionFile, token: '@VERSION@', value: version)
}

compileJava.doLast {
    copy {
        from(tempDir + '/' + versionFileName)
        into(project.file(versionFile).parent)
    }
}

Answer 4

我遇到了同样的问题。而且我找不到有效的解决方案。我发现的例子都没有奏效。我相信这可能是一个事实，我是 Gradle 的新手，并且这些示例省略了一些明显的代码片段。所以我研究了 Gradle 并找到了我自己的解决方案，我想分享一下：

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

// Change compiler source directory
sourceSets {
    main {
        java {
            srcDirs = ['build/src/main/java']
        }
    }
}

// Prepare sources for compilation
task prepareSources(type: Copy) {
    from('src/main/java')
    into('build/src/main/java')
    filter(ReplaceTokens, tokens: [pluginVersion: version])
}

// Prepare sources, before compile
compileJava {
    dependsOn prepareSources
}

Answer 5

为了补充其他答案，如果您只想更改一个值，我发现这个习语更简单：

task generateSources(type: Copy) {
    from 'src/main/java'
    into 'build/src/main/java'
    filter { line -> line.replaceAll('xxx', 'aaa') }
}