半小时入门Qigsaw,你信不?
首先你要对AAB有一定了解,然后这就够了!看完下面的介绍,再运行下Demo差不多就入门了!
QigsawBundle 打包的特点
- 输出ApkMd5稳定,未修改的插件打包基本固定不变。可以做到Base独立升级,插件不变。要做到稳定请参考稳定混淆App
- 稍作修改,可以实现上传AAB给后台打包发更新(当前不支持)。
root build.gradle
ext.qigsawBundle = {
apply plugin: 'qigsaw-bundle'
qigsawBundleOption {
log = true//是否打印日志
debugType = '0'
releaseType = '1'
apkFileHost = getApkHost()//可以写死
publishTool = rootProject.file('publish/build/libs/publish-all.jar')//PUBLISH_TOOL's JAR
// publishTool = 'com.donald.publish.Main'//PUBLISH_TOOL's CLASS
fileNameFormat = "{appId}-{split}-{abi}-t{type}-v{version}-{md5}"
options = [
'--ks=' + file("../keystore/debug.jks"),
// "--connected-device",//fixme 启用这个,打测试包更快。正式包必须注释这个。
"--ks-pass=pass:qigsawtest",
'--ks-key-alias=qigsawtest',
"--key-pass=pass:qigsawtest"
]
}
android {
defaultConfig {
buildConfigField "String", 'apkFileHost', qigsawBundleOption.apkFileHost.quote()
}
buildTypes {
debug {
buildConfigField "String", 'VERSION_TYPE', qigsawBundleOption.debugType.quote()
}
release {
buildConfigField "String", 'VERSION_TYPE', qigsawBundleOption.releaseType.quote()
}
}
}
}
qigsawBundleOption.publishTool
QigsawBundle调用时,会传入两个参数。
release:正式或测试
dir:文件夹路径
解析所有文件,实现上传即可。 具体使用参考demo模块publish/main 方法。
用来指定发布开发者自己应用的工具,可以是JAR路径,也可以是类名。如果是类名的话,需要在root中引用依赖。具体依赖由用户而定,以下是Demo中publish模块发布到本地的依赖项。
classpath "com.gitee.DonaldDu:QigsawPublish:1.0"//PUBLISH_TOOL'S CLASS
qigsawBundleOption.fileNameFormat
用来格式化打包输出的文件名(包括APK和JSON),不能带后缀,可以用部分占位符。
- {appId}: applicationId
- {split}: SplitName
- {abi}: master/x86/arm64-v8a ...
- {type}: debugType/releaseType
- {version}:versionName@versionCode -> 1.0@1
- {md5}: APK为ApkMd5,其它为文件MD5
qigsawBundleOption.apkFileHost
打包输出APK链接地址的前缀,如果能确定上传后文件的URL,可以写上准确值。不能确定的可以随意写个占位就行。
qigsawBundleOption.options
这设置项是Google bundletool 标准命令,详情参考官方文档。
==特别说明== 请把 bundletool.jar 下载并保存到‘.gradle’目录中,并在‘init.gradle’中增加如下定义。也可以保存在其它路径,但定义的路径一定要对。
allprojects {
ext.BUNDLE_TOOL_PATH = new File(gradle.gradleUserHomeDir, "bundletool.jar").absolutePath
}
qigsawBundleOption.debugType/releaseType
用来区分打包输出文件版本类型,方便上传。String类型,值由用户指定。
base build.gradle
android {}
with(qigsawBundle)//after android inited
dependencies {
implementation "com.gitee.DonaldDu:QigsawSplitDownloader:1.0.1"//下载器可以自己实现,这是个简单实现。
implementation "com.gitee.DonaldDu.QigsawBundle:Compat:$qigsawBundleV"
api "com.gitee.DonaldDu.Qigsaw:splitcore:2.0.2"
}
QigsawSplitDownloader
支持缓存的下载器,相同ApkMd5的文件只会下载一次。
CompatBundle
需要用户继承BaseCompatBundle实现自己的CompatBundle。
因为这个类是用ServiceLoader加载的,所以需要把类名写在以下文件中
app/src/main/resources/META-INF/services/com.iqiyi.android.qigsaw.core.common.ICompatBundle
/**
* ServiceLoader for ICompatBundle
* */
class CompatBundle : BaseCompatBundle() {
override fun qigsawConfigClass(): Class<*> = QigsawConfig::class.java
}
存在的问题
- 所有特性和标准AAB一样
- 下载的资源类插件时,需要手动注入后才能在当前页面访问,否则会找不到而报错。
- 暂不支持内置插件。
- ==不支持插件内Application==(Qigsaw支持)
- ==需要处理不同Base版本的插件列表文件不能分发错乱。== DEMO项目中未处理此问题,默认兼容所有版本了。
经验之谈
- 一定要在应用启动时,默认加载所有已安装的插件,不然新进程的代码会找不到类。
- 个人觉得没必要开签名验证(verifySignature),因为已经有MD5验证了。
- 建议用最新的ActivityResultLauncher来启动插件,非常方便。
- 启动模块页面建议用URI来实现,不建议用DEMO中的枚举,这里只是方便而已,但不够灵活,不能适应业务变动。
local.properties
DEMO项目local.properties定义了apkFileHost,用户可以修改为自己的IP
apkFileHost=http://192.168.31.15/
proguard
发布正式更新后,可以把mapping.txt复制到base目录以替换旧的。然后在以下文件中启用mapping。测试中不需要用旧mapping文件时,可以注释掉。
base-proguard-rules
-applymapping mapping.txt
其它说明
只需要在base中引用 'qigsaw-bundle' Plugin 就行了,dynamic-feature 不需要任何额外的操作,和标准AAB一样。
每个 dynamic-feature 都可以设置自己的“proguard-rules”,不用都在base中设置,公共的可以写在base中。
运行项目下的‘StartWebServer.bat’可以启动一个服务,demo中的发布代码就能上传应用,运行的Base也可以下载插件。
为了保证Base能下载插件,请确保apkFileHost地址是对的。因为这个工具应该主要是国人用,国外都用标准AAB,所以这个项目代码放在gitee上的。但用jitpack打包时常出问题,所以又弄到github上了。
更多详细信息,请参考 Demo,打包工具项目地址 QigsawBundle,
最新依赖-jitpack-
安装Base时,可以根据需要在设置中选择是否一起安装插件
最后
如果本文帮助到了你,也帮我点个赞吧!
如果你愿意,还可以赞赏一杯咖啡或一瓶水,非常感觉你的慷慨!