【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 主要 Task 分析

最新推荐文章于 2024-06-10 19:39:57 发布

2401_84149733

最新推荐文章于 2024-06-10 19:39:57 发布

阅读量540

点赞数 8

分类专栏：程序员文章标签： android

本文链接：https://blog.csdn.net/2401_84149733/article/details/138932245

版权

程序员专栏收录该内容

274 篇文章 0 订阅

订阅专栏

三、如何去读 Task 的代码

在 gradle plugin 中的 Task 主要有三种，一种是普通的 task，一种是增量 task，一种是 transform，下面分别看下这三种 task 怎么去读。

如何读 Task 的代码

看 Task 继承的父类，一般来说，会继承 DefaultTask，IncrementalTask
看 @TaskAction 注解的方法，此方法就是这个 Task 做的事情

如何读 IncrementalTask

我们先看看下这个类，这个类表示的是增量 Task，什么是增量呢？是相对于全量来说的，全量我们可以理解为调用 clean 以后第一次编译的过程，这个就是全量编译，之后修改了代码或者资源文件，再次编译，就是增量编译。
其中比较重要的几个方法如下：

public abstract class IncrementalTask extends BaseTask {
// …
@Internal
protected boolean isIncremental() {
// 是否需要增量，默认是 false
return false;
}

// 需要子类实现，全量的时候执行的任务
protected abstract void doFullTaskAction() throws Exception;

// 增量的时候执行的任务，默认是什么都不执行，参数是增量的时候修改过的文件
protected void doIncrementalTaskAction(Map<File, FileStatus> changedInputs) throws Exception {
}

@TaskAction
void taskAction(IncrementalTaskInputs inputs) throws Exception {
// 判断是否是增量
if(this.isIncremental() && inputs.isIncremental()) {
this.doIncrementalTaskAction(this.getChangedInputs(inputs));
} else {
this.getProject().getLogger().info(“Unable do incremental execution: full task run”);
this.doFullTaskAction();
}
}

// 获取修改的文件
private Map<File, FileStatus> getChangedInputs(IncrementalTaskInputs inputs) {
Map<File, FileStatus> changedInputs = Maps.newHashMap();
inputs.outOfDate((change) -> {
FileStatus status = change.isAdded()?FileStatus.NEW:FileStatus.CHANGED;
changedInputs.put(change.getFile(), status);
});
inputs.removed((change) -> {
FileStatus var10000 = (FileStatus)changedInputs.put(change.getFile(), FileStatus.REMOVED);
});
return changedInputs;
}
}

简单介绍了 IncrementalTask 之后，我们这里强调一下，如何去读一个增量 Task 的代码，主要有四步：

首先这个 Task 要继承 IncrementalTask，
其次看 isIncremental 方法，如果返回 true，说明支持增量，返回 false 则不支持
然后看 doFullTaskAction 方法，是全量的时候执行的操作
最后看 doIncrementalTaskAction 方法，这里是增量的时候执行的操作

如何读 Transform

继承自 Transform
看其 transform 方法的实现

四、重点 Task 实现分析

上面每个 task 已经简单说明了具体做什么以及对应的实现类，下面选了几个比较重要的来分析一下其实现
为什么分析这几个呢？这几个代表了 gradle 自动生成代码，资源的处理，以及 dex 的处理，算是 apk 打包过程中比较重要的几环。
generateDebugBuildConfig
processDebugManifest
mergeDebugResources
processDebugResources
transformClassesWithDexBuilderForDebug
transformDexArchiveWithExternalLibsDexMergerForDebug
transformDexArchiveWithDexMergerForDebug

分析过程主要下面几个步骤，实现类，整体实现图，调用链路（方便以后回看代码），以及重要代码分析

4.1 generateDebugBuildConfig

4.1.1 实现类

GenerateBuildConfig

4.1.2 整体实现图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

4.1.3 代码调用链路

GenerateBuildConfig.generate -> BuildConfigGenerator.generate -> JavaWriter

4.1.4 主要代码分析

在 GenerateBuildConfig 中，主要生成代码的步骤如下：

生成 BuildConfigGenerator
添加默认的属性，包括 DEBUG，APPLICATION_ID，FLAVOR，VERSION_CODE，VERSION_NAME
添加自定义属性
调用 JavaWriter 生成 BuildConfig.java 文件

