数据流操作支持是一个孵化中的功能，可能会发生变化。

在 Gradle 构建中执行工作的首选方法是使用任务。但是，某些类型的工作不太适合任务，例如自定义处理构建失败。

如果您想在构建成功时播放欢快的音乐，在构建失败时播放悲伤的音乐，该怎么办？这个工作片段必须处理任务执行结果，因此它本身不能是一个任务。

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

实现数据流操作

第一步是实现操作本身。您必须创建一个实现 FlowAction 接口的类

import org.gradle.api.flow.FlowAction
import org.gradle.api.flow.FlowParameters

abstract class ReportConsumption : FlowAction<ReportConsumption.Params> {

    interface Params : FlowParameters {

    }

    override fun execute(parameters: Params) {

    }
}

必须实现 execute 方法，因为这是工作发生的地方。操作实现被视为 自定义 Gradle 类型，并且可以使用自定义 Gradle 类型的任何可用功能。特别是，一些 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 类获取这些提供程序。

flowProviders.buildWorkResult.map {
    [
        buildInvocationId: scopeIdsService.buildInvocationId,
        workspaceId: scopeIdsService.workspaceId,
        userId: scopeIdsService.userId
    ]
}
如果您没有使用生命周期事件提供程序作为数据流操作的输入，则操作执行的确切时间未定义，并且可能会在 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 实例。它们可用于项目和 settings 插件。
2 使用适当的 scope 来运行您的操作。顾名思义，always scope 中的操作在每次构建运行时都会执行。
3 指定实现操作的类。
4 使用 spec 参数配置操作参数。
5 生命周期事件提供程序可以映射到其他内容，同时保留操作顺序。

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