Android Strudio 自定义Gradle Plugin

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

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


Gradle Plugin 目录结构.png

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


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<Project> {
    @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如下图:


生成插件.png

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


插件路径.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如下图:


Gradle Plugin 运行.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,969评论 19 139
  •   在android studio中gradle作为主要的构建工具,其核心工作任务在于执行一系列的Task。而pl...
    PantheraLe_253e阅读 3,260评论 0 4
  • 这篇文章讲给大家带来gradle打包系列中的高级用法-自己动手编写gradle插件。我们平常在做安卓开发时,都会在...
    呆萌狗和求疵喵阅读 16,030评论 22 80
  • 前言 我们平常在进行Android开发时,都会使用 Gradle[https://gradle.org/guide...
    Whyn阅读 11,048评论 5 16
  • 目录 实践使用插件开发插件编写插件优先编写和使用自定义任务类型受益于增量任务建模类DSL的API捕获用户输入来配置...
    spt_genius阅读 1,656评论 0 4