Dataflow 操作 - Gradle 中文

数据流操作支持是一个孵化功能，此处描述的详细信息可能会更改。

在 Gradle 构建中执行工作的首选方式是使用任务。但是，有些工作不适合任务，例如自定义处理构建失败。如果你想在构建成功时播放欢快的音乐，在构建失败时播放悲伤的音乐，该怎么办？此工作片段必须处理任务执行结果，因此它本身不能是一个任务。

数据流操作 API 提供了一种调度此类工作的方法。数据流操作是一个参数化的隔离工作片段，只要其所有输入参数可用，它就会有资格执行。

实施数据流操作

第一步是实现操作本身。为此，您创建一个实现 FlowAction 接口的类。必须实现 execute 方法，因为这是执行操作的地方。操作实现被视为自定义 Gradle 类型，并且可以使用自定义 Gradle 类型可用的任何功能。特别是，可以将一些 Gradle 服务注入到实现中。

数据流操作可以接受参数。要提供参数，您需要定义一个抽象类（或接口）来保存参数。参数类型必须实现（或扩展）FlowParameters。操作实现将参数作为 execute 方法的参数获取。参数类型也是自定义 Gradle 类型。

当操作不需要参数时，您可以使用 FlowParameters.None 作为参数类型。

以下是将共享构建服务和文件路径作为参数的数据流操作示例。

SoundPlay.java

package org.gradle.sample.sound;

import org.gradle.api.flow.FlowAction;
import org.gradle.api.flow.FlowParameters;
import org.gradle.api.provider.Property;
import org.gradle.api.services.ServiceReference;
import org.gradle.api.tasks.Input;

import java.io.File;

public abstract class SoundPlay implements FlowAction<SoundPlay.Parameters> {
    interface Parameters extends FlowParameters {
        @ServiceReference (1)
        Property<SoundService> getSoundService();

        @Input (2)
        Property<File> getMediaFile();
    }

    @Override
    public void execute(Parameters parameters) {
        parameters.getSoundService().get().playSoundFile(parameters.getMediaFile().get());
    }
}

1	参数类型中的参数必须带注释。如果参数用 `@ServiceReference` 注释，那么在创建操作时，将根据通常规则自动将合适的共享构建服务实现分配给该参数。
2	所有其他参数都必须用 `@Input` 注释。

生命周期事件提供程序

除了通常的值提供程序之外，Gradle 还为构建生命周期事件（如构建完成）提供了专门的提供程序。这些提供程序适用于数据流操作，并在用作输入时提供额外的排序保证。如果您通过（例如）调用 map 或 flatMap 从事件提供程序派生提供程序，则该排序也适用。您可以从 FlowProviders 类获取这些提供程序。

如果您没有将生命周期事件提供程序用作数据流操作的输入，那么操作执行的确切时间未定义，并且可能会在 Gradle 的下一个版本中更改。

提供要执行的操作

您不应该手动创建 FlowAction 对象。相反，您请求在 FlowScope 的适当范围内执行它们。执行此操作时，您可以配置要使用的任务参数。

SoundFeedbackPlugin.java

package org.gradle.sample.sound;

import org.gradle.api.Plugin;
import org.gradle.api.flow.FlowProviders;
import org.gradle.api.flow.FlowScope;
import org.gradle.api.initialization.Settings;

import javax.inject.Inject;
import java.io.File;

public abstract class SoundFeedbackPlugin implements Plugin<Settings> {
    @Inject
    protected abstract FlowScope getFlowScope(); (1)

    @Inject
    protected abstract FlowProviders getFlowProviders(); (1)

    @Override
    public void apply(Settings settings) {
        final File soundsDir = new File(settings.getSettingsDir(), "sounds");
        getFlowScope().always( (2)
            SoundPlay.class,  (3)
            spec ->  (4)
                spec.getParameters().getMediaFile().set(
                    getFlowProviders().getBuildWorkResult().map(result -> (5)
                        new File(
                            soundsDir,
                            result.getFailure().isPresent() ? "sad-trombone.mp3" : "tada.mp3"
                        )
                    )
                )
        );
    }
}

1	使用服务注入来获取 `FlowScope` 和 `FlowProviders` 实例。它们可用于项目和设置插件。
2	使用适当的范围来运行您的操作。顾名思义，`always` 范围中的操作会在每次构建运行时执行。
3	指定实现操作的类。
4	使用 spec 参数来配置操作参数。
5	生命周期事件提供程序可以映射到其他内容，同时保留操作顺序。

因此，当您运行构建并且构建成功完成时，操作将播放“tada”声音。如果构建在配置或执行时失败，那么您将听到“sad-trombone”——当然，前提是构建配置进行得足够远，以至于操作可以注册。

此页面是否有用？