Skip to content

Commit 8563f50

Browse files
author
chengsimin
committed
add gradle task
1 parent a537674 commit 8563f50

57 files changed

Lines changed: 2635 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_posts/.DS_Store‎

4 KB
Binary file not shown.

‎_posts/gradle/android_gradle_plugin-主要task分析.md‎

Lines changed: 666 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 294 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,294 @@
1+
### 【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 插件主要流程
2+
### 预备知识
3+
1. 理解 gradle 的基本开发
4+
2. 了解 gradle task 和 plugin 使用及开发
5+
3. 了解 android gradle plugin 的使用
6+
7+
### 看完本文可以达到什么程度
8+
1. 了解 android gradle plugin 的构建流程
9+
2. 了解 android gradle plugin 的主要 task 的实现
10+
3. 学会 hook android 构建流程,添加自己想要的功能
11+
12+
### 阅读前准备工作
13+
1. 项目添加 android gradle plugin 依赖
14+
``` groovy
15+
compile 'com.android.tools.build:gradle:3.0.1'
16+
```
17+
通过这种方式,可以直接依赖 plugin 的源码,读起来比较方便。
18+
2. 官方对照源码地址 [android gradle plugin 源码地址](https://android.googlesource.com/platform/tools/base/+/refs/tags/gradle_3.0.0/build-system/)
19+
20+
大家可以直接 clone [EasyGradle](https://github.com/5A59/android-training/tree/master/gradle/EasyGradle) 项目,把 android-gradle-plugin-source/build.gradle 里的 implementation 'com.android.tools.build:gradle:3.0.1' 注释打开就可以了。
21+
22+
com.android.application 主要有下面几个流程:
23+
![plugin流程](images/android-gradle-plugin/plugin-all.png)
24+
25+
### 一、插件启动的准备工作
26+
![plugin1](images/android-gradle-plugin/plugin1.png)
27+
28+
在前面讲解自定义插件的时候说到过,要定义一个 xxx.properties 文件,里面声明插件的入口类,而 xxx 就是 apply plugin 时候使用的 id,这里要知道 android gradle plugin 的入口类,看 com.android.application.properties 文件就可以,内容如下:
29+
```
30+
implementation-class=com.android.build.gradle.AppPlugin
31+
```
32+
这里定义了入口是 AppPlugin,AppPlugin 继承自 BasePlugin。
33+
AppPlugin 里没有做太多的操作,主要是重写了 createTaskManager 和 createExtension,剩下的大部分工作还是在 BasePlugin 里做的。
34+
插件准备工作中主要做的事情:
35+
1. 检查插件版本
36+
``` groovy
37+
// method: BasePlugin.apply()
38+
checkPluginVersion();
39+
```
40+
2. 检查 module 是否重名
41+
``` groovy
42+
// method: BasePlugin.apply()
43+
// 方法中会遍历所有子项目,判断是否有重复的 id
44+
this.checkModulesForErrors();
45+
```
46+
3. 初始化插件信息
47+
``` groovy
48+
// method: BasePlugin.apply()
49+
PluginInitializer.initialize(project, this.projectOptions);
50+
// 创建 Profiler 文件
51+
ProfilerInitializer.init(project, this.projectOptions);
52+
// profiler 信息中写入 plugin 版本
53+
ProcessProfileWriter.getProject(project.getPath()).setAndroidPluginVersion(Version.ANDROID_GRADLE_PLUGIN_VERSION).setAndroidPlugin(this.getAnalyticsPluginType()).setPluginGeneration(PluginGeneration.FIRST);
54+
```
55+
56+
### 二、配置项目
57+
![plugin2](images/android-gradle-plugin/plugin2.png)
58+
59+
配置项目这一阶段主要做的事情:
60+
1. 检查 gradle 版本是否匹配
61+
``` groovy
62+
// method: BasePlugin.configureProject()
63+
this.checkGradleVersion();
64+
```
65+
2. 创建 AndroidBuilder和 DataBindingBuilder
66+
3. 引入 java plugin 和 jacoco plugin
67+
``` groovy
68+
this.project.getPlugins().apply(JavaBasePlugin.class);
69+
this.project.getPlugins().apply(JacocoPlugin.class);
70+
```
71+
4. 设置构建完成以后的混存清理工作
72+
添加了 BuildListener,在 buildFinished 回调里做缓存清理工作
73+
74+
### 三、配置 Extension
75+
![plugin3](images/android-gradle-plugin/plugin3.png)
76+
77+
实现在 BasePlugin.configureExtension()
78+
这一阶段主要做了下面几个事情:
79+
80+
1. 创建 AppExtension,也就是 build.gradle 里用到的 android {} dsl
81+
``` groovy
82+
this.extension = this.createExtension(...);
83+
84+
// AppPlugin 中实现了 createExtension,创建了 android {} dsl
85+
protected BaseExtension createExtension(...) {
86+
return (BaseExtension)project.getExtensions().create("android", AppExtension.class, new Object[]{project, projectOptions, instantiator, androidBuilder, sdkHandler, buildTypeContainer, productFlavorContainer, signingConfigContainer, buildOutputs, extraModelInfo});
87+
}
88+
```
89+
2. 创建依赖管理,ndk管理,任务管理,variant管理
90+
3. 注册新增配置的回调函数,包括 signingConfig,buildType,productFlavor
91+
```groovy
92+
// BasePlugin.java createExtension()
93+
// map the whenObjectAdded callbacks on the containers.
94+
signingConfigContainer.whenObjectAdded(variantManager::addSigningConfig);
95+
buildTypeContainer.whenObjectAdded(
96+
buildType -> {
97+
SigningConfig signingConfig =
98+
signingConfigContainer.findByName(BuilderConstants.DEBUG);
99+
buildType.init(signingConfig);
100+
// addBuildType,会检查命名是否合法,然后创建 BuildTypeData
101+
variantManager.addBuildType(buildType);
102+
});
103+
// addProductFlavor 会检查命名是否合法,然后创建 ProductFlavorData
104+
productFlavorContainer.whenObjectAdded(variantManager::addProductFlavor);
105+
// VariantManager.java
106+
// addSigningConfig 就是在 signingConfigs 里新增一个配置
107+
public void addSigningConfig(SigningConfig signingConfig) {
108+
this.signingConfigs.put(signingConfig.getName(), signingConfig);
109+
}
110+
// VariantManager.java
111+
public void addProductFlavor(CoreProductFlavor productFlavor) {
112+
String name = productFlavor.getName();
113+
// checkName 会检查
114+
checkName(name, "ProductFlavor");
115+
if(this.buildTypes.containsKey(name)) {
116+
throw new RuntimeException("ProductFlavor names cannot collide with BuildType names");
117+
} else {
118+
// 获取源码位置
119+
DefaultAndroidSourceSet mainSourceSet = (DefaultAndroidSourceSet)this.extension.getSourceSets().maybeCreate(productFlavor.getName());
120+
DefaultAndroidSourceSet androidTestSourceSet = null;
121+
DefaultAndroidSourceSet unitTestSourceSet = null;
122+
if(this.variantFactory.hasTestScope()) {
123+
// 获取单测源码位置
124+
androidTestSourceSet = (DefaultAndroidSourceSet)this.extension.getSourceSets().maybeCreate(computeSourceSetName(productFlavor.getName(), VariantType.ANDROID_TEST));
125+
unitTestSourceSet = (DefaultAndroidSourceSet)this.extension.getSourceSets().maybeCreate(computeSourceSetName(productFlavor.getName(), VariantType.UNIT_TEST));
126+
}
127+
128+
// 创建 productFlavorData 对象
129+
ProductFlavorData<CoreProductFlavor> productFlavorData = new ProductFlavorData(productFlavor, mainSourceSet, androidTestSourceSet, unitTestSourceSet, this.project);
130+
this.productFlavors.put(productFlavor.getName(), productFlavorData);
131+
}
132+
}
133+
```
134+
4. 创建默认的 debug 签名,创建 debug 和 release 两个 buildType
135+
``` groovy
136+
variantFactory.createDefaultComponents(
137+
buildTypeContainer, productFlavorContainer, signingConfigContainer);
138+
// ApplicationVariantFactory.java
139+
public void createDefaultComponents(...) {
140+
signingConfigs.create("debug");
141+
buildTypes.create("debug");
142+
buildTypes.create("release");
143+
}
144+
```
145+
146+
### 四、创建不依赖 flavor 的 task
147+
![plugin4](images/android-gradle-plugin/plugin4.png)
148+
上述准备,配置阶段完成以后,就开始创建构建需要的 Task 了,是在 BasePlugin.createTasks() 里实现的,主要有两步,创建**不依赖 flavor 的 task** 和创建**构建 task**。
149+
先看不依赖 flavor 的 task,其实现在 TaskManager.createTasksBeforeEvaluate()。
150+
这里主要创建了几个 task,包括 uninstallAll,deviceCheck,connectedCheck,preBuild,extractProguardFiles,sourceSets,assembleAndroidTest,compileLint,lint,lintChecks,cleanBuildCacheresolveConfigAttr,consumeConfigAttr。
151+
这些 task 都是不需要依赖 flavor 数据的公共 task。
152+
153+
### 五、创建构建 task
154+
![plugin5](images/android-gradle-plugin/plugin5.png)
155+
156+
在介绍下面的流程之前,先明确几个概念,flavor,dimension,variant。
157+
在 android gradle plugin 3.x 之后,每个 flavor 必须对应一个 dimension,可以理解为 flavor 的分组,然后不同 dimension 里的 flavor 组合成一个 variant。
158+
举个例子:
159+
```
160+
flavorDimensions "size", "color"
161+
162+
productFlavors {
163+
big {
164+
dimension "size"
165+
}
166+
small {
167+
dimension "size"
168+
}
169+
blue {
170+
dimension "color"
171+
}
172+
red {
173+
dimension "color"
174+
}
175+
}
176+
```
177+
上面配置对应生成的 variant 就是 bigBlue,bigRed,smallBlue,smallRed,在这个基础上,再加上 buildTypes,就是 bigBlueDebug,bigRedDebug,smallBlueDebug,smallRedDebug,bigBlueRelease,bigRedRelease,smallBlueRelease,smallRedRelease。
178+
179+
createAndroidTasks 的调用时机和上面不一样,是在 project.afterEvaluate 里调用的,还记得之前文章里说道的 afterEvaluate 回调么?这个时候所有模块配置已经完成了。所以在这个阶段可以获取到对应的 flavor 以及其他配置了。
180+
在 BasePlugin.createAndroidTasks 里,是调用 VariantManager.createAndroidTasks 完成工作的。
181+
创建 task 的时候,会先通过 populateVariantDataList 生成 flavor 相关的数据结构,然后调用 createTasksForVariantData 创建 flavor 对应的 task。
182+
分别看下这两个方法做的事情
183+
**1.populateVariantDataList**
184+
在方法里,会先根据 flavor 和 dimension 创建对应的组合,存放在 flavorComboList 里,之后调用 createVariantDataForProductFlavors 创建对应的 VariantData。
185+
其中重要的几个方法:
186+
``` groovy
187+
// 创建 flavor 和 dimension 的组合
188+
List<ProductFlavorCombo<CoreProductFlavor>> flavorComboList =
189+
ProductFlavorCombo.createCombinations(
190+
flavorDimensionList,
191+
flavorDsl);
192+
// 为每个组合创建 VariantData
193+
for (ProductFlavorCombo<CoreProductFlavor> flavorCombo : flavorComboList) {
194+
//noinspection unchecked
195+
createVariantDataForProductFlavors(
196+
(List<ProductFlavor>) (List) flavorCombo.getFlavorList());
197+
}
198+
```
199+
创建出来的 VariantData 都是 BaseVariantData 的子类,里面保存了一些 Task,可以看一下 BaseVariantData 里的一些重要的结构,对 BaseVariantData 有个大概的了解。
200+
``` groovy
201+
public abstract class BaseVariantData implements TaskContainer {
202+
private final GradleVariantConfiguration variantConfiguration;
203+
private VariantDependencies variantDependency;
204+
private final VariantScope scope;
205+
public Task preBuildTask;
206+
public Task sourceGenTask;
207+
public Task resourceGenTask; // 资源处理
208+
public Task assetGenTask;
209+
public CheckManifest checkManifestTask; // 检测manifest
210+
public AndroidTask<PackageSplitRes> packageSplitResourcesTask; // 打包资源
211+
public AndroidTask<PackageSplitAbi> packageSplitAbiTask;
212+
public RenderscriptCompile renderscriptCompileTask;
213+
public MergeResources mergeResourcesTask; // 合并资源
214+
public ManifestProcessorTask processManifest; // 处理 manifest
215+
public MergeSourceSetFolders mergeAssetsTask; // 合并 assets
216+
public GenerateBuildConfig generateBuildConfigTask; // 生成 BuildConfig
217+
public GenerateResValues generateResValuesTask;
218+
public Sync processJavaResourcesTask;
219+
public NdkCompile ndkCompileTask; // ndk 编译
220+
public JavaCompile javacTask;
221+
public Task compileTask;
222+
public Task javaCompilerTask; // java 文件编译
223+
// ...
224+
}
225+
```
226+
VariantData 里保存了很多 task,下一步就要创建这些 task。
227+
228+
**2.createTasksForVariantData**
229+
创建完 variant 数据,就要给 每个 variantData 创建对应的 task,对应的 task 有 assembleXXXTask,prebuildXXX,generateXXXSource,generateXXXResources,generateXXXAssets,processXXXManifest 等等,重点关注几个方法:
230+
``` groovy
231+
VariantManager.createAssembleTaskForVariantData() // 创建 assembleXXXTask
232+
TaskManager.createTasksForVariantScope() // 是一个抽象类,具体实现在 ApplicationTaskManager.createTasksForVariantScope()
233+
TaskManager.createPostCompilationTasks() // 创建 .class to dex 的 task, 创建 transformTask,我们创建的 transform 就是这个阶段添加进来的,是在 addCompileTask 里调用的
234+
235+
// createTasksForVariantScope 是一个抽象方法,具体实现在子类中,可以看一下 ApplicationTaskManager.createTasksForVariantScope()
236+
// createTasksForVariantScope 里的实现,如果在业务中有需要查看相关 task 源码时,可以来这里找
237+
void createTasksForVariantScope() {
238+
this.createCheckManifestTask(tasks, variantScope); // 检测 manifest
239+
this.handleMicroApp(tasks, variantScope);
240+
this.createDependencyStreams(tasks, variantScope);
241+
this.createApplicationIdWriterTask(tasks, variantScope); // application id
242+
this.createMergeApkManifestsTask(tasks, variantScope); // 合并 manifest
243+
this.createGenerateResValuesTask(tasks, variantScope);
244+
this.createRenderscriptTask(tasks, variantScope);
245+
this.createMergeResourcesTask(tasks, variantScope, true); // 合并资源文件
246+
this.createMergeAssetsTask(tasks, variantScope, (BiConsumer)null); // 合并 assets
247+
this.createBuildConfigTask(tasks, variantScope); // 生成 BuildConfig
248+
this.createApkProcessResTask(tasks, variantScope); // 处理资源
249+
this.createProcessJavaResTask(tasks, variantScope);
250+
this.createAidlTask(tasks, variantScope); // 处理 aidl
251+
this.createShaderTask(tasks, variantScope);
252+
this.createNdkTasks(tasks, variantScope); // 处理 ndk
253+
this.createExternalNativeBuildJsonGenerators(variantScope);
254+
this.createExternalNativeBuildTasks(tasks, variantScope);
255+
this.createMergeJniLibFoldersTasks(tasks, variantScope); // 合并 jni
256+
this.createDataBindingTasksIfNecessary(tasks, variantScope); // 处理 databinding
257+
this.addCompileTask(tasks, variantScope);
258+
createStripNativeLibraryTask(tasks, variantScope);
259+
this.createSplitTasks(tasks, variantScope);
260+
this.createPackagingTask(tasks, variantScope, buildInfoWriterTask); // 打包 apk
261+
this.createLintTasks(tasks, variantScope); // lint
262+
}
263+
264+
// createPostCompilationTasks 实现:
265+
// 处理 Android Transform
266+
void createPostCompilationTasks() {
267+
for (int i = 0, count = customTransforms.size(); i < count; i++) {
268+
Transform transform = customTransforms.get(i);
269+
// TransformManager.addTransform 实际上是为 transform 创建了一个 Task
270+
transformManager
271+
.addTransform(tasks, variantScope, transform)
272+
.ifPresent(t -> {
273+
if (!deps.isEmpty()) {
274+
t.dependsOn(tasks, deps);
275+
}
276+
// if the task is a no-op then we make assemble task depend on it.
277+
if (transform.getScopes().isEmpty()) {
278+
variantScope.getAssembleTask().dependsOn(tasks, t);
279+
}
280+
});
281+
}
282+
}
283+
```
284+
285+
### 六、总结
286+
android gradle plugin 的主要流程基本上就结束了,主要流程图如下所示
287+
![pluign-summary](images/android-gradle-plugin/plugin-summary.png)
288+
289+
这里总结几个要点:
290+
1. com.android.application 入口类是 AppPlugin,但大部分工作都是在 BasePlugin 里完成的
291+
2. build.gradle 里见到的 android {} dsl 是在 BasePlugin.configureExtension() 里声明的
292+
3. 主要的 task 是在 BasePlugin.createAndroidTasks() 里生成的
293+
4. 主要 task 的实现可以在 TaskManager 中找到
294+
5. transform 会转化成 TransformTask
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(好文,笔记都是精髓)[https://github.com/JeremyLiao/android-gradle-study]
2+
3+
4+
int f(int i,int m){
5+
if(a[i][m]==1){
6+
return 0;
7+
}
8+
int num = 0;
9+
if(a[1][m-1]==0){
10+
num += f(1,m-1)
11+
}
12+
if(a[0][m-1]==0){
13+
num += f(0,m-1)
14+
}
15+
return num;
16+
}

‎_posts/gradle/gradle-summary.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
### 看完这一系列,彻底搞懂 Gradle
2+
前面写了几篇关于 Gradle 的文章,这篇文章算是这一系列的结束和总结。
3+
4+
### Gradle 系列文章
5+
[【Android 修炼手册】Gradle 篇 -- Gradle 的基本使用](./gralde的基本使用.md)
6+
[【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 插件主要流程](./android_gradle_plugin-主要流程分析.md)
7+
[【Android 修炼手册】Gradle 篇 -- Android Gradle Plugin 主要 Task 分析](./android_gradle_plugin-主要task分析.md)
8+
[【Android 修炼手册】Gradle 篇 -- Gradle 源码分析](./gradle源码分析.md)
9+
[动画讲解 Gradle 原理](https://www.bilibili.com/video/av55941638/)
10+
11+
### 关于 Gradle
12+
相对于 Android 开发者来说,包括最开始的我,可能对 Gradle 的认识,就是一个打包工具而已,平时主要在做 app 的开发,对于 Gradle 的投入并不是很多。但真正深入了解以后,会发现 Gradle 能做的事情很多。而对 Android Gradle Plugin 的学习,也会加深对 Android 的理解,其实有时候 Android 开发,并不只是做一款 App 而已。像我在最开始写一些小工具的时候,基本上都是用 python,后来学习了 Gradle 以后,可能会觉得 Gradle 用起来更顺手,更方便。学好 Gradle 对于后面进阶好处是大大大大大的。
13+
14+
### 一些尝试
15+
之前写的文章逻辑,是按照从**使用到深入实现原理**来的,应该也符合一般的认知,也希望这一系列的文章,能帮助到一些想要学习 Gradle 的朋友。
16+
其实在写文章的同时,也做了一些尝试,想通过更简洁明了的方式,把一些原理解释的更加清楚易懂,所以在文字过程中加了不少示意图,但是回过头来再去看,可能并没有我开始达到想要的效果。因为其中一些原理和实现,用示意图的方式来讲解,还是有些吃力。
17+
这几天有了一个想法,想通过动画的形式来讲解源码。所以尝试做了一个 **Gradle 原理**的动画讲解。点击下面连接观看动画视频。(PS:整个视频没有声音,上班时间也可放心观看~)第一次做这类的动画,可能效果不是很好,如果有建议或意见,欢迎留言反馈~
18+
[动画讲解 Gradle 原理](https://www.bilibili.com/video/av55941638/)
19+
20+
### 欢迎关注下面账号,获取更新
21+
[微信搜索公众号: ZYLAB](./images/ZYLAB.jpg)
22+
[Github](https://github.com/5A59)
23+
[知乎](https://www.zhihu.com/people/5a59/activities)
24+
[掘金](https://juejin.im/user/58d9d015ac502e0058df1f96)
25+
[简书](https://www.jianshu.com/u/4cf10cf65326)

0 commit comments

Comments
 (0)