0x01 基本项目结构
使用Android Studio创建的Android项目会划分成三个层级:
project : settings.gradle定义了构建应用时包含了哪些模块;build.gradle定义了适用于项目中所有模块的构建配置
module : 可以是一个app类型的module,对应生成apk应用;也可以是一个lib类型的module,对应生成aar包. 每个module中包含的build.gradle定义了针对该module的各种构建选项
-
sourceset : 每个module的源码和资源分组为多个源集,main源集包含了所有变体共用的源码和资源. 源集结合productFlavors和buildTypes编译可以很好的实现多套源码,资源,以及依赖库的应用打包
+--- Comi/ | \--- build.gradle \--- setting.gradle +--- app/ | | | \--- build.gradle | \--- build/ | \--- libs/ | \--- src/ | | | \--- main/ | | \--- java/ | | \--- com.icomico.comi/ | | \--- res/ | | \--- drawable/ | | \--- layout/ | | \--- ... | | \--- AndroidManifest.xml | \--- jp/ | \--- ... +--- comi_base/ +--- ...
0x02 构建流程
构建流程涉及到了将项目转化成apk包的各方面,并配合有可灵活配置的构建选项,基本的构建流程包含了以下几步:
- 编译器将源码转换成dex文件,并将其它所有内容转换成已编译资源
- 打包工具将dex文件和已编译资源合并成单个apk文件,apk文件此时处于未签名状态
- 打包工具根据当前构建任务对应buildTypes中选择的signingConfigs选项,使用相应秘钥对apk文件对apk进行签名
- 打包工具使用zipalign工具对apk包进行优化
- 构建结束,生成最终apk文件
0x03 灵活配置构建选项
基于Gradle的Android插件提供了一系列可自定义配置的构建选项,可以方便在构建过程中选择多样的构建方式,以下列出一些常用的构建选项
-
defaultConfig
包含了用于所有变体种的一些构建选项,如果productFlavors中配置了同样的构建选项,则会覆盖defaultConfig中的对应项defaultConfig { applicationId 'com.icomico.comi' //应用包名 minSdkVersion 10 targetSdkVersion 23 versionCode 1000 versionName '1.0' multiDexEnabled true //支持多dex文件,用于解决方法数超过65K的限制时打包输出问题 } -
signingConfigs
包含了app签名文件的各项配置signingConfigs { release { storeFile file('xxx') storePassword 'xxx' keyAlias 'xxx' keyPassword 'xxx' v2SigningEnabled false //是否使用7.0版本引入的APK signature scheme v2签名方式,默认为true } debug { ... } } -
buildTypes
构建类型中可定义多个构建类型,每个构建类型可以选择不同的构建属性,包括使用的签名配置,优化选项,混淆选项等.必须定义至少一个构建类型才能开始构建应用buildTypes { release { signingConfig signingConfigs.release //使用的签名配置 minifyEnabled true //是否使用proguard进行代码压缩优化 shrinkResources true //是否进行资源压缩,使用资源压缩前需要使用代码压缩 proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro', 'proguard-fresco.pro' //指定使用的proguard配置文件 manifestPlaceholders = [DEBUG: false] //替换manifest文件中标记为${DEBUG}的文本 } debug { ... } } -
productFlavors
谷歌翻译为产品风味的选项,用来发布不同的应用版本,并可以为不同版本指定包括包名,版本号等不同的构建属性productFlavors { develop { applicationId 'com.icomico.comi.dev' //应用包名 manifestPlaceholders = [TEMP_CH_NAME name]} //使用flavor名称替换manifest中的渠道号字段,实现修改渠道号 official { applicationId 'com.icomico.comi' manifestPlaceholders = [TEMP_CH_NAME: name] } ... } -
sourceSets
源集可指定了不同变体使用的源码和资源文件,默认情况下,源集与src目录下的目录结构一一对应,每个src下的目录为一个源集.sourceSets配置项可在变体基础上指定变体使用的源集文件位置,这样可以在定义了大量变体,同时使用的源码和资源文件没有区别的情况下,避免在src下生成同等数量的目录sourceSets { develop { jni.srcDir 'src/main/jni' java.srcDir 'src/dev/java' res.srcDir 'src/dev/res' manifest.srcFile 'src/dev/AndroidManifest.xml' } official { ... } ... } -
dependencies
依赖项用以管理来自本地或远程地址上的项目依赖,包括了模块依赖,远程和本地的库文件依赖. 同时可以指定使用依赖项的方式以及为不同变体指定不同的依赖项dependencies { compile project(':comi_base') //编译时依赖,gradle 将此配置的依赖项添加到类路径和应用的apk apk files('libs/apk_use.jar') //仅运行时依赖,需要将其与apk一起打包.只可用于jar包形式的依赖项 provided files('libs/apk_unuse.jar') //不与apk一起打包的编译时依赖,只可用于jar包形式的依赖项 officialCompile project(':comi_player') //构建official版本时使用的依赖项 debugCompile 'com.squareup.leakcanary:leakcanary-android:1.3' //构建debug编译类型时使用的依赖项 releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.3' //构建release编译类型时使用的依赖项 baiduCompile files('libs/BDAutoUpdateSDK_20150605_V1.2.0.jar') //构建baidu渠道版本时使用的依赖项 baiduCompile files('libs/need_lib.jar') baiduCompile files('libs/patchupdate.jar') }
0x04 多种变体的打包实践
-
基于module划分的项目结构
利用module将项目工程划分为多个app module和多个lib module的结构,多个app工程可以各自选择需要使用到的lib工程,每个lib工程实现相对独立的功能模块.+--- Comi/ | +--- app/ | | | \--- build.gradle | \--- src/ | | | \--- main/ | | \--- java/ | | \--- com.icomico.comi/ | | \--- res/ | \--- jp/ | | \--- java/ | | \--- com.icomico.comi/ | | | | | \--- ChConfig.java | \--- official/ | | \--- java/ | | \--- com.icomico.comi/ | | | | | \--- ChConfig.java | \--- ... | \ ... +--- app_special/ +--- comi_base/ +--- comi_reader/ +--- comi_player/ +--- comi_web/ +--- comi_danmaku/ +--- ... -
使用build.gradle脚本管理module的构建配置
android { defaultConfig { ... } buildTypes { ... } signingConfigs { ... } sourceSets { ... } productFlavors { develop { applicationId 'com.icomico.comi.dev' //应用包名 manifestPlaceholders = [TEMP_CH_NAME name]} //使用flavor名称替换manifest中的渠道号字段,实现修改渠道号 official { applicationId 'com.icomico.comi' manifestPlaceholders = [TEMP_CH_NAME: name] } ... } ... } dependencies { compile project(':comi_base') officialCompile project(':comi_player') ... } 变体
由buildTypes, productFlavors, sourceSets三项配置, 可以形成gradle打包任务中的多种变体, gradle针对每种变体组合都创建了一个构建任务assemble,可指定执行不同变体的构建任务 为变体指定包名,替换指定字段,指定依赖项等
在app工程的build.gradle构建脚本中,使用productFlavors来定义了多个渠道的变体,并为不同渠道设置了不同的应用包名,渠道号等.同时可以在dependencies中为不同的变体选择了依赖的lib工程,如comi_player库仅为official渠道的变体集成不同变体使用多套代码及资源
针对代码,在app工程的src目录下,利用sourceset划分出official和jp两个源集,其中各自定义了用一份java类ChConfig.java,在打包中不同源集的apk文件包含的便是不同的代码文件.main目录下的代码文件会包含在每个源集中,因此在main目录下就不能定义同样的ChConfig.java文件
针对资源,与代码文件相同,可以在源集目录下定义同名的资源,生成apk包时会覆盖main目录下的同名资源
0x05 渠道打包
- 结合持续集成环境,可以将渠道号等参数以一定规则作为文件名,在已生成好的apk文件中的META-INF目录下写入空文件,以提升渠道包打包速度
0x06 参考文献
- https://developer.android.google.cn/studio/build/index.html
- http://tech.meituan.com/mt-apk-packaging.html