Android Gradle入门到精通(二)

1.背景

上节学完了Gradle的基础知识，这节学习下Gradle的自定义插件。自定义插件主要分为三种方式：

新建.gradle文件，应用到build.gradle中
new buildSrc java module
新建一个独立的java module 然后将插件发布到服务器或者本地仓库中

在工作中，这几种方式都见到别人使用过。学习完这章之后，我们可以定义一些插件给别人使用，配合apt能实现很多有意思的场景。

2.正题

2.1 自定义.gradle文件

实现目标：自定义一个拓展，然后在apk打包的时候，将拓展信息读取出来

自定义一个gradlePlugin.gradle

class Address{
    public String nation
    public String city;
}
class MyPlugin{
    public String name;
    public Address address=new Address();
    // 配置方法
    void addressConfig(Action<Address> action) {
        action.execute(address) // 直接执行 action 参数的 execute 方法，并传入扩展对象
    }
}

project.getExtensions().create("myPlugin",MyPlugin)

//所有配置加载完毕之后
project.afterEvaluate {
    project.tasks.getByName("assembleDebug").doLast {
        MyPlugin mMyPlugin= project.getExtensions().getByName("myPlugin");
        println "name: "+mMyPlugin.name+"   "+mMyPlugin.address.city+"  "+mMyPlugin.address.nation
    }
}

ps：注意 project.tasks.getByName("assembleDebug") 要在 project.afterEvaluate中。不然会提示找不到名为 “assembleDebug”的task。

之后build.gradle中：

apply from: "gradlePlugin.gradle"
配置拓展信息

myPlugin {
    name = "wxy"
    addressConfig {
        nation = "湖北"
        city = "武汉"
    }
}

打印结果:

> Task :app:assembleDebug
name: wxy   武汉  湖北

2.2 创建 java buildSrc module

创建一个java 的module。名称一定得为buildSrc
settings.gradle 中将buildSrc注释掉
更改buildSrc 下面的build.gradle

apply plugin: 'groovy'  //必须
apply plugin: 'maven'

dependencies {
    implementation gradleApi() //必须
    implementation localGroovy() //必须
    //如果要使用android的API，需要引用这个，实现Transform的时候会用到
    //implementation 'com.android.tools.build:gradle:3.3.0'
}
sourceSets {
    main {
        groovy {
            srcDir 'src/main/groovy'
        }
        java {
            srcDir "src/main/groovy"
        }
        resources {
            srcDir 'src/main/resources'
        }
    }
}

repositories {
    //google()
    jcenter()
    mavenCentral() //必须
}

自定义插件MyPlugin.groovy

package com.heytap.tv
import org.gradle.api.Plugin
import org.gradle.api.Project

class MyPlugin implements Plugin<Project> {
    @Override
    void apply(Project target) {
        println(" hello world ")
    }
}

在main文件夹下创建resources，创建响应的.properties文件。注意包名，全类名

在app 的build.gradle 中引入此插件

apply plugin: 'com.heytap'

之后重新构建下，就能引入buildSrc中自定义的 gradle

2.3 创建独立的java module ，并发布到本地或服务器

创建一个java的 module gradle-plugin, 不用在setting.gradle中将其注释掉
更改gradle-plugin 下的 build.gradle文件，和buildSrc实现插件的build.gradle 一样即可

创建MyPlugin2.groovy 文件，注意代码文件路径 : 'src/main/groovy'

package com.heytap.demo
import org.gradle.api.Plugin
import org.gradle.api.Project
class MyPlugin2 implements Plugin<Project> {
    @Override
    void apply(Project project) {
        println(" hello buildSrc MyPlugin2")
    }
}

在main文件夹下创建resources，创建响应的.properties文件。注意包名，全类名 。如上所示

image.png

在gradle-plugin 下的 build.gradle下添加一下Extension,表示将插件发布到本地仓库 repos。

def group='com.heytap.plugin' //组
def version='1.0.0' //版本
def artifactId='myplugin2' //唯一标示

//将插件打包上传到本地maven仓库  ,uploadArchives 可以在AppExtension 查询到
uploadArchives {
    repositories {
        mavenDeployer {
            pom.groupId = group
            pom.artifactId = artifactId
            pom.version = version
            //指定本地maven的路径，在项目根目录下
            repository(url: uri('../repos'))   //插件路径，最终以jar形式结尾
        }
    }
}

之后打开gradle 面板，找到 gradle-plugin 点击uploadArchives 将插件打包到本地的repos文件中

image-20211118202810571.png

引用独立插件

在根项目的build.gradle中引入此插件

        ....
        maven {
            url uri('./repos') //指定本地maven的路径，在项目根目录下
        }
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:4.1.1'
        classpath 'com.heytap.plugin:myplugin2:1.0.0'   //自定义的gradle插件路径
    }
}

在 app的 build.gradle 中：

apply plugin : "com.heytap.demo"

运行结果: