尽管Jetpack Compose早在去年10月就已经宣布支持ProGuard了,还认真的给出了一张压缩变化图:
ProGuard
也在官网上宣布得到了的支持:
但似乎这大半年没有多少人真正试过这个ProGuard
压缩功能,以至于这个功能到现在好像只是假装支持了,其实要真正用ProGuard
还是需要自己编写gradle
任务的,并非直接就能用,本文就介绍一下到底如何使用ProGuard
进行压缩和混淆,就以昨天写的时间显示器为压缩对象(建议简单浏览一下此文)。
首先你能看到官方在更新公告中给出的很简单的几行配置:
buildTypes.release.proguard {
configurationFiles.from("rules.pro")
}
问题来了,这个rules.pro
是什么东西?这其实就是ProGuard
的配置文件,但这个文件配置应该放在哪呢?看这个配置不就是jetpack compose
做的gradle proguard
插件决定的吗,但他什么都没说只能自己探索,只能自己探索,这个文件很矛盾,按理来说自然是放到resources
目录中,不然也得是src\main\kotlin
中吧,而且确实这样写就有ProGuard
语法提示。但真正打包时可不认你这个目录,只能放到项目根目录中,也就是和build.gradle
同级,但放在这个位置抱歉,你就没有IDEA
的语法提示了,里面写src\main
中的类都会报错的,但没办法,只能写在这,官方给出的一个例子也是写在这里:
那没办法也只能放这个破地方。话说回来那么这个rules.pro
文件内容该写什么东西呢,其实就是程序入口位置,像时间显示器这个很简单的只有一个Main.kt
文件的例子,就应该这样写:
-dontwarn
-keep public class MainKt {
public void main();
}
这个-dontwarn
就是避免警告,一般情况都有包,那么包名需要也写上去,那么写完这个,就能打包了吗?
试一下gradle
任务组compose desktop
下的几个常用任务:createDistributable
、package
、packageReleaseDistributionForCurrentOS
、packageUberJarForCurrentOS
,通通没有任何的改变!往下继续找,发现一个名为proguardReleaseJars
的任务,好吧名字都是proguard
打头了就是他了,执行后发现他生成了build\compose\tmp\main-release\proguard
目录,放入了依赖的包:
全部都是jar
包,那么怎么执行这坨东西呢?用java -jar xxx
指定一个jar
来运行?不好意思完全没有入口,你会说我不是有main
方法吗怎么没入口?但它包里的MANIFEST.MF
就是不给你设置Main-Class
气不气,那能不能通过改配置来让他设置这东西呢?诶不行,没地方设置,只能去官方找找,终于找到一个相关issue 1174,又给出了一个guide
,proguard-example,仔细一看,原来是要自己另外下插件配置任务啊,proguardReleaseJars
就是逗你玩的,支持了个寂寞,那怎么搞呢?其实也没必要非得再导个插件用什么ProguardTask
,我发现其实jetpack compose
其实自带一个AbstractProguardTask
,这东西就能用,可惜google了一下这玩意没有任何文章介绍,github上也啥都搜不到,这东西用起来也简单:
tasks.register<AbstractProguardTask>("packageProguard") {
val packageUberJarForCurrentOS by tasks.getting
dependsOn(packageUberJarForCurrentOS)
inputFiles.from(packageUberJarForCurrentOS.outputs.files)
val file = packageUberJarForCurrentOS.outputs.files.singleFile
mainJar.set(file)
mainClass.set("MainKt")
dontobfuscate.set(true)
defaultComposeRulesFile.set(File("rules.pro"))
destinationDir.set(File(file.parent, "min"))
//下面这个proguard.jar路径可以放个全局位置
proguardFiles.from("proguard.jar")
proguardVersion.set("7.3.2")
configurationFiles.from("rules.pro")
}
都是一些顾名思义的属性,destinationDir
可以设置在浅一些的目录方便用,这个proguard.jar
是要去下载的,不能去找本地仓库的那个proguard-core-8.0.6.jar
、proguard-base-7.2.0.jar
之类的玩意,是不能用的,只能去proguard的Github release下载,我下载proguard-7.3.2.zip
后解压,取出lib
目录中的proguard.jar
,随意放了个位置,然后把上面的proguardFiles.from()
设为这个位置就好了,那么这样就行了吗,其实还得改下rules.pro
的内容,因为proguard
他压缩就是去掉不用的东西,一旦用反射他就找不到有些必须的东西,所以还得加一些豁免包:
-dontwarn
-keep class kotlinx.coroutines.** {*;}
-keep class org.jetbrains.skia.** {*;}
-keep class org.jetbrains.skiko.** {*;}
-keepclassmembernames class kotlinx.** {
volatile <fields>;
}
-keep public class MainKt {
public void main();
}
这一段是经过很多报错才试出来的,然后我们可以在Math.kt
中加入一个没用的方法测试一下:
fun test111() {
println(111)
}
然后刷新下gradle
执行other
组中我们写的packageProguard
任务,然后然后就能在build\compose\jars\min
中看到一个时间显示器-windows-x64-1.0.0.jar
,外面压缩前的体积是25.4MB
,这里压缩后的是14.8MB
,还是可以的。为了方便执行可以改名为1.jar
,然后运行java -jar 1.jar
就能运行了:
也可以验证一下前面加的test111()
有没有被ProGuard
进行tree-shaking
的处理,直接解压jar
就好了,众所周知jar
其实就是个zip
,然后找到MainKt.class
拖到IDEA
中反编译一下:
可以看到没有test111()
,确实是成功tree-shaking
了,去掉了unused
的方法。
以上就是Jetpack Compose
使用ProGuard
压缩的详情,各个平台Windows
、Android
、IOS
等都是适用的,希望能帮助到读者。
本文写作于2023年6月27日并发布于lyrieek的掘金,于2023年6月28日进行修订发布于lyrieek的阿里云开发者社区。
参考
- https://juejin.cn/post/7249297734867927095
- https://blog.jetbrains.com/kotlin/2022/10/compose-multiplatform-1-2-is-out/
- https://community.guardsquare.com/t/update-compose-multiplatform-now-supports-proguard/2251
- https://github.com/JetBrains/compose-multiplatform/blob/master/gradle-plugins/compose/src/test/test-projects/application/proguard
- https://github.com/JetBrains/compose-multiplatform/blob/aa08279104cacc46a063a4322369a3b2bc66462f/tutorials/Native_distributions_and_local_execution/README.md#obfuscation
- https://github.com/Guardsquare/proguard/releases/tag/v7.3.2
- https://github.com/JetBrains/compose-multiplatform/issues/1174
- https://github.com/JetBrains/compose-multiplatform/issues/2931