缓存 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 实现为托管类型。

此页面有帮助吗？