- 为什么需要自动化构建工具?
- 默认创建的 Android 工程都有什么
- 依赖管理
- 打包流程
通过阅读本文,可以大致了解 Gradle 是如何工作,可以有针对性搜索相关内容,更加快速的解决常见编译错误
为什么需要自动化构建工具?
以下命令只是示例,方便说明问题,具体使用方式请查找相关命令手册用法
我们知道,一个 APK 包其实是一个 zip 包,包含代码和资源。那么我们可以编写一个Shell 脚本,命名为 assemble.sh,任何人只要通过执行这个脚本就可以得到 apk 包,完美:
- 将 .java 文件转换为 .class 文件,执行命令: javac xxx.java
- Android 还会将 .class 文件转换为 .dex 文件: dx xxx.class
- 打包成 apk: zip xxx.apk [需要打包的代码和资源]
在 Android 中代码对资源是通过 R.java 文件引用,于是需要继续添加命令,并要求这个命令在 javac 命令前执行。在实际开发中我们不可能所有功能都自己实现,有可能会依赖优秀的开源库,修改后的伪代码如下:
- 生成 R.java: aapt [资源文件]
- 将 .java 文件转换为 .class 文件,执行命令: javac xxx.java R.java -classpath xxx.jar
- Android 还会将 .class 文件转换为 .dex 文件: dx xxx.class R.class xxx.jar
- 打包成 apk: zip xxx.apk [需要打包的代码和资源]
一切似乎都尽在掌握之中,真的吗?让我们看看 Android APK 实际打包的流程是什么样的:
想想实现如此复杂流程的 Shell 脚本是不是有些头大?别急,实现后还会遇到下面这些问题:
- 对于多个工程,每个工程都需要拷贝上述 Shell 脚本
- 对于单个工程,每次添加一个功能都需要在原有流程中插入一段代码,随着需求增加,脚本难以维护
- 如何管理引入的外部依赖?如何打 debug、release 包?如何打多渠道包?
此时我们需要一个简化上述过程的工具,通过一些约定,如将代码、资源等放在指定目录,再辅以构建脚本就可以快速得到最终的构建产物,这就是自动化构建工具,而 Gradle 就是其中一个。
对照刚刚那个简单的例子,每一个工程在 Gradle 中叫做一个 Project,每一个需要执行的任务,如生成 R 文件、编译 java 文件等,在 Gradle 中叫做一个 Task。通过 TaskA.dependsOn(TaskB)可以实现先执行 TaskB 再执行 TaskA 的效果。同时 Gradle 也提供 doFirst、doLast 允许在每个 Task 前和后执行一些代码。
至此,我们知道为什么需要自动化构建工具:
- 防止手动介入构建
- 创建可重复的构建
- 以及最重要的:提升编程效率,将精力集中在需求开发上
默认创建的 Android 工程都有什么
每当通过 Android Studio 新建一个工程时,AS 都会自动创建如上图所示的目录结构,图片中简单介绍了各个目录是干什么的,接下来为大家详细介绍每一个目录或者文件的含义:
.gradle 与 .idea
.gradle 与 .idea 存放 Gradle 和 AS 对于当前工程的缓存。
最常见的一个应用就是点击 sync 后,AS 会在每个工程下生成 .iml 文件,他们与 .gradle、.idea 配合为我们提供了代码提示等常见功能。所以如果你的代码飘红而你确认依赖没有问题,可以尝试下面步骤清除 AS 缓存:
- 删.idea 删.gradle 文件
- 命令行执行 ./gradlew clean
- 选择 File -> invalidate caches/restart
- Sync
gradle/wrapper 与 gradlew gradlew.bat
当我们初次配置 Android 环境时,需要安装 Java,安装 AS,但并不需要安装 Gradle,这其中就是 gradle/wrapper 的功劳。
当执行 gradlew 脚本时,它可以保证每个项目都使用自己期望的 Gradle 版本,而其中的奥秘就在 gradlew 的这段代码中
exec “ J A V A C M D " " JAVACMD" " JAVACMD""{JVM_OPTS[@]}” -classpath “ C L A S S P A T H " o r g . g r a d l e . w r a p p e r . G r a d l e W r a p p e r M a i n " CLASSPATH" org.gradle.wrapper.GradleWrapperMain " CLASSPATH"org.gradle.wrapper.GradleWrapperMain"@”
gradlew 并没有直接启动 Gradle 而是启动 gradle-wrapper.jar,它会判断如果没有 Gradle 环境,从 gradle-wrapper.properties 中的 distributionUrl 中下载相应环境,并启动 Gradle。
因为 Gradle 允许命令行启动时附加参数来自定义 Gradle 的运行环境,所以百度app通过自定义 gradle-wrapper.jar,实现通过配置文件为不同内存大小的电脑、debug/release 包指定不同 gradle 运行内存,提升大家编译速度。
setting.gradle
setting.gradle 中最关键的就是其提供的 include 方法,通过这个方法可以指定哪些工程需要参与编译,每一个参与编译的工程 Gradle 会为它创建一个 Project 对象
根目录 build.gradle
首先是 buildscript 代码块: gradle 默认是自顶向下执行,无论 buildscript 代码块在哪,它都会第一个执行
接下来是 repositories 和 dependencies: repositories 表示 dependencies 声明的依赖去哪些仓库找,google、jcenter、mavenCentral 都是第三方 Maven 仓库。同时,也可以通过 maven 方法添加自己的 Maven 仓库。需要注意的是,不应该假设组件一定会从特定仓库拉取,如果 Gradle 请求一个仓库超时,它会自动请求其他仓库。
dependencies:代表 Gradle 执行需要哪些依赖。比如需要 Android Gradle Plugin 插件为我们打包 apk 包,就需要添加: classpath ‘com.android.tools.build:gradle:3.4.0’
最后是 allprojects 和 repositories: 在 allprojects 中的配置会对所有工程生效而里面的 repositories 则表示工程声明的 dependencies 去哪些仓库查找
app build.gradle
首先可以看到 apply plugin: ‘com.android.application’,当应用这个插件后,它会为我们创建一系列 Task,比如 assembleDebug、assembleRelease,执行这些 Task,就会得到最终的 APK。
android 代码块是插件为我们提供的 API允许我们修改 Task 的行为。
dependencies 代码块的内容决定当前 Project 依赖哪些组件,而不同的依赖声明会有不同的结果,具体内容我们在下一节分析。
依赖管理
依赖配置
在 Android Gradle Plugin 3.0 时代,Google 使用 implementation 和 api 选项取代过去的 compile 选项。既然接口都变了,Google 索性将其他的配置项也进行了改名,方便大家理解其配置的含义。需要注意的是,老版本的接口没有被立刻删除,但是在下一个主要版本中会被删除。下面是各个配置项的官方中文解释:
举个例子: 假设 A 依赖 B,B 依赖 C。
如果 B 对 C 使用 implementation 依赖,则 A 无法调用 C 的代码
如果 B 对 C 使用 api 依赖,则 A 可以调用 C 的代码
如果 B 对 C 使用 compileOnly 依赖,则 A 无法调用 C 的代码,且 C 的代码不会被打包到 APK 中
如果 B 对 C 使用 runtimeOnly 依赖,则 A、B 无法调用 C 的代码,但 C 的代码会被打包到 APK 中
实际上每一个组件都有自己的 compileClasspath 和 runtimeClasspath
当一个组件参与编译时,Gradle 就会将其放在 compileClasspath 中
当一个组件参与打包时,Gradle 就会将其放在 runtimeClasspath 中
不同的依赖配置项,其实就是将声明的依赖放入不同组件的不同的 classpath 中,回到上面的例子 对于 implementation ,其实就是将 C 放入 B 的 compileClasspath 和 runtimeClasspath,放入 A 的 runtimeClasspath 中,从而实现 A 如果调用 C 的代码,在 A 的编译阶段 javac 报错,但最终 C 会被打包到 APK 包中
对于 api、compileOnly、runtimeOnly 原理相同
源码与二进制
当想要依赖一个源码工程时只需要这样写: implementation project(‘:demo:mylibrary’)
而且我们可以明确知道 mylibrary 中的依赖都会被正确打包到 APK 中
当我们依赖二进制需要这样写: implementation ‘androidx.appcompat:appcompat:1.0.2’
当执行依赖命令(只输出 release 包的 runtimeClasspath):
./gradlew :app:dependencies --configuration releaseRuntimeClasspath > dependencies.txt
输出依赖关系图时会看到并不是仅仅依赖一个 appcompat 组件(只显示部分依赖),还包含该组件自己的依赖,以及依赖的依赖,直到组件自身没有依赖,这样的特性叫做依赖传递
releaseRuntimeClasspath - Resolved configuration for runtime for variant: release
— androidx.appcompat:appcompat:1.0.2
±-- androidx.annotation:annotation:1.0.0
±-- androidx.core:core:1.0.1
| ±-- androidx.annotation:annotation:1.0.0
| ±-- androidx.collection:collection:1.0.0
| | — androidx.annotation:annotation:1.0.0
| ±-- androidx.lifecycle:lifecycle-runtime:2.0.0
| | ±-- androidx.lifecycle:lifecycle-common:2.0.0
| | | — androidx.annotation:annotation:1.0.0
| | ±-- androidx.arch.core:core-common:2.0.0
| | | — androidx.annotation:annotation:1.0.0
| | — androidx.annotation:annotation:1.0.0
| — androidx.versionedparcelable:versionedparcelable:1.0.0
| ±-- androidx.annotation:annotation:1.0.0
| — androidx.collection:collection:1.0.0 (*)
±-- androidx.collection:collection:1.0.0 (*)
±-- androidx.cursoradapter:cursoradapter:1.0.0
那么 Gradle 是怎么确定这些依赖呢?当使用Maven 规范上传组件时,不单单会上传组件的二进制,还会上传一个 pom.xml 文件,依赖信息就在这个文件当中。
因为查看公共的 Maven 服务器有可能需要翻墙,下面给大家展示百度app自己搭建的服务器的后台,方便理解被上传的二进制在服务器是以怎样的结构存放的
这个是百度app自己搭建的 Maven 服务器后台,点击一项查看详情:
有上传的二进制 aar,也有 pom 文件,还有我们在上传时自定义的文件 readme
看完远端的 POM 文件,我们在看看当二进制被下载后在本地是如何存放的
下面是一个简单的 POM 文件:
可以看到有两个 dependency,需要注意的是 scope,也会分为 runtime 和 compile,runtime 不会参与编译,但会参与打包,compile 会参与编译和打包
两个实际例子: 一:假设 A 依赖 B,B 依赖 C
B 对 C 使用 implementation 依赖
B 中有类 Foo 继承于 C中的 Bar
在 A 中使用类 Foo 时会报错找不到类 Bar,解决办法只能让 A 再依赖 C,所以应该尽量避免使用继承
二:假设 A 依赖 B,B 依赖 C
写在最后
在技术领域内,没有任何一门课程可以让你学完后一劳永逸,再好的课程也只能是“师傅领进门,修行靠个人”。“学无止境”这句话,在任何技术领域,都不只是良好的习惯,更是程序员和工程师们不被时代淘汰、获得更好机会和发展的必要前提。
如果你觉得自己学习效率低,缺乏正确的指导,可以一起学习交流!
加入我们吧!群内有许多来自一线的技术大牛,也有在小厂或外包公司奋斗的码农,我们致力打造一个平等,高质量的Android交流圈子,不一定能短期就让每个人的技术突飞猛进,但从长远来说,眼光,格局,长远发展的方向才是最重要的。
35岁中年危机大多是因为被短期的利益牵着走,过早压榨掉了价值,如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!
droid交流圈子,不一定能短期就让每个人的技术突飞猛进,但从长远来说,眼光,格局,长远发展的方向才是最重要的。
35岁中年危机大多是因为被短期的利益牵着走,过早压榨掉了价值,如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!