概述
android項目構建主要由com.android.application及com.android.library兩個插件完成,要了解android構建及插
件化,gradle插件學習是必由之路。
Gradle相關語法
在這里不再重復Gradle相關的語法,如果要學習gradle相關的東西,請查看上篇
http://www.lxweimin.com/p/57d99c983a7a。官方文檔上也有自定義插件的介紹。
插件類型
Gradle的插件一般有這么幾種:
一種是直接在項目中的gradle文件里編寫,這種方式的缺點是無法復用插件代碼,在其他項目中還得復制一遍代碼(或者說說復制一遍文件)
另一種是在獨立的項目里編寫插件,然后發布到中央倉庫,之后直接引用就可以了,優點就是可復用(重點學習這種)。
Gradle插件開發
Gradle插件是使用Groovy進行開發的,而Groovy其實是可以兼容Java的。AndroidStudio其實除了開發androidApp外,完全可以勝任開發Gradle插件這一工作,下面來講講具體如何開發。
1:首先,新建一個Android項目。
2:之后,新建一個Android Module項目,類型選擇Android Library。(AndroidStudio中是沒有新建類似Gradle Plugin這樣的選項的,那我們如何在AndroidStudio中編寫Gradle插件)
3:將新建的Module中除了build.gradle文件外的其余文件全都刪除,然后刪除build.gradle文件中的所有內容后改為如下。
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
//gradle sdk
compile gradleApi()
//groovy sdk
compile localGroovy()
}
repositories {
url ***
}
4:在新建的module中新建文件夾src,接著在src文件目錄下新建main文件夾,在main目錄下新建groovy目錄,這時候groovy文件夾會被Android識別為groovy源碼目錄(由于gradle是基于groovy,因此,我們開發的gradle插件相當于一個groovy項目)。
package com.peyton.test
import org.gradle.api.Plugin
import org.gradle.api.Project
public class PluginImpl implements Plugin<Project> {
void apply(Project project) {
System.out.println("========================");
System.out.println("hello gradle plugin!");
System.out.println("========================");
}
}
5:除了在main目錄下新建groovy目錄外,你還要在main目錄下新建resources目錄,同理resources目錄會被自動識別為資源文件夾。在groovy
目錄下新建項目包名,就像Java包名那樣。resources目錄下新建文件夾META-INF,META-INF文件夾下新建gradle-plugins文件夾。然后在
resources/META-INF/gradle-plugins目錄下新建一個properties文件,注意該文件的命名就是你只有使用插件的名字,這里命名為com.peyton.testplugin.properties,在里面輸入
implementation-class=com.peyton.test.PluginImpl(指向項目groovy目錄下Plugin子實現類)
目前,項目的結構是這樣的。
6:上傳maven,將項目寫好的上傳gradle腳本(主要配置了uploadArchives中需要用到的groupId,artifactId及version),復制到項目下然后執行uploadArchives task,即上傳到maven。
也可以先上傳到本地的maven,方法如下:
6.1:在插件module的build.gradle中
//group和version在后面使用自定義插件的時候會用到
group='com.tc.plugin'
version='1.0.0'
uploadArchives {
repositories {
mavenDeployer {
//提交到遠程服務器:
// repository(url: "http://****/repos") {
// authentication(userName: "***", password: "***")
// }
//本地的Maven地址設置為D:/repos
repository(url: uri('../repo'))
}
}
}
6.2 在使用的module的build.gradle中
buildscript {
repositories {
maven {//本地Maven倉庫地址
url uri('../repo')
}
}
dependencies {
//格式為-->group:module:version
classpath 'com.tc.plugin:myplugin:1.0.0'
}
}
//com.hc.gradle為resources/META-INF/gradle-plugins
//下的properties文件名稱
apply plugin: 'com.peyton.testplugin'
7:項目中使用:在項目中需要用到插件的地方引入插件,如app目錄下build.gradle
buildscript {
repositories {
maven {//本地Maven倉庫地址
url ***********
}
}
dependencies {
//格式為-->groupId:artifactId:version
classpath 'com.plugin.test:myplugin:1.0.0'
}
}
//com.peyton.testplugin為resources/META-INF/gradle-plugins
//下的properties文件名稱
apply plugin: 'com.peyton.testplugin'
以上就完成了最簡單的插件
簡單自定義配置并讀取build.gradle值
根據Gradle官網的介紹,Project是你與Gradle交互的主接口,故將Project作為自定義Plugin的泛型傳入
implements Plugin<Project>
通過Project訪問的使用場景:Extension。先看一個熟悉的內容:
android {
compileSdkVersion 24
buildToolsVersion "24.0.0"
defaultConfig {
applicationId "com.peyton.test"
minSdkVersion 15
targetSdkVersion 24
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
上面的android{}、compileSdkVersion、defaultConfig {}等等這些設置就是通過Extension。下面我們自定義一個Extension。首先,定義兩個Groovy類:Address和TestExtension.
class Address{
String province=null
String city=null
}
class TestExtension{
String myName = null;
}
再自定義Plugin:
class PluginImpl implements Plugin<Project> {
@Override
void apply(Project project) {
project.extensions.create('tc',TestExtension);
project.extensions.create('address', Address);
project.task('readExtension') << {
def address=project['address']
println project['tc'].myName
println address.province+" "+address.city
}
}
}
接下來就是使用插件(即build.gradle 中):
apply plugin 'com.peyton.testplugin'
tc {
address{
province "Fujian"
city "Xiamen"
}
myName "Peyton"
}
com.peyton.testplugin
這一行會導致直接執行PluginImpl 類的apply方法。所以,tc{}
這個塊必須放在com.peyton.testplugin
之后,因為在沒有執行project.extensions.create('tc',TestExtension);
之前,使用tc{}會報錯!address{}也是同理。另外,補充一下:project.extensions相當于project.getExtensions()即返回的是ExtensionContainer對象(上一篇groovy語法特性中有講到)而ExtensionContainer對象的create方法就是把tc{}
與TestExtension
對應起來。其他通過project.的方式也是同樣的道理。再看看project.task('readExtension'),這是創建一個task。相當于在build.gradle文件中的task xxx <<{}只不過這里是通過代碼的方式動態創建.接下來只需要在命令行中運行readExtension 任務即可看下如下信息
:testmodule:readExtension
Peyton
Fujian Xiamen