利用 leakcanary 构建离线的内存泄漏检测

需求分析

LeakCanary是一个Java内存泄露检测工具。它能十分方便的检测出项目中的内存泄露，同时提供非常友好的通知提示。

但是在实际运用中，LeakCanary只能够用在调试版本中，不能够在发布版本中进行泄露测试。

• LeakCanary集成了haha库，来分析内存dump文件，这个代码量还是蛮大的，会导致应用发布版本体积增大不少。
• LeakCanary的泄漏界面很好，但是肯定不能向终端用户展现；但是可以向测试人员展现，能够提高发现问题的效率。

解决方案

针对这个问题，我们的解决方案是：应用集成+独立分析工具+线上收集分析

1、应用集成

• 在应用内检测最小的LeakCanary，不集成haha相关的功能，只做“检测泄漏”和“内存Dump”；
• 应用完成内存dump，可以启动独立的泄漏分析工具分析该内存dump，也可以将dump文件上传线上服务器。
• 泄漏分析工具需要测试人员自行安装，在终端用户上是没有的

2、分析工具

• 分析工具是一个普通APP（APK），集成LeakCanary（包含haha）的分析功能
• 收到应用传过来的泄漏Intent后，分析并展现泄漏信息
• 需要开发、测试人员自行安装，与具体应用无关

3、线上分析

• 线上分析是指后台服务分析
• 可以基于LeakCanary+haha实现泄漏的分析
• 同时需要实现泄漏点统计分析、版本追踪等功能

具体实现

App侧的功能单独用一个模块封装，可以在各个App共用。

下面是Android平台的实现代码：

package xxx;

import android.app.Activity;
import android.app.Application;
import android.content.ComponentName;
import android.content.Context;
import android.content.ContextWrapper;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.os.Bundle;
import android.os.Parcelable;
import android.view.Display;
import android.view.LayoutInflater;
import android.view.View;
import android.view.WindowManager;

import com.squareup.leakcanary.AndroidDebuggerControl;
import com.squareup.leakcanary.AndroidExcludedRefs;
import com.squareup.leakcanary.AndroidHeapDumper;
import com.squareup.leakcanary.AndroidWatchExecutor;
import com.squareup.leakcanary.DebuggerControl;
import com.squareup.leakcanary.DefaultLeakDirectoryProvider;
import com.squareup.leakcanary.ExcludedRefs;
import com.squareup.leakcanary.GcTrigger;
import com.squareup.leakcanary.HeapDump;
import com.squareup.leakcanary.HeapDumper;
import com.squareup.leakcanary.LeakDirectoryProvider;
import com.squareup.leakcanary.RefWatcher;
import com.squareup.leakcanary.WatchExecutor;

import java.util.List;

import static java.util.concurrent.TimeUnit.SECONDS;


public class LeakDump {

    private static final String TAG = "LeakDump";

    private static final long DEFAULT_WATCH_DELAY_MILLIS = SECONDS.toMillis(5);

    private static Context sContext;
    private static RefWatcher sRefWatcher;


    public static synchronized void init(Context context) {
        if (sContext == null) {
            sContext = context.getApplicationContext();
            sRefWatcher = getRefWatcher();
        }
    }

    public static void watch(Object object, String message) {
        if (sRefWatcher != null) {
            sRefWatcher.watch(object, message);
        }
    }


    public static synchronized void watchAllActivities() {
        if (sCallbacks == null && (sContext.getBaseContext() instanceof Application)) {
            sCallbacks = new MyActivityLifecycleCallbacks();
            ((Application) sContext.getBaseContext())
                    .registerActivityLifecycleCallbacks(sCallbacks);
        }
    }

    private static RefWatcher getRefWatcher() {
        try {
            WatchExecutor watchExecutor =
                    new AndroidWatchExecutor(DEFAULT_WATCH_DELAY_MILLIS);
            DebuggerControl debuggerControl = new AndroidDebuggerControl();
            GcTrigger gcTrigger = GcTrigger.DEFAULT;
            LeakDirectoryProvider leakDirectoryProvider = 
                    new DefaultLeakDirectoryProvider(sContext);
            HeapDumper heapDumpper = 
                    new AndroidHeapDumper(sContext, leakDirectoryProvider);
            HeapDump.Listener dumpListener = new ServiceHeapDumpListener(sContext);
            ExcludedRefs excludedRefs = AndroidExcludedRefs.createAppDefaults().build();
            return new RefWatcher(watchExecutor,
                    debuggerControl, gcTrigger, heapDumpper, dumpListener, excludedRefs);
        } catch (Throwable e) {
            Log.w(TAG, "getRefWatcher", e);
            return null;
        }
    }


    private static final class MyActivityLifecycleCallbacks implements
            Application.ActivityLifecycleCallbacks {

        @Override
        public void onActivityCreated(Activity activity, Bundle bundle) {

        }

        @Override
        public void onActivityStarted(Activity activity) {

        }

        @Override
        public void onActivityResumed(Activity activity) {

        }

        @Override
        public void onActivityPaused(Activity activity) {

        }

        @Override
        public void onActivityStopped(Activity activity) {

        }

        @Override
        public void onActivitySaveInstanceState(Activity activity, Bundle bundle) {

        }

        @Override
        public void onActivityDestroyed(Activity activity) {
            LeakDump.watch(activity, "");
        }
    }


    private static class ServiceHeapDumpListener implements HeapDump.Listener {

        public static final String HEADP_DUMP_FILE_PATH = "headpumpfile_path";
        public static final String KEY = "key";
        public static final String NAME = "name";
        public static final String WATCH_DURATION = "watch_duration";
        public static final String GC_DURATION = "gc_duration";
        public static final String DUMP_DURATION = "dump_duration";
        public static final String DUMP_PACKAGE_NAME = "dump_package";

        private Context mContext;

        public ServiceHeapDumpListener(Context context) {
            mContext = context.getApplicationContext();
        }

        @Override
        public void analyze(HeapDump heapDump) {
            Intent resultIntent = new Intent();
            resultIntent.putExtra(HEADP_DUMP_FILE_PATH, heapDump.heapDumpFile.getAbsolutePath());
            resultIntent.putExtra(KEY, heapDump.referenceKey);
            resultIntent.putExtra(NAME, heapDump.referenceName);
            resultIntent.putExtra(WATCH_DURATION, heapDump.watchDurationMs);
            resultIntent.putExtra(GC_DURATION, heapDump.gcDurationMs);
            resultIntent.putExtra(DUMP_DURATION, heapDump.heapDumpDurationMs);
            resultIntent.putExtra(DUMP_PACKAGE_NAME, mContext.getPackageName());
            DebugLog.e(TAG, "analyze", resultIntent.getExtras());

            PackageManager pm = mContext.getPackageManager();
            Intent queryIntent = new Intent("android.intent.action.service.leakcanary");
            List<ResolveInfo> lists = pm.queryIntentServices(queryIntent, PackageManager.MATCH_DEFAULT_ONLY);
            if (lists.size() == 0) {
                DebugLog.e(TAG, "analyze: leak analysis apk is not installed!");
                return;
            }
            ResolveInfo result = lists.get(0);
            String packageName = result.serviceInfo.packageName;
            String className = result.serviceInfo.name;
            resultIntent.setComponent(new ComponentName(packageName, className));
            mContext.startService(resultIntent);
        }
    }

}