// GenerateBuildConfig.generate()
@TaskAction
void generate() throws IOException {
// …
BuildConfigGenerator generator = new BuildConfigGenerator(
getSourceOutputDir(),
getBuildConfigPackageName());
// 添加默认的属性，包括 DEBUG，APPLICATION_ID，FLAVOR，VERSION_CODE，VERSION_NAME
generator
.addField(
“boolean”,
“DEBUG”,
isDebuggable() ? “Boolean.parseBoolean(“true”)” : “false”)
.addField(“String”, “APPLICATION_ID”, ‘"’ + appPackageName.get() + ‘"’)
.addField(“String”, “BUILD_TYPE”, ‘"’ + getBuildTypeName() + ‘"’)
.addField(“String”, “FLAVOR”, ‘"’ + getFlavorName() + ‘"’)
.addField(“int”, “VERSION_CODE”, Integer.toString(getVersionCode()))
.addField(
“String”, “VERSION_NAME”, ‘"’ + Strings.nullToEmpty(getVersionName()) + ‘"’)
.addItems(getItems()); // 添加自定义属性

List flavors = getFlavorNamesWithDimensionNames();
int count = flavors.size();
if (count > 1) {
for (int i = 0; i < count; i += 2) {
generator.addField(
“String”, “FLAVOR_” + flavors.get(i + 1), ‘"’ + flavors.get(i) + ‘"’);
}
}

// 内部调用 JavaWriter 生成 java 文件
generator.generate();
}

4.2 mergeDebugResources

4.2.1 实现类

MergeResources

4.2.2 整体实现图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

4.2.3 调用链路

MergeResources.doFullTaskAction -> ResourceMerger.mergeData -> MergedResourceWriter.end -> QueueableAapt2.compile -> Aapt2QueuedResourceProcessor.compile -> AaptProcess.compile -> AaptV2CommandBuilder.makeCompile

4.2.4 主要代码分析

MergeResources 这个类，继承自 IncrementalTask，按照前面说的阅读增量 Task 代码的步骤，依次看三个方法的实现：isIncremental，doFullTaskAction，doIncrementalTaskAction

isIncremental

// 说明 Task 支持增量
protected boolean isIncremental() {
return true;
}

doFullTaskAction

通过 getConfiguredResourceSets() 获取 resourceSets，包括了自己的 res/ 和依赖库的 res/ 以及 build/generated/res/rs

// MergeResources.doFullTaskAction()
List resourceSets = getConfiguredResourceSets(preprocessor);

创建 ResourceMerger

// MergeResources.doFullTaskAction()
ResourceMerger merger = new ResourceMerger(minSdk);

创建 QueueableResourceCompiler，因为 gradle3.x 以后支持了 aapt2，所以这里有两种选择 aapt 和 aapt2。其中 aapt2 有三种模式，OutOfProcessAaptV2，AaptV2Jni，QueueableAapt2，这里默认创建了 QueueableAapt2，resourceCompiler = QueueableAapt2

// MergeResources.doFullTaskAction()
// makeAapt 中会判断使用 aapt 还是 aapt2，这里以 aapt2 为例，返回的是 QueueableAapt2 对象
QueueableResourceCompiler resourceCompiler =
makeAapt(
aaptGeneration,
getBuilder(),
fileCache,
crunchPng,
variantScope,
getAaptTempDir(),
mergingLog)

将第一步获取的 resourceSet 加入 ResourceMerger 中

for (ResourceSet resourceSet : resourceSets) {
resourceSet.loadFromFiles(getILogger());
merger.addDataSet(resourceSet);
}

创建 MergedResourceWriter
调用 ResourceMerger.mergeData 合并资源

// MergeResources.doFullTaskAction()
merger.mergeData(writer, false /doCleanUp/);

调用 MergedResourceWriter 的 start()，addItem()，end() 方法，伪代码如下：

// DataMerger.mergeData
consumer.start()
for item in sourceSets:
// item 包括了需要处理的资源，包括 xml 和图片资源，每一个 item 对应的文件，会创建一个 CompileResourceRequest 对象，加入到 mCompileResourceRequests 里
consumer.addItem(item)
consumer.end()

调用 QueueableAapt2 -> Aapt2QueuedResourceProcessor -> AaptProcess 处理资源

// MergedResourceWriter.end()
Future result = this.mResourceCompiler.compile(new CompileResourceRequest(fileToCompile, request.getOutput(), request.getFolderName(), this.pseudoLocalesEnabled, this.crunchPng));
// AaptProcess.compile
public void compile(
@NonNull CompileResourceRequest request,
@NonNull Job job,
@Nullable ProcessOutputHandler processOutputHandler)
throws IOException {
// …
// 使用 AaptV2CommandBuilder 生成 aapt2 命令
mWriter.write(joiner.join(AaptV2CommandBuilder.makeCompile(request)));
mWriter.flush(); // 输出命令
}

