gradle学习-自定义gradle插件

公司项目中有用到gradle插件,网上很多都讲的不是很好,现在总结一下自定义一个gradle插件的步骤:

1、新建一个Android project

2、新建一个Android lib module,

3、并把main文件夹下的所有资源文件(res文件夹)、AndroidMainfest.xml文件、java文件全部删除。只保留gradle文件和src/main目录。

image.png

4、在main文件夹下新建一个groovy文件夹,接着在新建一个LinkPlugin.groovy文件,和java一样,这个groovy文件的包名为com.link.plugin

image.png

5、让LinkPlugin视线Plugin<Project>接口,并实现apply方法,apply方法中其实就是我们要写的插件的逻辑。

package com.link.plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

public class LinkPlugin implements Plugin<Project> {

  void apply(Project project) {
    System.out.println("========================");
    System.out.println("hello gradle plugin!");
    System.out.println("========================");
  }
}

6、新建好了插件,那么我们怎么才能找到插件呢?在main文件夹下,新建一个resources/META-INF/gradle-plugins文件夹,并在该文件夹下新建一个com.link.plugin.properties文件里添加如下代码:

implementation-class=com.link.plugin.LinkPlugin

implementation-class后面跟的是前面我们定义插件的全类名。

properties文件夹的位置如下:

image.png

注意:properties文件的名称是插件的id,当我们使用apply关键字应用插件的时候会使用到

(7) 因为我们要用到groovy以及后面打包要用到maven,所以在我们自定义的Module下的build.gradle需要添加如下代码:

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
    //gradle sdk
    compile gradleApi()
    //groovy sdk
    compile localGroovy()
}

repositories {
    mavenCentral()
}


打包到本地Maven

前面我们已经自定义好了插件,接下来就是要打包到Maven库里面去了,你可以选择打包到本地,或者是远程服务器中。在我们自定义Module目录下的build.gradle添加如下代码:

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
  //gradle sdk
  compile gradleApi()
  //groovy sdk
  compile localGroovy()
}

repositories {
  mavenCentral()
}

group='com.link.plugin'
version='1.0.0'

uploadArchives {
  repositories {
    mavenDeployer {
      //提交到远程服务器:
      // repository(url: "http://www.xxx.com/repos") {
      //    authentication(userName: "admin", password: "admin")
      // }
      //本地的Maven地址设置为D:/repos
      repository(url: uri('C:/repos'))
    }
  }
}

其中,group和version后面会用到,我们后面再讲。虽然我们已经定义好了打包地址以及打包相关配置,但是还需要我们让这个打包task执行。点击AndroidStudio右侧的gradle工具,如下图所示:

image.png

可以看到有uploadArchives这个Task,双击uploadArchives就会执行打包上传啦!执行完成后,去我们的Maven本地仓库查看一下:

image.png

我们打开maven-metadata.xml文件看看

image.png

里面可以看出,插件的groupId为com.link.plugin,artifactId为plugin,默认是module的名称,version是1.0.0

使用插件

接下来就是使用自定义的插件了,一般就是在app这个模块中使用自定义插件,因此在app这个Module的build.gradle文件中,需要指定本地Maven地址、自定义插件的名称以及依赖包名。简而言之,就是在app这个Module的build.gradle文件中后面附加如下代码:

buildscript {
    repositories {
        maven {//本地Maven仓库地址
            url uri('C:/repos')
        }
    }
    dependencies {
        //格式为-->groupId:artifactId:version
        classpath 'com.link.plugin:plugin:1.0.0'
    }
}
//com.link.plugin为resources/META-INF/gradle-plugins
//下的properties文件名称
apply plugin: 'com.link.plugin'

好啦,接下来就是看看效果啦!先clean project(很重要!),然后再make project.从messages窗口打印如下信息:

image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容