Blog

Blog

PHODAL

自制 Gradle 依赖格式及转换插件

在我们使用 Java + Gradle 开发各类应用的过程中,会发现我们声明的一些包不是 jar 包,诸如 zip、war、aar 等。它也会下载下来,并转换到我们所需要的格式。

这个过程蛮有意思的:

  1. 注册对应的 DependencyHandler Transform
  2. 创建自定义的 configuration
  3. 在接收到对应的 configuration 时,进行依赖转换
  4. 在使用时,通过 configuration 获取到对应的制品(artifacts)
  5. 在编译的时候,取出这些制品的路径

在我找了好久之后,终于在官方项目的 issue 里找到了一个示例:https://github.com/gradle/gradle/issues/13200 。这里就基于这个示例来进行讲解。

定制 Transfrom

先看这个逻辑:

def artifactType = Attribute.of('artifactType', String)
dependencies.registerTransform(MyTransform.class) {
    it.from.attribute(artifactType, "jar")
    it.to.attribute(artifactType, "my-custom-type")
}

当我们接收到 jar 这一类的制品时(artifact),会调用 MyTransform,并将其转换为 my-custom-typemy-custom-type 只是一种状态标记,方便于我们后面对其进行二次处理。

Transform 逻辑

对应的 Transfrom 实现如下:

abstract class MyTransform implements TransformAction<TransformParameters.None> {
    @InputArtifact
    public abstract Provider<FileSystemLocation> getPrimaryInput();

    @Override
    void transform(TransformOutputs transformOutputs) {
        File file = getPrimaryInput().get().asFile;
        println "Processing $file. File exists = ${file.exists()}"
        if (file.exists()) {
            File outputFile = transformOutputs.file("copy");
            Files.copy(file.toPath(), outputFile.toPath())
        } else {
            throw new RuntimeException("File does not exist: " + file.canonicalPath);
        }
    }
}

没有什么特殊处理,只是简单的记录一下。

自定义 Configuration

自定义 Configuration 也依旧很简单

Configuration myConfiguration = configurations.create("myConfiguration")
dependencies.add(myConfiguration.name,  "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.70")

在 Task 中消费处理完的 Transform

当我们运行 Gradle 的命令时,会先调用依赖处理逻辑,于是就进行了转换。因此,我们可以写一个 task 取出依赖完的依赖,并使用它。

tasks.register("consumerTask", ConsumerTask.class) {
    it.artifactCollection = myConfiguration.incoming.artifactView { ArtifactView.ViewConfiguration viewConfiguration ->
        viewConfiguration.attributes.attribute(artifactType, "my-custom-type")
    }.artifacts
    it.outputFile.set(new File("build/consumerTask/output/output.txt"))
}

对应的 Task 实现:

abstract class ConsumerTask extends DefaultTask {
    @Internal
    public ArtifactCollection artifactCollection;

    @InputFiles
    public FileCollection getMyInputFiles() {
        return artifactCollection.artifactFiles
    }

    @OutputFile
    public abstract RegularFileProperty getOutputFile();

    @TaskAction
    public void doTask() {
        File outputFile = getOutputFile().get().asFile
        outputFile.delete()
        outputFile.parentFile.mkdirs()
        String outputContent = "";
        for(File f: getMyInputFiles().files) {
            outputContent += f.canonicalPath + "\n"
        }
        Files.write(outputFile.toPath(), outputContent.getBytes())
    }
}

嗯,就是这么简单 :) 。

关于我

Github: @phodal     微博:@phodal     知乎:@phodal    

微信公众号(Phodal)

围观我的Github Idea墙, 也许,你会遇到心仪的项目

QQ技术交流群: 321689806

新书《全栈应用开发:精益实践》

这不是一本深入前端、后台、运维、设计、分析等各个领域的书籍。本书以实践的方式,将这一系列的领域及理论知识结合到一起,来帮助读者构建全栈Web 开发的知识体系,并辅以精益及敏捷的思想,来一步步开发Web 应用:从创建一个UI 原型到编写出静态的前端页面;从静态的前端页面到带后台的应用,并部署应用;从Web 后台开发API 到开发移动Web 应用。在这个过程中,我们还将介绍一些相辅相成的步骤:使用构建系统来加速Web 应用的开发;为应用添加数据分析工具来改进产品;使用分析工具来改善应用的性能;通过自动化部署来加快上线流程;从而帮助读者开发出一个真正可用的全栈 Web 应用。同时,我们也将帮助读者把这些步骤应用到现有的系统上,改进现有系统的开发流程。

comment

Feeds

RSS / Atom

最近文章

关于作者

Phodal Huang

Developer, Consultant, Writer, Designer

ThoughtWorks 高级咨询师

工程师 / 咨询师 / 作家 / 设计学徒

开源深度爱好者

出版有《前端架构:从入门到微前端》、《自己动手设计物联网》、《全栈应用开发:精益实践》

联系我: h@phodal.com

微信公众号: 与我沟通

标签

最近的一些事

  • 最近我和我的同事们,一起在创建一个新的编程语言:Charj 。它是一个使用 Rust 编写的描述式、中间编程语言。GitHub: https://github.com/charj-lang/charj

    Nov. 14, 2020, 9:27 p.m. | China