这一步调用 aapt2 命令去处理资源，处理完以后 xxx.xml.flat 格式

doIncrementalTaskAction
增量任务过程和全量其实差异不大，只不过是在获取 resourceSets 的时候，使用的是修改后的文件

4.3 processDebugResources

4.3.1 实现类

ProcessAndroidResources

4.3.2 整体实现图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

4.3.3 调用链路

ProcessAndroidResources.doFullTaskAction -> ProcessAndroidResources.invokeAaptForSplit -> AndroidBuilder.processResources -> QueueAapt2.link -> Aapt2QueuedResourceProcessor.link -> AaptProcess.link -> AaptV2CommandBuilder.makeLink

4.3.4 主要代码分析

ProcessAndroidResources 也是继承自 IncrementalTask，但是没有重写 isIncremental，所以不是增量的 Task，直接看 doFullTaskAction 即可

doFullTaskAction
这个里面代码虽然多，但是主要的逻辑比较简单，就是调用 aapt2 link 去生成资源包。
这里会处理 splits apk 相关的内容，关于 splits apk 具体可以查看 splits apk，简单来说，就是可以按照屏幕分辨率，abis 来生成不同的 apk，从而让特定用户的安装包变小。
分下面几个步骤：

获取 split 数据

List splitsToGenerate =
getApksToGenerate(outputScope, supportedAbis, buildTargetAbi, buildTargetDensity);

返回的是一个 ApkData 列表，ApkData 有三个子类，分别是 Main，Universal，FullSplit
我们配置如下：

android {
splits {
// Configures multiple APKs based on screen density.
density {
// Configures multiple APKs based on screen density.
enable true
// Specifies a list of screen densities Gradle should not create multiple APKs for.
exclude “ldpi”, “xxhdpi”, “xxxhdpi”
// Specifies a list of compatible screen size settings for the manifest.
compatibleScreens ‘small’, ‘normal’, ‘large’, ‘xlarge’
}
}
}

这里的 ApkData 会返回一个 Universal 和多个 FullSplit，Universal 代表的是主 apk，FullSplit 就是根据屏幕密度拆分的 apk。
如果我们没有配置 splits apk，那么这里只会返回一个 Main 的实例，标识完整的 apk。
2. 先处理 main 和不依赖 density 的 ApkData 资源

// ProcessAndroidResources.doFullTaskAction
List apkDataList = new ArrayList<>(splitsToGenerate);
for (ApkData apkData : splitsToGenerate) {
if (apkData.requiresAapt()) {
// 这里只处理 main 和不依赖 density 的资源
boolean codeGen =
(apkData.getType() == OutputFile.OutputType.MAIN
|| apkData.getFilter(OutputFile.FilterType.DENSITY) == null);
if (codeGen) {
apkDataList.remove(apkData);
invokeAaptForSplit(
manifestsOutputs,
libraryInfoList,
packageIdFileSet,
splitList,
featureResourcePackages,
apkData,
codeGen,
aapt);
break;
}
}
}

调用 invokeAaptForSplit 处理资源

// ProcessAndroidResources.invokeAaptForSplit
void invokeAaptForSplit(…) {
// …
String packageForR = null;
File srcOut = null;
File symbolOutputDir = null;
File proguardOutputFile = null;
File mainDexListProguardOutputFile = null;
// 如果传了 generateCode 参数，会生成 R.java
if (generateCode) {
packageForR = originalApplicationId;

// we have to clean the source folder output in case the package name changed.
srcOut = getSourceOutputDir();
if (srcOut != null) {
FileUtils.cleanOutputDir(srcOut);
}

symbolOutputDir = textSymbolOutputDir.get();
proguardOutputFile = getProguardOutputFile();
mainDexListProguardOutputFile = getMainDexListProguardOutputFile();
}
// …
getBuilder().processResources(aapt, config);
}

调用 AndroidBuilder.processResources -> QueueAapt2.link -> Aapt2QueuedResourceProcessor.link -> AaptProcess.link -> AaptV2CommandBuilder.makeLink 处理资源，生成资源包以及 R.java 文件
处理其他 ApkData 资源，这里只会生成资源包而不会生成 R.java 文件

关于 aapt2 的 compile 和 link 参数，可以在 developer.android.com/studio/comm… 这里看

4.4 processDebugManifest

4.4.1 实现类

MergeManifests

4.4.2 整体实现图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

4.4.3 调用链路

MergeManifests.dofFullTaskAction -> AndroidBuilder.mergeManifestsForApplication -> Invoker.merge -> ManifestMerge2.merge

