缓存 Java 项目 - Gradle 构建系统

自 Gradle 4.0 起，此构建工具已全面支持对纯 Java 项目进行缓存。用于编译、测试、生成文档和检查 Java 代码质量的内置任务均原生支持构建缓存。

Java 编译

Java 编译缓存利用了 Gradle 对编译类路径的深入理解。当依赖项的更改方式不影响其应用程序二进制接口 (ABI) 时，该机制会避免重新编译。由于缓存键仅受依赖项 ABI 的影响（而不是其实现细节，如私有类型和方法体），因此如果任务输出缓存是由相同的源代码和 ABI 等效的依赖项生成的，它也可以重用编译后的类。

例如，考虑一个包含两个模块的项目：一个依赖于库的应用程序。假设最新版本已由 CI 构建并上传到共享缓存。如果开发人员现在修改了库中某个方法的实现体，那么需要在他们的计算机上重新构建该库。但他们将能够从共享缓存中加载应用程序的编译类。Gradle 之所以能做到这一点，是因为 CI 上用于编译应用程序的库与本地可用的修改后的库具有相同的 ABI。

编译避免功能原生可用。但有一个注意事项：使用注解处理器时，Gradle 会将注解处理器类路径作为输入。与大多数仅 ABI 影响编译的编译依赖项不同，注解处理器的实现必须被视为编译器的输入。因此，Gradle 会将注解处理器视为运行时类路径，这意味着那里的输入规范化程度较低。如果 Gradle 在编译类路径上检测到注解处理器，则在未显式设置时，注解处理器类路径会默认使用编译类路径，这反过来意味着整个编译类路径都被视为运行时类路径输入。

对于上面的示例，这意味着从编译类路径中提取的 ABI 将保持不变，但注解处理器类路径（因为它未应用编译避免）将有所不同。最终，开发人员将不得不重新编译应用程序。

避免此性能损失的最简单方法是不要使用注解处理器。但是，如果您需要使用它们，请确保明确设置注解处理器类路径，使其仅包含注解处理所需的库。有关 Java 编译避免的部分描述了如何执行此操作。

一些常见的 Java 依赖项（例如 Log4j 2.x）捆绑了注解处理器。如果您使用了这些依赖项，但未利用捆绑注解处理器的功能，最好完全禁用注解处理。这可以通过将注解处理器类路径设置为空集来完成。

单元测试执行

用于执行 JVM 语言测试的 Test 任务对其类路径采用了运行时类路径规范化。这意味着测试类路径上 jar 文件中顺序和时间戳的更改不会导致任务过期或更改构建缓存键。为了实现稳定的任务输入，您还可以利用过滤运行时类路径的功能。

集成测试执行

单元测试很容易缓存，因为它们通常没有外部依赖项。但对于集成测试来说，情况可能大相径庭，因为它们可能依赖于测试代码和生产代码之外的各种输入。这些外部因素可能包括，例如

操作系统类型和版本，
为测试安装的外部工具，
环境变量和 Java 系统属性，
其他正在运行的服务，
被测软件的分发包。

您需要小心声明集成测试的这些额外输入，以避免缓存命中不准确。例如，将 Gradle 使用的操作系统声明为名为 integTest 的 Test 任务的输入，可以按如下方式进行：

build.gradle.kts

tasks.integTest {
    inputs.property("operatingSystem") {
        System.getProperty("os.name")
    }
}

build.gradle

tasks.named('integTest') {
    inputs.property("operatingSystem") {
        System.getProperty("os.name")
    }
}

归档文件作为输入

集成测试通常依赖于打包好的应用程序。如果这是一个 zip 或 tar 归档文件，将其添加为集成测试任务的输入可能会导致缓存未命中。这是因为，正如可重复任务输出中所述，重新构建归档文件通常会更改归档文件中的元数据。您可以转而依赖于归档文件的解压内容。另请参阅关于处理不可重复输出的部分。

处理文件路径

您可能会通过使用系统属性将构建环境中的一些信息传递给您的集成测试任务。传递绝对路径会破坏集成测试任务的可重定位性。

build.gradle.kts

// Don't do this! Breaks relocatability!
tasks.integTest {
    systemProperty("distribution.location", layout.buildDirectory.dir("dist").get().asFile.absolutePath)
}

build.gradle

// Don't do this! Breaks relocatability!
tasks.named('integTest') {
    systemProperty "distribution.location", layout.buildDirectory.dir('dist').get().asFile.absolutePath
}

与其直接将绝对路径作为系统属性添加，不如为 integTest 任务添加一个带注解的 CommandLineArgumentProvider。

build.gradle.kts

abstract class DistributionLocationProvider : CommandLineArgumentProvider {  (1)
    @get:InputDirectory
    @get:PathSensitive(PathSensitivity.RELATIVE)  (2)
    abstract val distribution: DirectoryProperty

    override fun asArguments(): Iterable<String> =
        listOf("-Ddistribution.location=${distribution.get().asFile.absolutePath}")  (3)
}

tasks.integTest {
    jvmArgumentProviders.add(
        objects.newInstance<DistributionLocationProvider>().apply {  (4)
            distribution = layout.buildDirectory.dir("dist")
        }
    )
}

build.gradle

abstract class DistributionLocationProvider implements CommandLineArgumentProvider {  (1)
    @InputDirectory
    @PathSensitive(PathSensitivity.RELATIVE)  (2)
    abstract DirectoryProperty getDistribution()

    @Override
    Iterable<String> asArguments() {
        ["-Ddistribution.location=${distribution.get().asFile.absolutePath}"]  (3)
    }
}

tasks.named('integTest') {
    jvmArgumentProviders.add(
        objects.newInstance(DistributionLocationProvider).tap {  (4)
            distribution = layout.buildDirectory.dir('dist')
        }
    )
}

1	创建一个实现 `CommandLineArgumentProvider` 的类。
2	声明具有相应路径敏感度的输入和输出。
3	`asArguments` 需要返回将所需系统属性传递给测试 JVM 的 JVM 参数。
4	将新创建的类的实例作为 JVM 参数提供者添加到集成测试任务。^[1]

忽略系统属性

可能需要忽略一些系统属性作为输入，因为它们不影响集成测试的结果。为此，请为 integTest 任务添加一个 CommandLineArgumentProvider。

build.gradle.kts

abstract class CiEnvironmentProvider : CommandLineArgumentProvider {
    @get:Internal  (1)
    abstract val agentNumber: Property<String>

    override fun asArguments(): Iterable<String> =
        listOf("-DagentNumber=${agentNumber.get()}")  (2)
}

tasks.integTest {
    jvmArgumentProviders.add(
        objects.newInstance<CiEnvironmentProvider>().apply {  (3)
            agentNumber = providers.environmentVariable("AGENT_NUMBER").orElse("1")
        }
    )
}

build.gradle

abstract class CiEnvironmentProvider implements CommandLineArgumentProvider {
    @Internal  (1)
    abstract Property<String> getAgentNumber()

    @Override
    Iterable<String> asArguments() {
        ["-DagentNumber=${agentNumber.get()}"]  (2)
    }
}

tasks.named('integTest') {
    jvmArgumentProviders.add(
        objects.newInstance(CiEnvironmentProvider).tap {  (3)
            agentNumber = providers.environmentVariable("AGENT_NUMBER").orElse("1")
        }
    )
}

1	`@Internal` 表示此属性不影响集成测试的输出。
2	实际测试执行的系统属性。
3	将新创建的类的实例作为 JVM 参数提供者添加到集成测试任务。^[1]

1. 此示例中的 CommandLineArgumentProvider 实现为托管类型。

此页面对您有帮助吗？