Android Strudio 自定义Gradle Plugin

时间:2021-6-3 作者:qvyue

以前我们都是在用Gradle Plugin,例如我们最熟悉的, apply plugin: ‘com.android.application’和apply plugin: ‘com.android.library’,本篇文章就带领大家自定义Gradle Plugin。

1.创建一个Library Module
File->New->New Module->Android Library
将目录形式修改成下图:

Android Strudio 自定义Gradle Plugin
Gradle Plugin 目录结构.png

2.META-INF.gradle-plugins,如果你直接创建一个文件夹名字是这个,那么恭喜你无论你怎么调试都会报错,apply plugin 找不到XXX id。在Finder中看这是两个文件夹,所以创建的时候一定要先创建一个文件夹名字META-INF,再创建一个文件夹名字gradle-plugins,如下图:

Android Strudio 自定义Gradle Plugin
META-INF.gradle-plugins目录形式.png

3.component_gradle_plugin.properties填写如下内容

implementation-class=com.component.gradle.plugin.ComponentGradlePlugin

这个文件保存的是插件调用类的路径。
文件的名字component_gradle_plugin就是插件的名字,调用时写如下代码:

apply plugin: 'component_gradle_plugin'

4.修改build.gradle内容:

apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
    //gradle sdk
    compile gradleApi()
    //groovy sdk
    compile localGroovy()
}
repositories {
    mavenCentral()
}
group = 'com.component.gradle.plugin'
version = '0.0.1'
uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('../repo'))
        }
    }
}

这段代码将编译好生成的插件放到../repo目录下,用如下代码引用这个插件

dependencies {
       ......
        classpath 'com.component.gradle.plugin:component_gradle_plugin:0.0.1'
    }

4.在groovy目录下创建包名和类,这个类的路径就是resources/META-INF/gradle-plugins/component_gradle_plugin.properties,文件的内容,运行之后插件就会调用ComponentGradlePlugin类中的apply方法,如下ComponentGradlePlugin.java代码:

public class ComponentGradlePlugin implements Plugin {
    @Override
    public void apply(Project project) {
        System.out.println("ComponentGradlePlugin--------- start");
        System.out.println("hello apply");    
        System.out.println("ComponentGradlePlugin--------- end");
        System.out.println();
    }
}

5.编译生成插件,点击右侧的Gradle,找到uploadArchives如下图:

Android Strudio 自定义Gradle Plugin
生成插件.png

编译完成在项目的repo中会看到插件如下图:

Android Strudio 自定义Gradle Plugin
插件路径.png

6.使用插件:
project/build.gradle 增加如下代码:

buildscript {
    repositories {
        ......
        maven {
          //配置本地插件目录
            url uri('./repo')
        }
    }
    dependencies {
        ......
        classpath 'com.component.gradle.plugin:component_gradle_plugin:0.0.1'
    }
}
allprojects {
    repositories {
        ......
        maven {
           //配置本地插件目录
            url uri('./repo')
        }
    }
}

app/build.gradle 增加代码

apply plugin: 'component_gradle_plugin'

rebuild project 查看运行结果GradleConsole如下图:

Android Strudio 自定义Gradle Plugin
Gradle Plugin 运行.png
声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:qvyue@qq.com 进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。