转换输出

API文档:TransformOutputs

工件变换的输出。

注册的输出File将按照注册的顺序出现在转换后的变体中。

特性

无属性

方法

方法描述
dir(path)

注册输出目录。

file(path)

注册输出文件。

脚本块

无脚本块

方法详情

File dirObject小路)

注册输出目录。

对于绝对路径,该位置被注册为TransformAction.该路径必须指向InputArtifact,或者指向输入工件内部(如果它是目录)。例子:

import org.gradle.api.artifacts.transform.TransformParameters;

public abstract class MyTransform implements TransformAction<TransformParameters.None> {
    @InputArtifact
    public abstract Provider<FileSystemLocation> getInputArtifact();
    @Override
    public void transform(TransformOutputs outputs) {
        outputs.dir(getInputArtifact().get().getAsFile());
        outputs.dir(new File(getInputArtifact().get().getAsFile(), "sub-dir"));
    }
}

对于相对路径,Gradle 创建一个输出目录,TransformAction必须将其输出文件放置在其中。例子:

import org.gradle.api.artifacts.transform.TransformParameters;

public abstract class MyTransform implements TransformAction<TransformParameters.None> {
    @Override
    public void transform(TransformOutputs outputs) {
        File myOutput = outputs.dir("my-output");
        Files.write(myOutput.toPath().resolve("file.txt"), "Generated text");
    }
}

注意:TransformAction.transform(org.gradle.api.artifacts.transform.TransformOutputs)如果方法完成 时注册的目录不存在,则会出错

File fileObject小路)

注册输出文件。

对于绝对路径,该位置将注册为TransformAction.InputArtifact如果输入工件是目录,则路径需要指向或位于其中。例子:

import org.gradle.api.artifacts.transform.TransformParameters;

public abstract class MyTransform implements TransformAction<TransformParameters.None> {
    @InputArtifact
    public abstract Provider<FileSystemLocation> getInputArtifact();
    @Override
    public void transform(TransformOutputs outputs) {
        File input = getInputArtifact().get().getAsFile();
        if (input.isFile()) {
            outputs.file(input);
        } else {
            outputs.file(new File(input, "file-in-input-artifact.txt"));
        }
    }
}

对于相对路径,Gradle 提供输出文件的位置,以便可以TransformAction在该位置生成输出。调用该方法时会自动创建所提供位置的父目录。例子:

import org.gradle.api.artifacts.transform.TransformParameters;

public abstract class MyTransform implements TransformAction<TransformParameters.None> {
    @InputArtifact
    public abstract Provider<FileSystemLocation> getInputArtifact();
    @Override
    public void transform(TransformOutputs outputs) {
        File myOutput = outputs.file("my-output.transformed");
        Files.write(myOutput.toPath(), "Generated text");
    }
}

当该方法完成时,注册的文件需要存在TransformAction.transform(org.gradle.api.artifacts.transform.TransformOutputs)