前言

Gradle 是将软件编译、测试、部署等步骤分割在一起自动化构建工具。

对于Android开发人员曾经理解build.gradle 的 android{} 和 dependencies{} ，然而他的编译过程是什么样的？这个过程中能够干些什么事理解吗？

此文是学习Gradle时的学习笔记，让你重新认识Gradle，让Gradle放慢并提效构建你的我的项目。此时分享给大家，与大家共勉

此笔记次要内容如下

  • Gradle 最根底的一个我的项目配置
  • Groovy 根底语法 并解释 apply plugin: 'xxxx'和dependencies{}
  • Gradle Project/Task 并自定义Task和Plugin
  • 自定义一个重命名APP名的插件 流程
  • APT 技术- Java AbstractProcessor
  • Android 字节码加强技术 - Transform （Android 中应用字节码加强技术）

文章内容略长，如果你曾经把握Gradle基础知识，能够间接通过目录查看你想看的内容，回顾或者学习都还不错。

初识Gradle 我的项目构建配置

gralde我的项目构造

如图所示，是一个比拟小的gradle配置,这里次要说两局部

  1. 绿色局部： gralde版本配置及gralde所须要的脚本，其中gradlew为linux/mac下的脚本，gradle.bat为windows下所需的脚本
  2. 红色局部：settings.gradle 为根我的项目的我的项目配置，外层的build.gradle为根我的项目的配置，内层的build.gradle为子项目的配置

gradle 配置程序

gralde的我的项目配置是先辨认 settings.gradle，而后在配置各个build.gradle.
为了阐明构建执行程序，在上述最根底的gradle我的项目构造外面设置了对应的代码

// settings.gradleprintln "settings.gradle start"include ':app'println "settings.gradle end"
//root build.gradleprintln "project.root start"buildscript {    repositories {    }    dependencies {    }}allprojects {}println "project.root end"
//app build.gradleprintln "project.app start"project.afterEvaluate {    println "project.app.afterEvaluate print"}project.beforeEvaluate {    println "project.app.beforeEvaluate print"}println "project.app end"

如果是mac/linux，执行./gradlew 失去如下后果:

settings.gradle startsettings.gradle end> Configure project :project.root startproject.root end> Configure project :appproject.app startproject.app endproject.app.afterEvaluate print

Groovy 语法

上面讲一些对于groovy的语法，能够关上Android Studio Tools-> Groovy Console练习Groovy 语法 ，如下

可选的类型定义,能够省略语句结束符分号（;）

int vs = 1def version = 'version1'println(vs)println(version)

括号也是可选的

println vsprintln version

字符串定义

def s1 = 'aaa'def s2 = "version is ${version}"def s3 = ''' strismany'''println s1println s2println s3

汇合

def list = ['ant','maven']list << "gradle"list.add('test')println list.size()println list.toString()//mapdef years = ['key1':1000,"key2":2000]println years.key1println years.getClass()

输入后果

[ant, maven, gradle, test]1000class java.util.LinkedHashMap

闭包

groovy语法中反对闭包语法，闭包简略的说就是代码块,如下:

def v = {    v -> println v}static def testMethod(Closure closure){    closure('闭包 test')}testMethod v

其中定义的v就为闭包，testMethod 为一个办法，传入参数为闭包，而后调用闭包.

解释 apply plugin: 'xxxx'和 dependencies{}

筹备工作，看gradle的源码

咱们先把子我的项目的build.gradle改为如下模式

apply plugin: 'java-library'repositories {    mavenLocal()}dependencies {    compile gradleApi()}

这样，咱们就能够间接看gradle的源码了，在External Libraries里如下

解释

进入build.gradle 点击apply 会进入到gradle的源码,能够看到

