Gradle transform api 简介

前言

在打包流程中,我们知道生成.class文件后,利用dx工具生成.dex文件,而利用Transform API可以在生成.class文件后修改.class文件,从而修改源码。我们将Transform注册到AppExtension中,在java compile Task执行后会执行Tramsform类型的task。
具体过程参考以下两篇文章

Transform API

根据transform api官网中的介绍,可以知道gradle从1.5.0-beta1开始,支持第三方插件修改class文件。transform api的目的是为了简化自定义类的注入,使得我们不需要写task。

注册

@Override
void apply(Project project) {
    ……
    def android = project.extensions.getByType(AppExtension)
//AppExtension appExtension = (AppExtension)project.getProperties().get("android");
    android.registerTransform(theTransform)
}

transform 抽象类

自定义一个Transform时,需要继承Transform,下面看下几个抽象方法和transform方法。

public abstract class Transform {

    //返回自己Transform类的名字
    public abstract String getName();

    //传入transform类型,class文件或者resource(非res下文件, 而是assests内的资源),也可以多个。
    //类型必须是接口QualifiedContent中的DefaultContentType枚举类里的值
    //TransformManager中定义了一些,如TransformManager.CONTENT_CLASS
    public abstract Set<ContentType> getInputTypes();

    //传入transform文件的所属范围,可以多个。TransformManager中定义了一些,如TransformManager.SCOPE_FULL_PROJECT
    //类型必须是接口QualifiedContent中的枚举类Scope里的值
    public abstract Set<? super Scope> getScopes();

    //是否是增量编译
    public abstract boolean isIncremental();

    //主要执行方法
    public void transform(TransformInvocation transformInvocation);

    ……
}

transform中的TransformInvocation是主要处理的对下,根据api文档,

//中是传过来的输入流,其中有两种格式,一种是jar包格式一种是目录格式。
transformInvocation.getInputs() 
//获取到输出目录,最后将修改的文件复制到输出目录,这一步必须做不然编译会报错
transformInvocation.getOutputProvider() 

常用的写法如下

@Override
void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException,
        IOException {
    super.transform(transformInvocation)

    Collection inputs = transformInvocation.getInputs()
    TransformOutputProvider outputProvider = transformInvocation.getOutputProvider()

    if (!isIncremental() && outputProvider != null) {
        //非增量编译,需要删除之前的输出
        outputProvider.deleteAll()
    }

    inputs.each { TransformInput input ->
        //遍历directoryInputs
        input.directoryInputs.each { DirectoryInput directoryInput ->
            // todo 注入代码……
            // 获取output目录
            def dest = outputProvider.getContentLocation(directoryInput.name,
                    directoryInput.contentTypes, directoryInput.scopes,
                    Format.DIRECTORY)
            // 将input的目录复制到output指定目录
            FileUtils.copyDirectory(directoryInput.file, dest)
        }
        //遍历jarInputs
        input.jarInputs.each { JarInput jarInput ->
            //todo 注入代码……
            //生成输出路径
            def dest = outputProvider.getContentLocation(jarName + md5Name,
                    jarInput.contentTypes, jarInput.scopes, Format.JAR)
            //将输入内容复制到输出
            FileUtils.copyFile(jarInput.file, dest)
        }
    }
}

可以看到上面代码中有进行了遍历,但是注入代码需要Javassist或者ASM等来处理。可以看下一篇

参考 :
android动态编译技术:Plugin Transform Javassist

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,319评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,801评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,567评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,156评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,019评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,090评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,500评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,192评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,474评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,212评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,572评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2 335

推荐阅读更多精彩内容