Gradle插件Hello world实践

前言

Gradle是一个很强大的构建工具,掌握Gradle也是安卓开发人员走向高级的一项必备技能,当然,完全了解它需要花费不少功夫。在看本文之前,最好先去了解一下Gradle的一些基本概念,比如Project,Task,Gradle的生命周期等概念,了解了这些,我们就可以尝试编写gradle插件了,gradle插件可以说是gradle十分灵活强大的功能,本文就详细介绍一下插件的HelloWorld项目构建,网上有不少相关文章,但当我实践一遍才发现好多文章写的要么不详细,要么有坑,你照着上面来发现根本构建不成!所以才有了写这篇文章的动机。

开始编写

Gradle插件有三种构建方式类型:

说明
Build script 把插件写在 build.gradle 文件中,一般用于简单的逻辑,只在该 build.gradle 文件中可见
buildSrc 项目 将插件源代码放在 rootProjectDir/buildSrc/src/main/groovy 中,只对该项目中可见,适用于逻辑较为复杂
独立项目 一个独立的 Groovy 和 Java 项目,可以把这个项目打包成 Jar 文件包,一个 Jar 文件包还可以包含多个插件入口,将文件包发布到托管平台上,供其他人使用。本文将着重介绍此类。

一般来说,我们写完插件最后都是要上传到私服或者公共仓库里供大家使用的,所以我们只考虑第三种情况。

步骤1,新建工程,新建插件module:

在AndroidStudio中新建一个Project,我们起名叫“GradlePlugin”,选择默认配置即可。新建完成后,选择file-new-New Module新建一个Module,我们起名就叫plugin吧,类型选择Android Library就行,待会会修改它的build.gradle。

步骤2,删除新module中的无用文件,新建插件文件。

等AndroidStudio构建完成以后我们把新Module中的无用文件夹删掉,包括测试文件,Manifest,res文件夹,然后然后我们将src/main目录下面的所有文件删掉,在main目录下新建两个包,一个叫groovy,一个叫resources,注意名字不要写错,两个文件夹分别存放插件代码和属性文件。接下来:在groovy文件夹下,新建一个带有路径的groovy文件,我们这里新建的名字叫com.bruce.demo.HelloWorld.groovy,这里的包路径和文件名都可以随便起,在HelloWorld.groovy中写入以下内容:

package com.bruce.demo

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

class HelloWorld implements Plugin<Project> {

    @Override
    void apply(Project project) {
        println("------------hello world!------------")
    }
}

简单的一个helloworld。之后在resources文件夹下新建文件,直接看下图所示:


项目目录结构.png

{:height="50%" width="50%"}

注意,META-INFO和gradle-plugins是两层文件夹路径,千万别写错了,大家一定要按照图中对应的结构编写,仔细对照一遍。

我们看com.bruce.hello.properties这个文件,首先是它的名字,这个名字很重要,.properties前面的字符串就是最后我们apply插件的名字,也就是我们 apply plugins 'xxxxxxxx'中的xxxxxx,这里我起的名叫com.bruce.hello,然后我们看这个文件里面的内容,很简单,只有一行:

implementation-class=com.bruce.demo.HelloWorld

也就是我们前面编写的HelloWorld.groovy的路径+类名,这里注意,后面不要加.groovy后缀,我这里就被网上的博客给坑了。

完成了这一步其实插件已经可以用了,但是为了能共享我们的插件,我们进入第三步,把module上传到maven仓库

步骤三,编写插件module的build.gradle我们直接把新建module自动生成的build.gradle内容全部替换成下面代码:

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

repositories {
    mavenCentral()
}

dependencies {
    implementation gradleApi()//gradle sdk
    implementation localGroovy()//groovy sdk
    implementation fileTree(dir: 'libs', include: ['*.jar'])
}

uploadArchives {
    repositories {
        mavenDeployer {
            //设置插件的GAV参数
            pom.groupId = 'com.bruce.local'
            pom.version = '1.0.0'
            pom.artifactId = 'hello'
            //文件发布到下面目录
            repository(url: uri('../repo'))
        }
    }
}

代码很简单,我们要引入groovy和maven插件,这个插件就是帮助我们上传本地插件module用的,它会自动把我们的插件Module打成jar包上传到配置的仓库中去,我们只需要编写一个上传包的task,即uploadArchives里面的代码。我们看配置的四个属性是什么意思:

pom.groupId,version,artifactId分别表示我们这个包的组名,版本已经名字,其实就像我们引入第三方依赖里面的"com.goole.xxxx:yyyy:2.3.4"类似,就是这个第三方包的唯一标识。这里注意,如果不写artifactId,它会给我门生成一个默认的artifactId,名字就是module的名字。

最后repository,就是仓库的位置,可以是远程的私有仓库或者公开的仓库,也可以是本地文件夹,本文用的是本地文件夹,即放到项目根目录下新建的一个repo的目录中。

接下来,我们执行一下upload这个task,等待一会就上传完毕了,我们看项目里多了一个目录repo,里面有我们生成的插件库。接下来,我们在主项目里就可以使用这个插件了。

在主项目中使用插件

使用插件需要修改项目根目录下的build.gradle和app module下的build.gradle,我们分别来看:

打开根目录下的build.gradle,填入以下内容:

buildscript {
    repositories {

        maven{
            url './repo/'
        }
        google()
        jcenter()

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.1'
        classpath 'com.bruce.local:hello:1.0.0'
    }
}

allprojects {
    repositories {
        google()
        jcenter()

    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

相比于默认配置,修改了两处:添加maven地址,让其URL指向我们插件的本地路径,也就是代码中的第三行。第二处就是在dependencies中添加我们插件的classpath。classpath这个东西可以理解成加载插件的所依赖需要的资源,(implemetation是项目需要依赖的资源,一个是给构建工程用的,另一个是项目代码用到的,要打到最终apk里的)。

经过上面的配置,主项目已经配置好了插件需要的资源,接下来我们就在app module中引入插件就可以使用啦~很简单,在app的build.gradle中加入:

apply plugin 'com.bruce.hello'

大功告成~

如果你搞了半天还是不行,请查看项目 https://github.com/hellojym/GradlePlugin

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

推荐阅读更多精彩内容