一、前言
現(xiàn)在Android開發(fā)最常用的IDE就是Android Studio了念颈。在Android Studio中使用了Gradle構(gòu)建功能，這使得模塊之間的管理、依賴都非常的方便清晰梢为。
同時(shí)，國內(nèi)比較火熱的Android插件化、熱更新等都涉及到了Gradle插件的知識铸董，熟練的掌握Gradle祟印，可以讓我們更加清楚的了解Android的構(gòu)建過程，改造構(gòu)建過程以達(dá)到某些功能需求粟害。從這個(gè)角度來說蕴忆，Android開發(fā)是需要掌握Gradle這項(xiàng)技能的。
二悲幅、Android Plugin源碼獲取
在Android項(xiàng)目的build.gradle中套鹅，有這樣的一行代碼：
apply plugin: 'com.android.application'
想必大家對這行代碼都相當(dāng)?shù)氖煜ぐ伞Ｋ磉_(dá)的意思是將名為com.android.application的插件運(yùn)用到我們的項(xiàng)目中汰具，這個(gè)插件就是大名鼎鼎的Android Plugin卓鹿。
那么Android Plugin是怎么進(jìn)入到我們的工程中的呢？
在項(xiàng)目的根目錄下的build.gradle中找到 classpath 對gradle插件的引用留荔，如上圖减牺。Android Plugin就包含在上述的 gradle 插件中。
我們將上面的gradle插件復(fù)制到項(xiàng)目的build.gradle中（注意：這里是項(xiàng)目的build.gradle存谎，和上面的build.gradle不一樣０尉巍）。
同步（sync）一下項(xiàng)目既荚，就可以在項(xiàng)目的依賴樹中找到Android Plugin源碼稚失。
三、Android Plugin源碼解析
展開上面的com.android.tools.build:gradle:3.1.0@jar恰聘，可以看到AppPlugin和LibraryPlugin句各，其中AppPlugin就是Android項(xiàng)目需要依賴的插件，而LibraryPlugin是組件項(xiàng)目需要依賴的插件晴叨。
下面我們就解析一下AppPlugin的源碼凿宾，并從中了解App構(gòu)建過程。Let's do it~
首先AppPlugin繼承了BasePlugin兼蕊，BasePlugin實(shí)現(xiàn)了Plugin接口初厚，并實(shí)現(xiàn)了其中的apply方法。apply方法作為BasePlugin的入口類孙技，其實(shí)現(xiàn)如下：
@Override
public void apply(@NonNull Project project) {
//初始化項(xiàng)产禾，省略
//構(gòu)造線程記錄器，用于記錄執(zhí)行時(shí)間
threadRecorder = ThreadRecorder.get();
ProcessProfileWriter.getProject(project.getPath())
.setAndroidPluginVersion(Version.ANDROID_GRADLE_PLUGIN_VERSION)
.setAndroidPlugin(getAnalyticsPluginType())
.setPluginGeneration(GradleBuildProject.PluginGeneration.FIRST)
.setOptions(AnalyticsUtil.toProto(projectOptions));
BuildableArtifactImpl.Companion.disableResolution();
if (!projectOptions.get(BooleanOption.ENABLE_NEW_DSL_AND_API)) {
//不使用新的DSL API
TaskInputHelper.enableBypass();
// configureProject 配置項(xiàng)目
threadRecorder.record(
ExecutionType.BASE_PLUGIN_PROJECT_CONFIGURE,
project.getPath(),
null,
this::configureProject);
// configureExtension 配置 Extension牵啦，之后我們才能使用 android {} 進(jìn)行配置
threadRecorder.record(
ExecutionType.BASE_PLUGIN_PROJECT_BASE_EXTENSION_CREATION,
project.getPath(),
null,
this::configureExtension);
// createTasks 創(chuàng)建必須的 task
threadRecorder.record(
ExecutionType.BASE_PLUGIN_PROJECT_TASKS_CREATION,
project.getPath(),
null,
this::createTasks);
} else {
//省略
}
}
上面的apply方法最重要的是調(diào)用了三次ThreadRecorder的record方法亚情。注意：this::configureProject是java8 的lambda寫法，所以接下來我們看一下record方法的實(shí)現(xiàn)：
@Override
public void record(
@NonNull ExecutionType executionType,
@NonNull String projectPath,
@Nullable String variant,
@NonNull VoidBlock block) {
ProfileRecordWriter profileRecordWriter = ProcessProfileWriter.get();
//創(chuàng)建GradleBuildProfileSpan.Builder對象
GradleBuildProfileSpan.Builder currentRecord =
create(profileRecordWriter, executionType, null);
try {
//回調(diào)方法
block.call();
} catch (IOException e) {
throw new UncheckedIOException(e);
} finally {
//將上面創(chuàng)建的GradleBuildProfileSpan對象寫入到ProfileRecordWriter對象的span（隊(duì)列）變量中
write(profileRecordWriter, currentRecord, projectPath, variant);
}
}
record方法主要完成了三個(gè)邏輯：
1哈雏、創(chuàng)建了創(chuàng)建GradleBuildProfileSpan.Builder對象楞件；
2衫生、執(zhí)行回調(diào)方法；
3土浸、最后將GradleBuildProfileSpan對象寫入到ProfileRecordWriter對象的span（隊(duì)列）變量中罪针。
首先我們看1的邏輯，調(diào)用了create方法創(chuàng)建了GradleBuildProfileSpan.Builder對象：
private GradleBuildProfileSpan.Builder create(
@NonNull ProfileRecordWriter profileRecordWriter,
@NonNull ExecutionType executionType,
@Nullable GradleTransformExecution transform) {
long thisRecordId = profileRecordWriter.allocateRecordId();
// am I a child ?
@Nullable
Long parentId = recordStacks.get().peek();
long startTimeInMs = System.currentTimeMillis();
final GradleBuildProfileSpan.Builder currentRecord =
GradleBuildProfileSpan.newBuilder()
.setId(thisRecordId)
.setType(executionType)
.setStartTimeInMs(startTimeInMs);
if (transform != null) {
currentRecord.setTransform(transform);
}
if (parentId != null) {
currentRecord.setParentId(parentId);
}
currentRecord.setThreadId(threadId.get());
recordStacks.get().push(thisRecordId);
return currentRecord;
}
create方法的邏輯就是創(chuàng)建了一個(gè)GradleBuildProfileSpan.Builder對象栅迄，并且將一些線程相關(guān)的變量設(shè)置進(jìn)去，并將thisRecordId保存到一個(gè)雙向隊(duì)列中皆怕。
然后再看3的邏輯：
private void write(
@NonNull ProfileRecordWriter profileRecordWriter,
@NonNull GradleBuildProfileSpan.Builder currentRecord,
@NonNull String projectPath,
@Nullable String variant) {
// pop this record from the stack.
if (recordStacks.get().pop() != currentRecord.getId()) {
Logger.getLogger(ThreadRecorder.class.getName())
.log(Level.SEVERE, "Profiler stack corrupted");
}
currentRecord.setDurationInMs(
System.currentTimeMillis() - currentRecord.getStartTimeInMs());
profileRecordWriter.writeRecord(projectPath, variant, currentRecord);
}
其中執(zhí)行了ProfileRecordWriter對象的writeRecord方法：
@Override
public void writeRecord(
@NonNull String project,
@Nullable String variant,
@NonNull final GradleBuildProfileSpan.Builder executionRecord) {
executionRecord.setProject(mNameAnonymizer.anonymizeProjectPath(project));
executionRecord.setVariant(mNameAnonymizer.anonymizeVariant(project, variant));
spans.add(executionRecord.build());
}
最后運(yùn)用建造者模式生成GradleBuildProfileSpan對象寫入到ProfileRecordWriter對象的span（隊(duì)列）變量中毅舆。
最后我們看2的邏輯，即回調(diào)方法的執(zhí)行愈腾。還記得上面提到過的BasePlugin的apply方法執(zhí)行的三個(gè)record方法嗎憋活？其中每一個(gè)record方法都有自己的回調(diào)方法，即configureProject虱黄、configureExtension悦即、createTasks。
其實(shí)從這三個(gè)方法傳進(jìn)來的第一個(gè)參數(shù)橱乱，我們能大概看出每一個(gè)方法實(shí)現(xiàn)的邏輯：
1辜梳、BASE_PLUGIN_PROJECT_CONFIGURE：插件的基本配置信息、初始化等泳叠。
2作瞄、BASE_PLUGIN_PROJECT_BASE_EXTENSION_CREATION：插件Extension的初始化。
3危纫、BASE_PLUGIN_PROJECT_TASKS_CREATION：插件任務(wù)的創(chuàng)建宗挥。
我們先來看第一個(gè)第一個(gè)方法的實(shí)現(xiàn)邏輯，后面兩個(gè)方法放到后面的兩篇文章來講种蝶。
private void configureProject() {
final Gradle gradle = project.getGradle();
extraModelInfo = new ExtraModelInfo(project.getPath(), projectOptions, project.getLogger());
checkGradleVersion(project, getLogger(), projectOptions);
sdkHandler = new SdkHandler(project, getLogger());
if (!gradle.getStartParameter().isOffline()
&& projectOptions.get(BooleanOption.ENABLE_SDK_DOWNLOAD)) {
SdkLibData sdkLibData = SdkLibData.download(getDownloader(), getSettingsController());
sdkHandler.setSdkLibData(sdkLibData);
}
androidBuilder =
new AndroidBuilder(
project == project.getRootProject() ? project.getName() : project.getPath(),
creator,
new GradleProcessExecutor(project),
new GradleJavaProcessExecutor(project),
extraModelInfo.getSyncIssueHandler(),
extraModelInfo.getMessageReceiver(),
getLogger(),
isVerbose());
dataBindingBuilder = new DataBindingBuilder();
dataBindingBuilder.setPrintMachineReadableOutput(
SyncOptions.getErrorFormatMode(projectOptions) == ErrorFormatMode.MACHINE_PARSABLE);
if (projectOptions.hasRemovedOptions()) {
androidBuilder
.getIssueReporter()
.reportWarning(Type.GENERIC, projectOptions.getRemovedOptionsErrorMessage());
}
if (projectOptions.hasDeprecatedOptions()) {
extraModelInfo
.getDeprecationReporter()
.reportDeprecatedOptions(projectOptions.getDeprecatedOptions());
}
// Apply the Java plugin
project.getPlugins().apply(JavaBasePlugin.class);
project.getTasks()
.getByName("assemble")
.setDescription(
"Assembles all variants of all applications and secondary packages.");
// call back on execution. This is called after the whole build is done (not
// after the current project is done).
// This is will be called for each (android) projects though, so this should support
// being called 2+ times.
gradle.addBuildListener(
new BuildListener() {
@Override
public void buildStarted(@NonNull Gradle gradle) {
TaskInputHelper.enableBypass();
BuildableArtifactImpl.Companion.disableResolution();
}
@Override
public void settingsEvaluated(@NonNull Settings settings) {}
@Override
public void projectsLoaded(@NonNull Gradle gradle) {}
@Override
public void projectsEvaluated(@NonNull Gradle gradle) {}
@Override
public void buildFinished(@NonNull BuildResult buildResult) {
// Do not run buildFinished for included project in composite build.
if (buildResult.getGradle().getParent() != null) {
return;
}
sdkHandler.unload();
threadRecorder.record(
ExecutionType.BASE_PLUGIN_BUILD_FINISHED,
project.getPath(),
null,
() -> {
WorkerActionServiceRegistry.INSTANCE
.shutdownAllRegisteredServices(
ForkJoinPool.commonPool());
PreDexCache.getCache()
.clear(
FileUtils.join(
project.getRootProject().getBuildDir(),
FD_INTERMEDIATES,
"dex-cache",
"cache.xml"),
getLogger());
Main.clearInternTables();
});
}
});
gradle.getTaskGraph()
.addTaskExecutionGraphListener(
taskGraph -> {
TaskInputHelper.disableBypass();
Aapt2DaemonManagerService.registerAaptService(
Objects.requireNonNull(androidBuilder.getTargetInfo())
.getBuildTools(),
loggerWrapper,
WorkerActionServiceRegistry.INSTANCE);
for (Task task : taskGraph.getAllTasks()) {
if (task instanceof TransformTask) {
Transform transform = ((TransformTask) task).getTransform();
if (transform instanceof DexTransform) {
PreDexCache.getCache()
.load(
FileUtils.join(
project.getRootProject()
.getBuildDir(),
FD_INTERMEDIATES,
"dex-cache",
"cache.xml"));
break;
}
}
}
});
createLintClasspathConfiguration(project);
}
configureProject這個(gè)方法代碼有點(diǎn)長契耿，但是其主要執(zhí)行了以下幾個(gè)邏輯：
1、初始化了SdkHandler螃征、AndroidBuilder和DataBindingBuilder對象搪桂。
2、依賴了JavaBasePlugin插件盯滚，在其中創(chuàng)建了很多關(guān)于構(gòu)建的task锅棕，其中build、assemble等task就是在里面創(chuàng)建的淌山。
3裸燎、對項(xiàng)目的創(chuàng)建做了監(jiān)聽，在構(gòu)建結(jié)束后執(zhí)行了磁盤緩存等操作泼疑。
四德绿、總結(jié)
本文主要介紹了如何查看Android Plugin插件源碼，以及對Android Plugin插件的執(zhí)行流程進(jìn)行了簡單的分析，后面會繼續(xù)接著分析插件Extension和插件任務(wù)的創(chuàng)建這兩個(gè)流程移稳。
