Gradle 起底 第一篇
亦余心之所善兮,雖九死其猶未悔
Gradle 的源代碼地址 https://github.com/gradle/gradle ,可以看到Gradle的源碼里(基于 Gradle 大版本的 version 6)java 占比44% Groovy 占比46%,源碼里面大部分的核心代碼核心模塊都是java 語(yǔ)言編寫,test 代碼主要是由Groovy語(yǔ)言編寫。
目錄結(jié)構(gòu)
往往高端的代碼都以一種樸素的呈現(xiàn)方式,以gradle-6.3-all 為例,解壓之后目錄結(jié)構(gòu)如下:
***bin
*****gradle(unix and linux 啟動(dòng)腳本)
*****gradle.bat(windows 啟動(dòng)腳本)
***docs
***init.d(自定義的init.gradle 位置)
***lib(編譯好的jar包)
***src(源碼)
**LICENSE
**NOTICE
**README
啟動(dòng)Gradle就是從bin 目錄下的啟動(dòng)腳本文件觸發(fā)到lib目錄下的jar里的某個(gè)java的main函數(shù)。以gradle.bat 為例,其中最終調(diào)用的位置如下:入口類是org.gradle.launcher.GradleMain。
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.launcher.GradleMain %CMD_LINE_ARGS%
如果這個(gè)時(shí)候繼續(xù)跟著這個(gè)GradleMain深入閱讀源碼的話,很快就會(huì)陷入一堆細(xì)節(jié),所以在這里就不繼續(xù)深入了。
Gradle 腳本文件
那我們換個(gè)方向來(lái)再去觀察 Gradle 。".gradle" 文件是一個(gè)很好的入手點(diǎn):
apply plugin: 'java'
...
dependencies {
compile 'org.codehaus.groovy:groovy-all:2.3.11'
...
}
看到這個(gè)文件很熟悉但是肯定有很多疑問(wèn),比如 apply plugin: 'java' 干什么了,誰(shuí)來(lái)編譯它或者解釋它給機(jī)器呢等等,為了能解答這個(gè)問(wèn)題,需要好好了解一下Groovy。".gradle" 文件其實(shí)就是Groovy的的腳本文件。在這里我簡(jiǎn)單的以java程序員可以理解的方式解釋一下apply plugin: 'java',在Gradle代碼中有一個(gè)java函數(shù)它的名字是apply,它的參數(shù)是一個(gè)閉包:
public void apply(Closure<?> closure){
....
}
什么是閉包請(qǐng)找代駕:http://groovy-lang.org/closures.html
要強(qiáng)調(diào)一點(diǎn)哈,Groovy 是基于JVM,所以呢, 這個(gè)腳本文件也是會(huì)像java文件一樣被編譯成.class 文件, 然后被加到j(luò)vm虛擬機(jī)里運(yùn)行。
所以就可以從網(wǎng)絡(luò)上繼續(xù)獲取Groovy 腳本的運(yùn)行原理, 以及Groovy 作為DSL的支柱: 元對(duì)象協(xié)議(Meta Object Protocol)簡(jiǎn)稱MOP,基于這個(gè)協(xié)議就有了運(yùn)行時(shí)和編譯時(shí)的兩種 metaprogramming, 細(xì)節(jié)和干貨都在這個(gè)鏈接里面 http://groovy-lang.org/metaprogramming.html。
如果上面的鏈接你都看完了, 那你的英語(yǔ)應(yīng)該過(guò)了六級(jí)。回正題,要了解".gradle"文件的運(yùn)行。先把腳本文件編譯出來(lái)的class 文件show 出來(lái)。
....
public class build_xxxx extends ProjectScript{
....
public Object run()
{
CallSite acallsite[] = $getCallSiteArray();
acallsite[0].callCurrent(this,ScriptBytecodeAdapter.createMap(new Object[] {
"plugin", "java"
}));
...
}
private static void $createCallSiteArray_1(String as[])
{
as[0] = "apply";
...
}
private static CallSite[] $getCallSiteArray()
{
...
callsitearray = $createCallSiteArray_1(s);
...
return callsitearray.array;
}
}
熟悉Groovy Script 腳本的同學(xué)大概就知道,這個(gè)腳本的run方法是運(yùn)行的入口, 通過(guò)上邊所提到過(guò)的MOP,就把腳本的編譯和方法的調(diào)用分開(kāi)了(這里用到的是的運(yùn)行時(shí)的metaprogramming),簡(jiǎn)單描述就是編譯的時(shí)候腳本文件只要符合Groovy 或者java語(yǔ)法要求,而函數(shù)的具體實(shí)現(xiàn)在編譯期是不需要知道的,只是記錄函數(shù)的名字和參數(shù),在運(yùn)行的時(shí)候根據(jù)特定的查找順序去尋找方法的調(diào)用,沒(méi)圖沒(méi)真相, 上圖:
Gradle 腳本的編譯與調(diào)用時(shí)機(jī)
在上面的段落里簡(jiǎn)單的過(guò)了一下腳本的一些信息吧, 現(xiàn)在肯定有同學(xué)會(huì)覺(jué)得更加疑問(wèn), 這個(gè)腳本是誰(shuí)去編程class的,OK, 首先當(dāng)然是你的電腦,并且也是你正在運(yùn)行的Gradle去編譯的,Gradle 運(yùn)行之后不久就會(huì)查找settings.gradle,然后通過(guò)settings.gradle 里的project的配置去一一查找并且編譯那些build.gradle 文件,對(duì)于'apply from : "xx.gradle"' 串聯(lián)的腳本文件, 是在執(zhí)行到 apply 這個(gè)方法的時(shí)候去查找并且編譯的。這里我就直接先給出Gradle 源碼里的相關(guān)類:DefaultScriptCompilationHandler.java 以及一個(gè)代碼片段吧:當(dāng)然首先要澄清一下這里省略了很多邏輯,比如buildscript{} 代碼塊里的代碼會(huì)先于普通代碼的編譯,以及gradle的編譯緩存機(jī)制(就是沒(méi)改變的不會(huì)再次編譯)。
private void compileScript(ScriptSource source, ClassLoader classLoader, CompilerConfiguration configuration, File metadataDir,
final CompileOperation<?> extractingTransformer, final Action<? super ClassNode> customVerifier) {
...
GroovyClassLoader groovyClassLoader = new GroovyClassLoader(classLoader, configuration, false) ...
groovyClassLoader.setResourceLoader(NO_OP_GROOVY_RESOURCE_LOADER);
String scriptText = source.getResource().getText();
String scriptName = source.getClassName();
GroovyCodeSource codeSource = new GroovyCodeSource(scriptText == null ? "" : scriptText, scriptName, "/groovy/script");
try {
try {
groovyClassLoader.parseClass(codeSource, false);
...
}
groovyClassLoader.parseClass 這個(gè)怎么生成class, 不是本文的范疇。編譯好的class文件會(huì)放在.gradle\caches\版本號(hào)\scripts-remapped 目錄下。
關(guān)于調(diào)用時(shí)機(jī),先關(guān)的類先放出來(lái):DefaultScriptRunnerFactory.java。
...
T script = getScript();
script.init(target, scriptServices);
Thread.currentThread().setContextClassLoader(script.getContextClassloader());
script.getStandardOutputCapture().start();
try {
script.run();
} catch (Throwable e) {
...
邊(編)玩(完)就run,果然比較牛逼:如下圖。
...
//Pass 2, compile everything except buildscript {}, pluginManagement{}, and plugin requests, then run
final ScriptTarget scriptTarget = secondPassTarget(target);
scriptType = scriptTarget.getScriptClass();
CompileOperation<BuildScriptData> operation = compileOperationFactory.getScriptCompileOperation(scriptSource, scriptTarget);
final ScriptRunner<? extends BasicScript, BuildScriptData> runner = compiler.compile(scriptType, operation, targetScope, ClosureCreationInterceptingVerifier.INSTANCE);
if (scriptTarget.getSupportsMethodInheritance() && runner.getHasMethods()) {
scriptTarget.attachScript(runner.getScript());
}
if (!runner.getRunDoesSomething()) {
return;
}
Runnable buildScriptRunner = () -> runner.run(target, services);
Gradle 腳本的函數(shù)的調(diào)用
在上面的某個(gè)地方應(yīng)該提到過(guò)MOP,Groovy 擁有一套查找機(jī)制,當(dāng)然僅僅憑借這一點(diǎn)的靈活性完全無(wú)法滿足Gradle 那些優(yōu)(變)雅(態(tài))的需求。所以Gradle源碼又創(chuàng)建了DynamicObject所引申出來(lái)的一套函數(shù)和屬性的查找機(jī)制。有點(diǎn)復(fù)雜會(huì)在后面續(xù)的文章里講解。如果你等待不急的話也可以從我基于Gradle思想,所創(chuàng)建的一個(gè)log 分析項(xiàng)目的源代碼看看:https://github.com/tianxunaicaoke/LogSpin,畢竟我的代碼(需)比(要)Gradle(你)的(來(lái))源(點(diǎn))碼(亮)簡(jiǎn)(星)單(星)多了。