最近项目有需求要进行下内存泄漏检测提升下代码质量,由于我司做的都是系统内置APP(SystemUI、Launcher)等,编译方式不是gradle,leakcanary官方没有给出使用makefile集成的步骤,无奈只能自己摸索。
首先,这边使用的是leakcanary的1.6.2版本,原因是因为我们项目里面没有使用kotlin语言,现在Leakcanary 2.几的版本都是kotlin写的,为了避免麻烦直接使用Leakcanary 的java最后一个版本1.6.2,老的版本功能上面可能没有新版的高级,trace打印也没有那么清晰,但是大体的功能还是比较完备的,对于检测项目内存泄露还是有很大帮助,接下来我就讲一下集成的步骤:
首先你需要下载Leakcanary的1.6.2 的代码,地址:
GitHub - square/leakcanary: A memory leak detection library for Android.
我这边也提供了下载好的1.6.2的源码在文章附件中,源码的结构大概是这样:
你需要build编译一下自己的Leakcanary库,解决各种gradle编译问题之后,mk要集成Leakcanary我们一共需要6个文件:
- leakcanary-analyzer-1.6.2.aar
- leakcanary-android-1.6.2.aar
- leakcanary-support-fragment-1.6.2.aar
- leakcanary-watcher-1.6.2.jar
- haha-2.0.4.jar
- trove4j-20160824.jar
前四个文件在项目成功build完之后可以在各自模块的build/下找到:
由于analyzer 依赖了haha库(解析hrpof文件的库):
所以我们还要下载哈哈库,地址:
https://mvnrepository.com/artifact/com.squareup.haha/haha/2.0.4
由于哈哈库又依赖了org.jetbrains.trove4j/trove4j 库:
所以你还要下载下trove4j 库,地址:
https://mvnrepository.com/artifact/org.jetbrains.trove4j/trove4j/20160824
哈哈库和trove4j库我会上传到附件,关于其他Leakcanary的4个库由于我这边修改了leakcanary的源代码,里面有公司业务逻辑,所以不再提供,请自行编译获取,编译中你可能要解决androidx的问题,混淆,gradle版本过低等问题
接下来将获取到6个的aar包和jar包放到项目的libs目录下。
开始编辑makefile文件:
#依赖jar包
LOCAL_STATIC_JAVA_LIBRARIES +=
haha \
trove4j \
leakcanary-watcher
#依赖aar
LOCAL_STATIC_JAVA_AAR_LIBRARIES += \
leakcanary-analyzer \
leakcanary-support-fragment \
leakcanary-android
LOCAL_PROGUARD_ENABLED := disabled #建议关闭混淆
#添加包名
LOCAL_AAPT_FLAGS += --extra-packages com.squareup.leakcanary
LOCAL_AAPT_FLAGS += --extra-packages gnu.trove
#下面这行解决leakcanary-android aar文件里面的res资源文件找不到问题
LOCAL_RESOURCE_DIR += $(call intermediates-dir-for,JAVA_LIBRARIES,leakcanary-android,,common)/aar/res
LOCAL_PREBUILT_STATIC_JAVA_LIBRARIES += \
haha:../../libs/haha-2.0.4.jar \
leakcanary-watcher:../../libs/leakcanary-watcher-1.6.2.jar \
leakcanary-android:../../libs/leakcanary-android-1.6.2.aar \
leakcanary-analyzer:../../libs/leakcanary-analyzer-1.6.2.aar \
trove4j:../../libs/trove4j-20160824.jar \
leakcanary-support-fragment:../../libs/leakcanary-support-fragment-1.6.2.aar
上面的内容要加到mk文件正确的位置,什么意思呢,比如你的mk文件里面如果没有LOCAL_STATIC_JAVA_LIBRARIES,那么上面的LOCAL_STATIC_JAVA_LIBRARIES就不要使用+= 了,请使用 :=,+=是拼接,:=是赋值。如果你的项目里面有LOCAL_STATIC_JAVA_LIBRARIES,
LOCAL_STATIC_JAVA_LIBRARIES +=
haha \
trove4j \
leakcanary-watcher
那么请把上面的代码加入到你的LOCAL_STATIC_JAVA_LIBRARIES下面,意思是拼接
其他的LOCAL_STATIC_JAVA_AAR_LIBRARIES、LOCAL_AAPT_FLAGS、LOCAL_RESOURCE_DIR等也都这么做,该赋值的赋值,该拼接的拼接,聪明的你应该理解其中的意思。
编辑完mk文件之后接下来编辑项目的Application文件来初始化Leakcanary:
import com.squareup.leakcanary.LeakCanary;
import com.squareup.leakcanary.RefWatcher;
public class App extends Application {
private static RefWatcher sRefWatcher;
@Override
public void onCreate() {
if (LeakCanary.isInAnalyzerProcess(this)) {
// This process is dedicated to LeakCanary for heap analysis.
// You should not init your app in this process.
return;
}
sRefWatcher = LeakCanary.install(this);
}
}
注意,如果你的设备上面多个APP都集成了Leakcanary,上面的sRefWatcher有可能为空,isInAnalyzerProcess是用来检查当前设备是否已经有Leakcanary进程运行,有的话直接给返回了。
这样Leakcanary就能监测应用内activity和fragment的泄露了。如果你需要检测其他特定的类是否泄露,使用sRefWatcher.watch(this) 来监测。
一般使用Leakcanary 桌面上都会出现一个图标让你快捷的进入泄露列表的activity来更方便的查看泄露,但是源码集成后可能你看不到这个图标,你可以使用下面的adb命令来进入activity:
adb shell am start -n <your app package name>/com.squareup.leakcanary.internal.DisplayLeakActivity
接下来的工作就是测试你的APP来解决各种内存泄露了。
在集成过程中你可能还会遇到其他的问题,比如依赖库和你的项目的minSdkVersion不一致错误,你可以在AndroidManifest文件中加入:
<uses-sdk android:minSdkVersion="26" android:targetSdkVersion="31"/>
以上过程亲测可行,可以解决大部分问题,由于每个人的ubunut系统环境不同,编译环境也不同,Android源码版本也不一样,你可能还会遇到其他编译问题,比如Activity类找不到,混淆等问题,遇到问题先静下来思考,Google搜索下基本都会有人遇到。
另外,在解决内存泄露的时候,Leakcanary报的一些泄露有时候是Android源码的泄露,我们无法解决,遇到特殊的泄露问题还可以在Leakcanary的github issues里面进行搜索(Issues · square/leakcanary · GitHub)定位原因,google的大神们都会在里面讨论,看看别人的解决方式会让我们受益匪浅。
今天的分享就到这里,有问题可以在评论区讨论,谢谢大家
--------------
送佛送到西,下面是6个资源文件地址:
链接: https://pan.baidu.com/s/1-Z4rcm9BHSqIB9I2K_WGpQ
提取码: 5mxr