Andorid Gradle插件

1. Gradle

1). 资料

• Gradle 基于 groovy 语言，groovy 官网
• Gradle DSL
• Android Plugin DSL
• Gradle task

2). 查看所有任务

./gradlew tasks --all

• compileDebugJavaWithJavac：编译 java 文件
• processDebugManifest：生成最终 AndroidManifest 文件
• compileDebugAidl：编译 AIDL 文件
• packageDebug：打包成 apk
• transformClassesAndResourcesWithProguardForRelease task，即为 release 包混淆。

2. 插件基础

1). 基本步骤

• 创建Android项目
• 新建一个Java Library Module, 该module必须命名为buildSrc
• 将src/main/java修改为src/main/groovy
• 在groovy文件夹下，新建xxxPlugin.groovy, 并实现Plugin接口, 泛型参数为Project
  注：由于 Kotlin/Java 与 groovy 的兼容，所以并非一定要创建 groovy 文件，也可以是 xxxPlugin.java/xxxPlugin.kotlin

2). 项目目录结构

项目目录结构.png

3). TestGlugin.groovy

class TestPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {
        // 执行任务
        project.task('pluginTest') {
            doFirst {
                println "mazaiting"
            }
            doLast {
                println "Hello World!"
            }
        }
    }
}

4). 应用

在app/build.gradle文件中应用

apply plugin: TestPlugin

5). 执行任务

在项目的根目录下运行

gradlew pluginTest

图1.png

3. 扩展

需求，用户自定义输出内容

1). 创建TestPluginExtension类

class TestPluginExtension {
    String message = 'Hello World'
}

2). 创建TestExtension类

class TestExtension implements Plugin<Project> {

    @Override
    void apply(Project project) {
        // 这个名称在*.gradle文件中使用
        def extension = project.extensions.create("testExtension", TestPluginExtension)
        // 这个任务名在命令行中使用
        project.task('pluginTestExtension') {
            doLast {
                println extension.message
            }
        }
    }
}

3). 应用

在app/build.gradle文件中应用

apply plugin: TestExtension

testExtension {
    message 'mazaiting'
}

4). 执行命令

gradlew pluginTestExtension

图2.png

4. 项目化

1). 修改build.gradle

apply plugin: 'groovy'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

gradle同步之后， External Libraries 中多出了 gradle-api/gradle-installation-beacon/groovy 库。

图3.png

2). 创建配置文件

• 创建 src/main/resources/META-INF/gradle-plugins/插件名.properties，例如 src/main/resources/META-INF/gradle-plugins/com.mazaiting.properties
• properities 文件内容改为 implementation-class=Plugin 路径，例如 implementation-class=com.mazaiting.TestExtension

图4.png

3). 应用

在 build.gradle 文件中通过 apply plugin: '插件名' 引入插件 —— apply plugin: 'com.mazaiting'。

图5.png

4). 执行

gradlew pluginTestExtension

5). 结果

图6.png

6). 上传到Jcenter

代码下载