Gradle：访问构建信息

Question

我希望从我的 java 项目中访问构建信息，该项目使用 gradle 来构建项目。我需要访问的信息是由 teamcity 生成的内部版本号、构建 vcs 号等。这些可以通过 maven 轻松访问，并使用 maven-replacer-plugin 可以在属性文件中替换。首先，在 gradle 中是否有替代方案来实现相同的目标？然后，怎么做呢？ :)

我尝试了共享 here 的方法，但我总是得到 null 作为内部版本号。

在 Maven 中，我在项目中放置了一个属性文件 (project.properties) 来保存键值对，键是那些项目信息，如

project.groupId、project.artifactId、project.version、 maven.build.timestamp

我希望使用 gradle 访问相同的构建信息。 . pom 如下所示：

                    <!-- Write project version number to file -->
                <plugin>
                    <groupId>com.google.code.maven-replacer-plugin</groupId>
                    <artifactId>maven-replacer-plugin</artifactId>
                    <version>1.3.8</version>
                    <executions>
                        <execution>
                            <phase>prepare-package</phase>
                            <goals>
                                <goal>replace</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        <includes>
                            <!-- replace the token in this file -->
                            <include>target/classes/project.properties</include>
                        </includes>
                        <replacements>
                            <replacement>
                                <token>PROJECT_GROUP</token>
                                <value>${project.groupId}</value>
                            </replacement>
                            <replacement>
                                <token>PROJECT_ARTIFACT</token>
                                <value>${project.artifactId}</value>
                            </replacement>
                            <replacement>
                                <token>PROJECT_VERSION</token>
                                <value>${project.version}</value>
                            </replacement>
                            <replacement>
                                <token>PROJECT_BUILD_DATE</token>
                                <value>${maven.build.timestamp}</value>
                            </replacement>
                            <replacement>
                                <token>BUILD_NUMBER</token>
                                <value>${build.number}</value>
                            </replacement>
                        </replacements>
                    </configuration>
                </plugin>

maven replacer 插件所做的是替换属性对象中的值，可以在 java 应用程序中使用。

我需要使用 gradle 访问相同的属性。

pom 中的 Team City 配置如下：

<ciManagement>
    <system>Team City</system>
    <url>http://teamcity.mycompany.com/teamcity/project.html?projectId=bt007
    </url>
</ciManagement>

在build.gradle 文件中，我有一个任务定义如下：

task getProjectGroup << {
    ext.projectGroup = System.getProperty("project.group")
    println "Project Group: $projectGroup"
  }

执行此任务时我得到以下输出：

:service:getProjectGroup
Project Group: null

BUILD SUCCESSFUL

Answer 1

我在我的项目中做了非常相似的事情——将构建信息打包到一个属性文件中，该文件可以从你的 Java 应用程序的类路径中读取。

以下是我在 Gradle 脚本中的实现方式：

tasks.withType(Jar).all { Jar jar ->
    jar.doFirst {
        String jarType = jar.extension
        if(jar.classifier) jarType = jar.classifier
        String fileName = "project.properties"
        ant.propertyfile(file: "${jar.temporaryDir}/${fileName}") {
            entry(key: "PROJECT_GROUP", value: project.group)
            entry(key: "PROJECT_ARTIFACT", value: project.archivesBaseName)
            entry(key: "PROJECT_VERSION", value: project.version)
            entry(key: "PROJECT_BUILD_DATE", value: new Date())
            entry(key: "BUILD_NUMBER", value: hasProperty("teamcity") ? teamcity["build.number"] : "local")
        }
        String intoPath = "your/package/name/here/${project.name}/${jarType}"
        jar.from(jar.temporaryDir) {
            include fileName
            if(jar instanceof War) intoPath = "WEB-INF/classes/${intoPath}"
            into(intoPath)
        }
        println "\tCreated ${intoPath}/${fileName}"
    }
}

在这里，我为每个Jar 任务（包括War）添加功能，为该存档创建一个属性文件并将其包含在your/package/name/here/${project.name}/${jarType}/project.properties 下的类路径中。

这就是 Gradle 的美妙之处。它使这样的自定义非常简单 - 不需要插件。

然后，为了读取我的应用程序中的属性，我注入或硬编码文件的预期路径并像这样加载属性：

public Properties lookupClassPathResource(String pathToResource) {
    Properties p = null;
    org.springframework.core.io.Resource r = new org.springframework.core.io.ClassPathResource(pathToResource);
    if(r.exists()) {
        try {
            p = org.springframework.core.io.support.PropertiesLoaderUtils.loadProperties(r);
        } catch (IOException e) {
            //log or wrap/rethrow exception
        }
    }
    return p;
}

所有人都度过了愉快的时光！

编辑： 显然，OP 中链接的问题/答案（关于访问build.number）有点过时了。您可以使用 TeamCity 通过 Gradle 初始化脚本隐式添加到项目中的 teamcity 属性，而不是执行 System.getProperty("build.number")。上面的代码已被修改以反映这一点。另请参阅this question 了解其他示例。