//PluginAware /**     * Applies a plugin or script, using the given options provided as a map. Does nothing if the plugin has already been applied.     * <p>     * The given map is applied as a series of method calls to a newly created {@link ObjectConfigurationAction}.     * That is, each key in the map is expected to be the name of a method {@link ObjectConfigurationAction} and the value to be compatible arguments to that method.     *     * <p>The following options are available:</p>     *     * <ul><li>{@code from}: A script to apply. Accepts any path supported by {@link org.gradle.api.Project#uri(Object)}.</li>     *     * <li>{@code plugin}: The id or implementation class of the plugin to apply.</li>     *     * <li>{@code to}: The target delegate object or objects. The default is this plugin aware object. Use this to configure objects other than this object.</li></ul>     *     * @param options the options to use to configure and {@link ObjectConfigurationAction} before “executing” it     */    void apply(Map<String, ?> options);

用Groovy 语法很分明的解释，apply其实就是一个办法,前面传递的就是一个map，其中plugin为key.

那么dependencies{}也是一样

//Project/**     * <p>Configures the dependencies for this project.     *     * <p>This method executes the given closure against the {@link DependencyHandler} for this project. The {@link     * DependencyHandler} is passed to the closure as the closure's delegate.     *     * <h3>Examples:</h3>     * See docs for {@link DependencyHandler}     *     * @param configureClosure the closure to use to configure the dependencies.     */    void dependencies(Closure configureClosure);

dependencies是一个办法 前面传递的是一个闭包的参数.

问题：思考那么android {}也是一样的实现吗？ 前面解说

Gradle Project/Task

在后面章节中提到gralde初始化配置，是先解析并执行setting.gradle，而后在解析执行build.gradle，那么其实这些build.gradle 就是Project，外层的build.gradle是根Project,内层的为子project，根project只能有一个，子project能够有多个.

咱们晓得了最根底的gradle配置，那么怎么来应用Gradle外面的一些货色来为咱们服务呢？

Plugin

后面提到apply plugin:'xxxx'，这些plugin都是依照gradle标准来实现的，有java的有Android的，那么咱们来实现一个本人的plugin.

把build.gradle 改为如下代码

//app build.gradleclass LibPlugin implements Plugin<Project>{    @Override    void apply(Project target) {        println 'this is lib plugin'    }}apply plugin:LibPlugin

运行./gradlew 后果如下

> Configure project :appthis is lib plugin

Plugin 之Extension

咱们在自定义的Plugin中要获取Project的配置，能够通过Project去获取一些根本配置信息，那咱们要自定义的一些属性怎么去配置获取呢，这时就须要创立Extension了，把上述代码改为如下模式。

//app build.gradleclass LibExtension{    String version    String message}class LibPlugin implements Plugin<Project>{    @Override    void apply(Project target) {        println 'this is lib plugin'        //创立 Extension         target.extensions.create('libConfig',LibExtension)        //创立一个task        target.tasks.create('libTask',{           doLast{               LibExtension config = project.libConfig               println config.version               println config.message           }        })    }}apply plugin:LibPlugin//配置libConfig {    version = '1.0'    message = 'lib message'}

配置实现后，执行./gradlew libTask 失去如下后果

> Configure project :appthis is lib plugin> Task :lib:libTask1.0lib message

看完上述代码，咱们就晓得android {} 其实他就是一个Extension， 他是由plugin 'com.android.application'或者'com.android.library' 创立。

Task

上述代码中，创立了一个名字为libTask的task,gradle中创立task的形式由很多中, 具体的创立接口在TaskContainer类中

//TaskContainerTask create(Map<String, ?> options) throws InvalidUserDataException;Task create(Map<String, ?> options, Closure configureClosure) throws InvalidUserDataException;Task create(String name, Closure configureClosure) throws InvalidUserDataException;Task create(String name) throws InvalidUserDataException;<T extends Task> T create(String name, Class<T> type) throws InvalidUserDataException;<T extends Task> T create(String name, Class<T> type, Action<? super T> configuration) throws InvalidUserDataException;

Project不能够执行跑起来，那么咱们就要定义一些task来实现咱们的编译，运行，打包等。com.android.application插件 为咱们定义了打包task如assemble，咱们方才定义的插件为咱们增加了一个libTask用于输入。