4.4.4 主要代码分析

MergeManifests 也是继承了 IncrementalTask，但是没有实现 isIncremental，所以只看其 doFullTaskAction 即可。
这个 task 功能主要是合并 mainfest，包括 module 和 flavor 里的，整个过程通过 MergingReport，ManifestMerger2 和 XmlDocument 进行。
这里直接看 ManifestMerger2.merge() 的 merge 过程。主要有几个步骤：

获取依赖库的 manifest 信息，用 LoadedManifestInfo 标识
获取主 module 的 manifest 信息
替换主 module 的 Manifest 中定义的某些属性，替换成 gradle 中定义的属性例如: package, version_code, version_name, min_sdk_versin 等等

performSystemPropertiesInjection(mergingReportBuilder, xmlDocumentOptional.get());
// ManifestMerger2.performSystemPropertiesInjection
protected void performSystemPropertiesInjection(
@NonNull MergingReport.Builder mergingReport,
@NonNull XmlDocument xmlDocument) {
for (ManifestSystemProperty manifestSystemProperty : ManifestSystemProperty.values()) {
String propertyOverride = mSystemPropertyResolver.getValue(manifestSystemProperty);
if (propertyOverride != null) {
manifestSystemProperty.addTo(
mergingReport.getActionRecorder(), xmlDocument, propertyOverride);
}
}
}

合并 flavor，buildType 中的 manifest

for (File inputFile : mFlavorsAndBuildTypeFiles) {
LoadedManifestInfo overlayDocument = load(
new ManifestInfo(null, inputFile, XmlDocument.Type.OVERLAY,
Optional.of(mainPackageAttribute.get().getValue())),
selectors,
mergingReportBuilder);

// 检查 package 定义
Optional packageAttribute =
overlayDocument.getXmlDocument().getPackage();
if (loadedMainManifestInfo.getOriginalPackageName().isPresent() &&
packageAttribute.isPresent()
&& !loadedMainManifestInfo.getOriginalPackageName().get().equals(
packageAttribute.get().getValue())) {
// 如果 package 定义重复的话，会输出下面信息，我们平时应该或多或少见过类似的错误
String message = mMergeType == MergeType.APPLICATION
? String.format(
“Overlay manifest:package attribute declared at %1 $s v a l u e = ($ s)\n”

"\thas a different value=(%3$s) "
“declared in main manifest at %4$s\n”
"\tSuggestion: remove the overlay declaration at %5$s "
“\tand place it in the build.gradle:\n”
“\t\tflavorName {\n”
“\t\t\tapplicationId = “%2$s”\n”
“\t\t}”,
packageAttribute.get().printPosition(),
packageAttribute.get().getValue(),
mainPackageAttribute.get().getValue(),
mainPackageAttribute.get().printPosition(),
packageAttribute.get().getSourceFile().print(true))
: String.format(
“Overlay manifest:package attribute declared at %1 $s v a l u e = ($ s)\n”
"\thas a different value=(%3$s) "
“declared in main manifest at %4$s”,
packageAttribute.get().printPosition(),
packageAttribute.get().getValue(),
mainPackageAttribute.get().getValue(),
mainPackageAttribute.get().printPosition());
// …
return mergingReportBuilder.build();
}
}

合并依赖库的 manifest

for (LoadedManifestInfo libraryDocument : loadedLibraryDocuments) {
mLogger.verbose("Merging library manifest " + libraryDocument.getLocation());
xmlDocumentOptional = merge(
xmlDocumentOptional, libraryDocument, mergingReportBuilder);
if (!xmlDocumentOptional.isPresent()) {
return mergingReportBuilder.build();
}
}

处理 manifest 的 placeholders

performPlaceHolderSubstitution(loadedMainManifestInfo, xmlDocumentOptional.get(), mergingReportBuilder, severity);

之后对最终合并后的 manifest 中的一些属性重新进行一次替换，类似步骤 4
保存 manifest 到 build/intermediates/manifest/fullxxx/AndroidManifest.xml 这就生成了最终的 Manifest 文件

4.5 transformClassesWithDexBuilderForDebug

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

[外链图片转存中…(img-YCVqeVBL-1715796546155)]

[外链图片转存中…(img-v9cJ4xas-1715796546156)]

[外链图片转存中…(img-2KUirIal-1715796546157)]

[外链图片转存中…(img-br0IeCXk-1715796546158)]

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

2401_84149733

关注

8
点赞
踩
19

收藏

觉得还不错? 一键收藏
0
评论
【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 主要 Task 分析

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！
复制链接

扫一扫