Task API

咱们看到创立的task外面能够间接调用doLast API，那是因为Task类中有doLast API,能够查看对应的代码看到对应的API

Gradle的一些Task

gradle 为咱们定义了一些常见的task，如clean，copy等，这些task能够间接应用name创立，如下:

task clean(type: Delete) {    delete rootProject.buildDir}

依赖task

咱们晓得Android打包时，会应用assemble相干的task，然而仅仅他是不能间接打包的，他会依赖其余的一些task. 那么怎么创立一个依赖的Task呢?代码如下

task A{    println "A task"}task B({    println 'B task'},dependsOn: A)

执行./graldew B 输入

A taskB task

自定义一个重命名APP名字的插件

通过上述的一些入门解说，大略晓得了gradle是怎么构建的，那当初来自定义一个安卓打包过程中，重命名APP名字的一个插件。

上述在build.gradle间接编写Plugin是OK的，那么为了复用性更高一些，那咱们怎么把这个抽出去呢？

如下

其中build.gradle为

apply plugin: 'groovy'apply plugin: 'maven'repositories {    mavenLocal()    jcenter()}dependencies {    compile gradleApi()}def versionName = "0.0.1"group "com.ding.demo"version versionNameuploadArchives{ //以后我的项目能够公布到本地文件夹中    repositories {        mavenDeployer {            repository(url: uri('../repo')) //定义本地maven仓库的地址        }    }}

apkname.properties为

implementation-class=com.ding.demo.ApkChangeNamePlugin

ApkChangeNamePlugin

package com.ding.demoimport org.gradle.api.Projectimport org.gradle.api.Pluginclass ApkChangeNamePlugin implements Plugin<Project>{    static  class ChangeAppNameConfig{        String prefixName        String notConfig    }    static def buildTime() {        return new Date().format("yyyy_MM_dd_HH_mm_ss", TimeZone.getTimeZone("GMT+8"))    }    @Override    void apply(Project project) {        if(!project.android){            throw new IllegalStateException('Must apply \'com.android.application\' or \'com.android.library\' first!');        }        project.getExtensions().create("nameConfig",ChangeAppNameConfig)        ChangeAppNameConfig config        project.afterEvaluate {            config = project.nameConfig        }        project.android.applicationVariants.all{            variant ->                variant.outputs.all {                    output ->                        if (output.outputFile != null && output.outputFile.name.endsWith('.apk')                                && !output.outputFile.name.contains(config.notConfig)) {                            def appName = config.prefixName                            def time = buildTime()                            String name = output.baseName                            name = name.replaceAll("-", "_")                            outputFileName = "${appName}-${variant.versionCode}-${name}-${time}.apk"                        }                }        }    }}

定义实现后，执行./gradlew uploadArchives 会在本目录生成对应对应的插件

利用插件 在根build.gralde 配置

buildscript {    repositories {        maven {url uri('./repo/')}        google()        jcenter()    }    dependencies {        classpath 'com.android.tools.build:gradle:3.4.1'        classpath 'com.ding.demo:apkname:0.0.1'    }}

在app.gralde 设置

apply plugin: 'apkname'nameConfig{    prefixName = 'demo'    notConfig = 'debug'}

Gradle doc 官网

Gradle的根底API差不多就介绍完了。

官网地址:docs.gradle.org/current/use…
能够去查看对应的API,也能够间接通过源码的形式查看

然而笔记还没完，学习了Gradle的根底，咱们要让其为咱们服务。上面介绍几个理论利用.

APT 技术

APT 全称Annotation Processing Tool，编译期解析注解，生成代码的一种技术。罕用一些IOC框架的实现原理都是它，驰名的ButterKnife，Dagger2就是用此技术实现的，SpringBoot中一些注入也是应用他进行注入的.

在介绍APT之前，先介绍一下SPI （Service Provider Interface）它通过在ClassPath门路下的META-INF/**文件夹查找文件，主动加载文件里所定义的类。 下面自定义的ApkNamePlugin 就是应用这种机制实现的，如下.

SPI 技术也有人用在了组件化的过程中进行解耦合。

要实现一个APT也是须要这种技术实现，然而谷歌曾经把这个应用APT技术从新定义了一个，定义了一个auto-service，能够简化实现,上面就实现一个简略Utils的文档生成工具。

Utils文档生成插件

咱们晓得，我的项目中的Utils可能会很多，每当新人入职或者老员工也不能实现晓得都有那些Utils了，可能会反复退出一些Utils，比方获取屏幕的密度，框高有很多Utils.咱们通过一个小插件来生成一个文档，当用Utils能够看一眼文档就很高深莫测了.

新建一个名为DocAnnotation的Java Libary

定义一个注解

@Retention(RetentionPolicy.CLASS)public @interface GDoc {   String name() default "";   String author() default "";   String time() default "";}

新建一个名为DocComplie 的 Java Libary先

而后引入谷歌的 auto-service，引入DocAnnotation

apply plugin: 'java-library'dependencies {    implementation fileTree(dir: 'libs', include: ['*.jar'])    implementation 'com.google.auto.service:auto-service:1.0-rc2'    implementation 'com.alibaba:fastjson:1.2.34'    implementation project(':DocAnnotation')}

定义一个Entity类

public class Entity {    public String author;    public String time;    public String name;}

定义注解处理器

@AutoService(Processor.class) //其中这个注解就是 auto-service 提供的SPI性能public class DocProcessor extends AbstractProcessor{    Writer docWriter;    @Override    public synchronized void init(ProcessingEnvironment processingEnvironment) {        super.init(processingEnvironment);    }    @Override    public Set<String> getSupportedAnnotationTypes() {        //可解决的注解的汇合        HashSet<String> annotations = new HashSet<>();        String canonicalName = GDoc.class.getCanonicalName();        annotations.add(canonicalName);        return annotations;    }    @Override    public SourceVersion getSupportedSourceVersion() {        return SourceVersion.latestSupported();    }    @Override    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment env) {        Messager messager = processingEnv.getMessager();        Map<String,Entity> map = new HashMap<>();        StringBuilder stringBuilder = new StringBuilder();        for (Element e : env.getElementsAnnotatedWith(GDoc.class)) {            GDoc annotation = e.getAnnotation(GDoc.class);            Entity entity = new Entity();            entity.name = annotation.name();            entity.author = annotation.author();            entity.time = annotation.time();            map.put(e.getSimpleName().toString(),entity);            stringBuilder.append(e.getSimpleName()).append("       ").append(entity.name).append("\n");        }        try {            docWriter = processingEnv.getFiler().createResource(                    StandardLocation.SOURCE_OUTPUT,                    "",                    "DescClassDoc.json"            ).openWriter();            //docWriter.append(JSON.toJSONString(map, SerializerFeature.PrettyFormat));            docWriter.append(stringBuilder.toString());            docWriter.flush();            docWriter.close();        } catch (IOException e) {            //e.printStackTrace();            //写入失败        }        return true;    }}

我的项目中援用

dependencies {    implementation project(':DocAnnotation')    annotationProcessor project(':DocComplie')}

利用一个Utils

@GDoc(name = "色彩工具类",time = "2019年09月18日19:58:07",author = "dingxx")public final class ColorUtils {}

最初生成的文档如下:

名称              性能            作者ColorUtils      色彩工具类        dingxx

当然最初生成的文档能够由本人决定，也能够间接是html等.

Android Transform

在说Android Transform之前，先介绍Android的打包流程，在执行task assemble时

在.class /jar/resources编译的过程中，apply plugin: 'com.android.application' 这个插件反对定义一个回调 (com.android.tools.build:gradle:2.xx 以上)，相似拦截器，能够进行你本人的一些定义解决，这个被成为Android的Transform

那么这个时候，能够动静的批改这些class，实现咱们本人想干的一些事，比方修复第三方库的bug，主动埋点，给第三方库增加函数执行耗时，实现动静的AOP等等.

咱们所晓得的 ARoute就应用了这种技术. 当然他是先应用了APT学生成路由文件，而后通过Transform加载.

以下内容援用自ARoute ReadMe

应用 Gradle 插件实现路由表的主动加载 (可选)
apply plugin: 'com.alibaba.arouter'buildscript {    repositories {       jcenter()    }    dependencies {        classpath "com.alibaba:arouter-register:?"    }}
可选应用，通过 ARouter 提供的注册插件进行路由表的主动加载(power by AutoRegister)， 默认通过扫描 dex 的形式 进行加载通过 gradle 插件进行主动注册能够缩短初始化工夫解决利用加固导致无奈间接拜访 dex 文件，初始化失败的问题，须要留神的是，该插件必须搭配 api 1.3.0 以上版本应用！

看ARoute的LogisticsCenter 能够晓得，init时，如果没有应用trasnform的plugin,那么他将在注册时，遍历所有dex，查找ARoute援用的相干类，如下

//LogisticsCenterpublic synchronized static void init(Context context, ThreadPoolExecutor tpe) throws HandlerException {  if (registerByPlugin) {        logger.info(TAG, "Load router map by arouter-auto-register plugin.");    } else {        Set<String> routerMap;        // It will rebuild router map every times when debuggable.        if (ARouter.debuggable() || PackageUtils.isNewVersion(context)) {             logger.info(TAG, "Run with debug mode or new install, rebuild router map.");            // These class was generated by arouter-compiler.            routerMap = ClassUtils.getFileNameByPackageName(mContext, ROUTE_ROOT_PAKCAGE);            if (!routerMap.isEmpty()) {                context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE).edit().putStringSet(AROUTER_SP_KEY_MAP,routerMap).apply();            }            PackageUtils.updateVersion(context);    // Save new version name when router map update finishes.        } else {            logger.info(TAG, "Load router map from cache.");            routerMap = new HashSet<>(context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE).getStringSet(AROUTER_SP_KEY_MAP, new HashSet<String>()));        }    }    ....}

Android Transform的实现简介

通过以上，咱们晓得，回调的是.class文件或者jar文件，那么要解决.class 文件或者jar文件就须要字节码解决的相干工具，罕用字节码解决的相干工具都有

  • ASM
  • Javassist
  • AspectJ

具体的具体，能够查看美团的推文 Java字节码加强探秘

怎么定义一个Trasnfrom内，回顾下面的gradle plugin实现，看以下代码

public class TransfromPlugin implements Plugin<Project> {    @Override    public void apply(Project project) {        AppExtension appExtension = (AppExtension) project.getProperties().get("android");        appExtension.registerTransform(new DemoTransform(), Collections.EMPTY_LIST);    }        class DemoTransform extends Transform{        @Override        public String getName() {            return null;        }        @Override        public Set<QualifiedContent.ContentType> getInputTypes() {            return null;        }        @Override        public Set<? super QualifiedContent.Scope> getScopes() {            return null;        }        @Override        public boolean isIncremental() {            return false;        }    }}

联合字节码减少技术，就能够实现动静的一些AOP，因为篇幅起因，这里就不在具体把笔记拿进去了，如果想进一步学习，举荐ARoute作者的一个哥们写的AutoRegister，能够看看源码

总结

到这里Gradle的学习笔记根本整顿实现了，因为作者程度无限，如果文中存在谬误，还请斧正，感激. 也举荐浏览我的另一篇文章，Android 修图（换证件照背景，污点修复）

本文转自 https://juejin.cn/post/6844903944439726087，如有侵权，请分割删除。

相干视频：

【2021最新版】Android studio装置教程+Android（安卓）零基础教程视频（适宜Android 0根底，Android初学入门）含音视频_哔哩哔哩_bilibili

Android 性能优化学习【二】：APP启动速度优化_哔哩哔哩_bilibili

Android 性能优化学习【三】：如何解决OOM问题_哔哩哔哩_bilibili