精华内容
下载资源
问答
  • // This process is dedicated to LeakCanary for heap analysis. // You should not init your app in this process. return ; } refWatcher = LeakCanary. install ( this );} public static RefWatcher ...

    1.在工程gradle加上后面2句

    dependencies {
        compile fileTree(dir: 'libs', include: ['*.jar'])
        testCompile 'junit:junit:4.12'
        compile 'com.android.support:appcompat-v7:23.4.0'
        debugCompile 'com.squareup.leakcanary:leakcanary-android:1.4-beta2'
        releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
    }
    2.在自己定义的application这样写
    public void onCreate() {
        super.onCreate();
    if (LeakCanary.isInAnalyzerProcess(this)) {
        // This process is dedicated to LeakCanary for heap analysis.
        // You should not init your app in this process.
        return;
    }
    refWatcher = LeakCanary.install(this);}public static RefWatcher getRefWatcher(Context context) { MApplication application = (MApplication) context.getApplicationContext(); return application.refWatcher;}private RefWatcher refWatcher;3.在activity的ondestory里面这样写
    @Override
    protected void onDestroy() {
        super.onDestroy();
        RefWatcher refWatcher = MApplication.getRefWatcher(this);
        refWatcher.watch(this);
    }
    eclipse 看这里:
    http://blog.csdn.net/liudehuaii18/article/details/46287695
    

    展开全文
  • 今天来写一个关于LeakCanary-1.5.0的一些心得;我们移动端性能方面第一个就想到使用LeakCanary;但是很多使用LeakCanary无法解析,以及LeakCanary在不同手机上面也会有不同的一些提示;我这边自己抽了一些时间,对...

           今天来写一个关于LeakCanary-1.5.0的一些心得;我们移动端性能方面第一个就想到使用LeakCanary;但是很多使用LeakCanary无法解析,以及LeakCanary在不同手机上面也会有不同的一些提示;我这边自己抽了一些时间,对LeakCanary的架构进行分析,以及代码的实现过程进行分析;不知道一篇能不能写完:下面先上一个图;      

          这个是自己画的LeakCanary的uml图;仅仅画了初始化的地方;这边会从这个图一步步解析LeakCanary的作用;首先我们先看到LeakCanary的初始化

         1)install(Application application)初始化方法

    public static RefWatcher install(Application application) {
        return refWatcher(application).listenerServiceClass(DisplayLeakService.class)
            .excludedRefs(AndroidExcludedRefs.createAppDefaults().build())
            .buildAndInstall();
      }
     public static AndroidRefWatcherBuilder refWatcher(Context context) {
        return new AndroidRefWatcherBuilder(context);
      }

      其中new 一个AndroidRefWatcherBuilder对象,开始注册listenerServiceClass并且注册一个ExcludedRefs,最后进行组装;

    其中buildAndInstall方法里面涉及到了Application注册Activity的生命周期;主要在生命周期的里面的onActivityDestroyed里面进行触发一个方法ActivityRefWatcher.this.onActivityDestroyed(activity);

        2)我们开始分析,第一步new AndroidRefWatcherBuilder并且设置ApplicationContext;

        3)设置listenerServiceClass;其中传入了DisplayLeakService.class;(专门处理heapDump文件)

         DisplayLeakService的父类是AbstractAnalysisResultService,AbstractAnalysisResultService的父类是IntentService。其实走到这一步;大概能看出来做一个异步的耗时操作了;肯定是在onHandleIntent(Intent intent);并且sendResultToListener是进行发送耗时操作的方式;获取heapDump文件,进行分析;重写onHeapAnalyzed方法,具体在DisplayLeakService实现;(具体实现后面分析)

        4)  获取AndroidExcludedRefs;创建ExcludedRefs对象;里面更多包含的是配置

        先看一下createAndroidDefaults方法;其中里面默认实现了SOFT_REFERENCES, FINALIZER_WATCHDOG_DAEMON, MAIN, LEAK_CANARY_THREAD, EVENT_RECEIVER__MMESSAGE_QUEUE;

         A) SOFT_REFERENCES:

    a.注册软引用的类名

    b.注册弱引用的类名

    c.注册虚引用的类名

    d.注册Finalizer的类名(GC: 从一个对象变得不可达开始,到执行它的finalizer方法,时间可能任意长)

    f.注册FinalizerReference的类名(class类里面定义finalize方法,就会创建)

         B)FINALIZER_WATCHDOG_DAEMON:

    a.注册FinalizerWatchdogDaemon线程名称(回收的线程)

         C)MAIN

    a.注册主线程名称

         D)LEAK_CANARY_THREAD

    a.注册LeakCanary的工作线程名称

         E)EVENT_RECEIVER__MMESSAGE_QUEUE

    a.注册android.view.Choreographer$FrameDisplayEventReceiver以及mMessageQueue;应该是需要继承修改;后续在看

         F)剩下的其他和机型;Api相关。是针对某一个Api遇到内存泄露作出的指定捕获,或者刨除;这边也是后续抽一个例子细看

    这个类使用的是 EnumSet.allOf 该方法接受一个元素类型的参数elementType,并引用其元素将存储到集合中的类对象;

       5)buildAndInstall()方法

         调用这个方法的时候;判断是否是初始化默认的DISABLED;这个位子后续说;这边不是;所以走下面的代码;

     public RefWatcher buildAndInstall() {
        RefWatcher refWatcher = build();
        if (refWatcher != DISABLED) {
          LeakCanary.enableDisplayLeakActivity(context);
          ActivityRefWatcher.installOnIcsPlus((Application) context, refWatcher);
        }
        return refWatcher;
      }

    走到enableDisplayLeakActivity方法;

     public static void enableDisplayLeakActivity(Context context) {
        setEnabled(context, DisplayLeakActivity.class, true);
      }

    里面开启类一个单核心线程

    public static void setEnabled(Context context, final Class<?> componentClass,
          final boolean enabled) {
        final Context appContext = context.getApplicationContext();
        executeOnFileIoThread(new Runnable() {
          @Override public void run() {
            setEnabledBlocking(appContext, componentClass, enabled);
          }
        });
      }

    来处理setEnabledBlocking方法;

     public static void setEnabledBlocking(Context appContext, Class<?> componentClass,
          boolean enabled) {
        ComponentName component = new ComponentName(appContext, componentClass);
        PackageManager packageManager = appContext.getPackageManager();
        int newState = enabled ? COMPONENT_ENABLED_STATE_ENABLED : COMPONENT_ENABLED_STATE_DISABLED;
        // Blocks on IPC.
        packageManager.setComponentEnabledSetting(component, newState, DONT_KILL_APP);
      }

    其中packageManager.setComponentEnabledSetting(component, newState, DONT_KILL_APP);来控制启用 禁用 四大组件

    由上面代码里面 对DisplayLeakActivity进行设置成----可用状态,并且不杀死APP(明显是在处理Activity的

    下面在走 installOnIcsPlus 方法;

    其中SDK低于14的不进行初始化观察;

      public static void installOnIcsPlus(Application application, RefWatcher refWatcher) {
        if (SDK_INT < ICE_CREAM_SANDWICH) {
          // If you need to support Android < ICS, override onDestroy() in your base activity.
          return;
        }
        ActivityRefWatcher activityRefWatcher = new ActivityRefWatcher(application, refWatcher);
        activityRefWatcher.watchActivities();
      }

    其中使用Application进行注册Activity生命周期,所以Fragment的泄露希望是自己去调用

      private final Application.ActivityLifecycleCallbacks lifecycleCallbacks =
          new Application.ActivityLifecycleCallbacks() {
            @Override public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
            }
    
            @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 outState) {
            }
    
            @Override public void onActivityDestroyed(Activity activity) {
              ActivityRefWatcher.this.onActivityDestroyed(activity);
            }
          };
    

    在里面执行了onActivityDestroyed方法;

         刚刚在上面没有提到buildAndInstall方法里面的build;现在我们回过来讲一下;因为我们现在已经知道了,这个LeakCanary触发的时机;

     public final RefWatcher build() {
        if (isDisabled()) {
          return RefWatcher.DISABLED;
        }
        //1
        ExcludedRefs excludedRefs = this.excludedRefs;
        if (excludedRefs == null) {
          excludedRefs = defaultExcludedRefs();
        }
        //2
        HeapDump.Listener heapDumpListener = this.heapDumpListener;
        if (heapDumpListener == null) {
          heapDumpListener = defaultHeapDumpListener();
        }
        //3
        DebuggerControl debuggerControl = this.debuggerControl;
        if (debuggerControl == null) {
          debuggerControl = defaultDebuggerControl();
        }
        //4
        HeapDumper heapDumper = this.heapDumper;
        if (heapDumper == null) {
          heapDumper = defaultHeapDumper();
        }
        // 5
        WatchExecutor watchExecutor = this.watchExecutor;
        if (watchExecutor == null) {
          watchExecutor = defaultWatchExecutor();
        }
        // 6
        GcTrigger gcTrigger = this.gcTrigger;
        if (gcTrigger == null) {
          gcTrigger = defaultGcTrigger();
        }
    
        return new RefWatcher(watchExecutor, debuggerControl, gcTrigger, heapDumper, heapDumpListener,
            excludedRefs);
      }

       我们先看到 :

       1 是ExcludedRefs对象的赋值;从uml图里面可以看到子类AndroidRefWatcherBuilder和父类RefWatcherBuilder;在初始化的时候调用的就是对父类this.excludedRefs赋值;

       2是AndroidRefWatcherBuilder子类里面调用父类的heapDumpListener方法赋值this.heapDumpListener

       3是AndroidRefWatcherBuilder类里面重写子类的defaultDebuggerControl方法,里面获取是否是被调试状态:Debug.isDebuggerConnected()

      4 是AndroidRefWatcherBuilder类里面重写子类的defaultHeapDumper方法 (下面细讲)

      5 是AndroidRefWatcherBuilder类里面重写子类的defaultWatchExecutor方法,初始化AndroidWatchExecutor延迟5000毫秒

    (专门开了一个工作线程处理)

      6 是AndroidRefWatcherBuilder类里面 使用默认的GcTrigger(做GC操作的)

    然后组装到RefWatcher里面去;下面我们开始讲解一下整个工作的流程;以及重点的实现部分

    现在开走;实现的内存泄露检测流程

    当Activity涉及到destory时

      void onActivityDestroyed(Activity activity) {
        refWatcher.watch(activity);
      }

    调用watch方法

      public void watch(Object watchedReference, String referenceName) {
        if (this == DISABLED) {
          return;
        }
        checkNotNull(watchedReference, "watchedReference");//校验不为null
        checkNotNull(referenceName, "referenceName");//校验不为null
        final long watchStartNanoTime = System.nanoTime();//纳秒
        String key = UUID.randomUUID().toString();//唯一标识码
        retainedKeys.add(key);//缓存起来
        final KeyedWeakReference reference =
            new KeyedWeakReference(watchedReference, key, referenceName, queue);//生成weak;配置一个key和name(name看起来是空值),加到队列里面去,继承WeakReference

        ensureGoneAsync(watchStartNanoTime, reference);//实现runable的方法;
      }

      private void ensureGoneAsync(final long watchStartNanoTime, final KeyedWeakReference reference) {
        watchExecutor.execute(new Retryable() {//watchExecutor上面说的设置一个工作线程;
          //判断是否是主线程; 如果是的话,直接addIdleHandler(CPU空闲的时候会调用)然后执行run();(有重试机制)都是延时操作
          // 如果不是主线程,先post回主线程,addIdleHandler(CPU空闲的时候会调用)然后执行run();(有重试机制)都是延时操作

          @Override public Retryable.Result run() {
            return ensureGone(reference, watchStartNanoTime);//RETRY会进行重试
          }
        });
      }

      Retryable.Result ensureGone(final KeyedWeakReference reference, final long watchStartNanoTime) {
        long gcStartNanoTime = System.nanoTime();//获取纳秒
        long watchDurationMs = NANOSECONDS.toMillis(gcStartNanoTime - watchStartNanoTime);//计算出来耗时多久

        removeWeaklyReachableReferences();//移除队列里面的值,以及对应的retainedKeys的name 重要1

        if (debuggerControl.isDebuggerAttached()) {//判断是否在调试,如果是调试的返回重试
          // The debugger can create false leaks.
          return RETRY;
        }
        if (gone(reference)) {//如果retainedKeys没有缓存的reference的话,不做操作
          return DONE;
        }
        gcTrigger.runGc();//表示有reference,进行GC操作  重要2
        //Runtime.getRuntime().gc(); 发起GC操作
        //Thread.sleep(100);//等待 100毫秒
        //System.runFinalization();//运行处于挂起终止状态的所有对象的终止方法。
        //调用该方法说明 Java 虚拟机做了一些努力运行已被丢弃对象的 finalize 方法,但是这些对象的 finalize 方法至今尚未运行。当控制权从方法调用中返回时,Java 虚拟机已经尽最大努力去完成所有未执行的终止方法

        removeWeaklyReachableReferences();//移除队列里面的值,以及对应的retainedKeys的name
        if (!gone(reference)) {//如果这个时候,队列里面的reference被移除了,但是retainedKeys还是包含reference,进行下一步内存泄露分析,如果没有表示被回收了;重要 3
          long startDumpHeap = System.nanoTime();//再来一个纳秒
          long gcDurationMs = NANOSECONDS.toMillis(startDumpHeap - gcStartNanoTime);//计算耗时

          File heapDumpFile = heapDumper.dumpHeap();//生成heap dump文件,并且保存起来;看 AndroidHeapDumper类 重要4
          if (heapDumpFile == RETRY_LATER) {//如果是重试,进行重试操作
            // Could not dump the heap.
            return RETRY;
          }
          long heapDumpDurationMs = NANOSECONDS.toMillis(System.nanoTime() - startDumpHeap);//计算耗时
          heapdumpListener.analyze(
              new HeapDump(heapDumpFile, reference.key, reference.name, excludedRefs, watchDurationMs,
                  gcDurationMs, heapDumpDurationMs));//开始分析,看ServiceHeapDumpListener 类 ->HeapAnalyzerService类 重要5
        }
        return DONE;
      }

    重点说明:(这个操作是线程空余状态进行)

    重点1:

    清空不存在的误差

    重点2:

    进行GC的操作,并且还是延迟了

    重点3:

    是利用缓存,以及队列的删除进行判断是否存在内存泄漏

    重点4:

    AndroidHeapDumper类:

     @Override public File dumpHeap() {
        File heapDumpFile = leakDirectoryProvider.newHeapDumpFile();//生成路径
        // 看下面的DefaultLeakDirectoryProvider类newHeapDumpFile();生成路径不多说明
    
        if (heapDumpFile == RETRY_LATER) {//如果稍后在进行重试;会返回一个标识
          return RETRY_LATER;
        }
    
        FutureResult<Toast> waitingForToast = new FutureResult<>();
        showToast(waitingForToast);//先进行弹框出现内存泄露标志,这个也是cpu空闲时,缓存该toast
    
        if (!waitingForToast.wait(5, SECONDS)) {//并发
          CanaryLog.d("Did not dump heap, too much time waiting for Toast.");
          return RETRY_LATER;
        }
    
        Toast toast = waitingForToast.get();//获取toat
        try {
          Debug.dumpHprofData(heapDumpFile.getAbsolutePath());//Debug.dumpHprofData 生成heap dump文件,后面是路径;//目标找到了,这个是生成文件
          cancelToast(toast);//取消弹窗
          return heapDumpFile;//返回写入的路径
        } catch (Exception e) {
          CanaryLog.d(e, "Could not dump heap");
          // Abort heap dump
          return RETRY_LATER;//失败了重试
        }
      }

    里面生成了真正的dump的对象,以及解析的类

    重点5:

    ServiceHeapDumpListener 类 ->HeapAnalyzerService类

      @Override protected void onHandleIntent(Intent intent) {
        if (intent == null) {
          CanaryLog.d("HeapAnalyzerService received a null intent, ignoring.");
          return;
        }
        String listenerClassName = intent.getStringExtra(LISTENER_CLASS_EXTRA);
        HeapDump heapDump = (HeapDump) intent.getSerializableExtra(HEAPDUMP_EXTRA);
    
        HeapAnalyzer heapAnalyzer = new HeapAnalyzer(heapDump.excludedRefs);//输入信息类
    
        AnalysisResult result = heapAnalyzer.checkForLeak(heapDump.heapDumpFile, heapDump.referenceKey);//TODO 1 检测内存泄漏,以及生成result
        AbstractAnalysisResultService.sendResultToListener(this, listenerClassName, heapDump, result);
        //TODO 2 DisplayLeakService 也是一样开启一个IntentService处理 onHeapAnalyzed方法里面
      }

    这个类操作之后,到DisplayLeakService 这个进行最后的数据小处理,以及弹通知操作

    下面细讲一下TODO:

    TODO 1:

    HeapAnalyzer类:这个是我们非常关键的类。因为会涉及到我们判断哪一些不需要写入;不需要生成泄漏文件;所以上面的配置类很重要

      public AnalysisResult checkForLeak(File heapDumpFile, String referenceKey) {//确定一下是否是内存泄露
        long analysisStartNanoTime = System.nanoTime();//纳秒
    
        if (!heapDumpFile.exists()) {//判断文件是否存在;不存在的话,进行返回失败操作
          Exception exception = new IllegalArgumentException("File does not exist: " + heapDumpFile);
          return failure(exception, since(analysisStartNanoTime));
        }
    
        try {
          HprofBuffer buffer = new MemoryMappedFileBuffer(heapDumpFile);//MemoryMappedFileBuffer 将heapDumpFile传入,生成HprofBuffer,这个到haha的那个库,后续分析
          HprofParser parser = new HprofParser(buffer);//转码,也是haha
          Snapshot snapshot = parser.parse();//这几个转化后续在看,上面就是将文件转化成可以识别的对象
          deduplicateGcRoots(snapshot);//生成GC root快照
    
          Instance leakingRef = findLeakingReference(referenceKey, snapshot);//这边开始查找泄漏Instance
    
          // False alarm, weak reference was cleared in between key check and heap dump.
          if (leakingRef == null) {//如果没找到,表示没有内存泄漏
            return noLeak(since(analysisStartNanoTime));
          }
    
          return findLeakTrace(analysisStartNanoTime, snapshot, leakingRef);//有的话,开始继续查找
        } catch (Throwable e) {
          return failure(e, since(analysisStartNanoTime));
        }
      }
    
      /**
       * Pruning duplicates reduces memory pressure from hprof bloat added in Marshmallow.
       */
      void deduplicateGcRoots(Snapshot snapshot) {
        // THashMap has a smaller memory footprint than HashMap.
        final THashMap<String, RootObj> uniqueRootMap = new THashMap<>();
    
        final List<RootObj> gcRoots = (ArrayList) snapshot.getGCRoots();//获取根的gc root(可达性分析法)
        for (RootObj root : gcRoots) {//开始遍历
          String key = generateRootKey(root);//转化成字符串
          if (!uniqueRootMap.containsKey(key)) {//排重操作,如果没有的话,就加进去
            uniqueRootMap.put(key, root);
          }
        }
    
        // Repopulate snapshot with unique GC roots.
        gcRoots.clear();//清空
        uniqueRootMap.forEach(new TObjectProcedure<String>() {//haha里面的,这边应该是转化成字符串之类的,方便后续识别
          @Override public boolean execute(String key) {
            return gcRoots.add(uniqueRootMap.get(key));
          }
        });
      }
    
      private String generateRootKey(RootObj root) {
        return String.format("%s@0x%08x", root.getRootType().getName(), root.getId());
      }
    
      private Instance findLeakingReference(String key, Snapshot snapshot) {//返回找到的referenceKey的KeyedWeakReference泄漏
        ClassObj refClass = snapshot.findClass(KeyedWeakReference.class.getName());//看是否包含 KeyedWeakReference这个对象名字(弱引用);对象无法被销毁导致的
        List<String> keysFound = new ArrayList<>();
        for (Instance instance : refClass.getInstancesList()) {//haha里面,进行遍历
          List<ClassInstance.FieldValue> values = classInstanceValues(instance);//获取 List<FieldValue>
          String keyCandidate = asString(fieldValue(values, "key"));
          if (keyCandidate.equals(key)) {//看一下是否包含该key名称的,即referenceKey,有的话就是找到了该泄漏的
            return fieldValue(values, "referent");
          }
          keysFound.add(keyCandidate);
        }
        throw new IllegalStateException(
            "Could not find weak reference with key " + key + " in " + keysFound);
      }
    
      private AnalysisResult findLeakTrace(long analysisStartNanoTime, Snapshot snapshot,
          Instance leakingRef) {
    
        ShortestPathFinder pathFinder = new ShortestPathFinder(excludedRefs);//之前的配置类;
        ShortestPathFinder.Result result = pathFinder.findPath(snapshot, leakingRef);//ShortestPathFinder类
    
        // False alarm, no strong reference path to GC Roots.
        if (result.leakingNode == null) {
          return noLeak(since(analysisStartNanoTime));
        }
    
        LeakTrace leakTrace = buildLeakTrace(result.leakingNode);
    
        String className = leakingRef.getClassObj().getClassName();
    
        // Side effect: computes retained size.
        snapshot.computeDominators();
    
        Instance leakingInstance = result.leakingNode.instance;
    
        long retainedSize = leakingInstance.getTotalRetainedSize();
    
        retainedSize += computeIgnoredBitmapRetainedSize(snapshot, leakingInstance);
    
        return leakDetected(result.excludingKnownLeaks, className, leakTrace, retainedSize,
            since(analysisStartNanoTime));
      }

    TODO 2:

    DisplayLeakService类,进行发送通知

      @Override protected final void onHeapAnalyzed(HeapDump heapDump, AnalysisResult result) {
        String leakInfo = leakInfo(this, heapDump, result, true);
        CanaryLog.d(leakInfo);
    
        boolean resultSaved = false;
        boolean shouldSaveResult = result.leakFound || result.failure != null;
        if (shouldSaveResult) {
          heapDump = renameHeapdump(heapDump);//生成heapDump
          resultSaved = saveResult(heapDump, result);//保存起来。这个会让另一个页面去找到该路径
        }
    
        PendingIntent pendingIntent;
        String contentTitle;
        String contentText;
    
        if (!shouldSaveResult) {
          contentTitle = getString(R.string.leak_canary_no_leak_title);
          contentText = getString(R.string.leak_canary_no_leak_text);
          pendingIntent = null;
        } else if (resultSaved) {
          pendingIntent = DisplayLeakActivity.createPendingIntent(this, heapDump.referenceKey);
    
          if (result.failure == null) {
            String size = formatShortFileSize(this, result.retainedHeapSize);
            String className = classSimpleName(result.className);
            if (result.excludedLeak) {
              contentTitle = getString(R.string.leak_canary_leak_excluded, className, size);
            } else {
              contentTitle = getString(R.string.leak_canary_class_has_leaked, className, size);
            }
          } else {
            contentTitle = getString(R.string.leak_canary_analysis_failed);
          }
          contentText = getString(R.string.leak_canary_notification_message);
        } else {
          contentTitle = getString(R.string.leak_canary_could_not_save_title);
          contentText = getString(R.string.leak_canary_could_not_save_text);
          pendingIntent = null;
        }
        // New notification id every second.
        int notificationId = (int) (SystemClock.uptimeMillis() / 1000);
        showNotification(this, contentTitle, contentText, pendingIntent, notificationId);//发送Notification通知
        afterDefaultHandling(heapDump, result, leakInfo);
      }

    以上是我们使用LeakCanary的基本操作流程;所以这些是我需要了解;后续我们再去分析haha这个库

    展开全文
  • LeakCanary2的免写 初始化代码 原理

    千次阅读 2019-05-01 22:15:24
    最近LeakCanary做了升级,发布了2.0版本,带了了很多性能上的优化,不过一个很吸引我的点在于,他居然不像以前一样,需要手动初始化了。 按照以前的使用流程,一般我们都是在dependencies 加入依赖 dependencies { ...

    最近LeakCanary做了升级,发布了2.0版本,带了了很多性能上的优化,不过一个很吸引我的点在于,他居然不像以前一样,需要手动初始化了。

    按照以前的使用流程,一般我们都是在dependencies 加入依赖

    dependencies {
      debugImplementation 'com.squareup.leakcanary:leakcanary-android:1.6.3'
      releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:1.6.3'
      // Optional, if you use support library fragments:
      debugImplementation 'com.squareup.leakcanary:leakcanary-support-fragment:1.6.3'
    }	
    

    接着在我们的application里面加入初始化的逻辑。

    public class ExampleApplication extends Application {
    	
    	  @Override public void onCreate() {
    	    super.onCreate();
    	    if (LeakCanary.isInAnalyzerProcess(this)) {
    	      // This process is dedicated to LeakCanary for heap analysis.
    	      // You should not init your app in this process.
    	      return;
    	    }
    	    LeakCanary.install(this);
    	    // Normal app init code...
    	  }
    	}
    

    但是,新版本的 LeakCanary 2.0居然可以不再需要写这个操作,只需要在代码里面加入这么一句依赖就可以了

    dependencies {
      debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-alpha-1'
    }
    

    我有点怀疑自己的眼睛,重新看了下他们的Readme,是不是真的

    Getting started Add LeakCanary to your build.gradle:

    dependencies { debugImplementation com.squareup.leakcanary:leakcanary-android:2.0-alpha-1' }

    You’re good to go! LeakCanary will automatically show a notification when an activity or fragment memory leak is detected in
    your debug build.

    好吧,确实是这样,那么到底怎么做到的?很神奇啊,这怎么也会有一个地方会需要初始化的,到底换到那里去了?

    在经过对源码的解读后,发现了一个骚操作,感觉传开后,以后的sdk库都可能这么做,教坏小朋友了。

    ContentProvider

    在经过对源码的阅读后,发现其实人家是基于CP这个对于绝大数开发来说,基本没用到的四大组件之一来做的,真的是服了哈哈。查看他的leakcanary-leaksentry 模块的AndroidManifest.xml文件,可以看到下面的内容:

    <?xml version="1.0" encoding="utf-8"?>
    <manifest
        xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.squareup.leakcanary.leaksentry"
        >
    
      <application>
        <provider
            android:name="leakcanary.internal.LeakSentryInstaller"
            android:authorities="${applicationId}.leak-sentry-installer"
            android:exported="false"/>
      </application>
    </manifest>
    

    接着我们去看下那LeakSentryInstaller这个类到底做了什么。

    internal class LeakSentryInstaller : ContentProvider() {
    
      override fun onCreate(): Boolean {
        CanaryLog.logger = DefaultCanaryLog()
        val application = context!!.applicationContext as Application
        InternalLeakSentry.install(application)  
        //骚操作在这里,利用系统自动调用CP的onCreate方法来做初始化
        return true
      }
    
      override fun query(
        uri: Uri,
        strings: Array<String>?,
        s: String?,
        strings1: Array<String>?,
        s1: String?
      ): Cursor? {
        return null
      }
    
      override fun getType(uri: Uri): String? {
        return null
      }
    
      override fun insert(
        uri: Uri,
        contentValues: ContentValues?
      ): Uri? {
        return null
      }
    
      override fun delete(
        uri: Uri,
        s: String?,
        strings: Array<String>?
      ): Int {
        return 0
      }
    
      override fun update(
        uri: Uri,
        contentValues: ContentValues?,
        s: String?,
        strings: Array<String>?
      ): Int {
        return 0
      }
    }
    

    我们看到这个CP类,没做任何的CURD操作,全是空的,就纯粹利用系统会回调这个接口来做初始化,帮助开发偷懒,省去调用写初始化逻辑。

    个人看待这个,觉得得分两部门
    好处:确实带来了 "免侵入",不需要业务人员写任何代码。
    坏处:这有点把CP给用歪了。以后所有人都这么弄,接入的sdk都这么写的话,那就真的可爱了。

    ref

    1. https://github.com/square/leakcanary/wiki/Migrating-to-LeakCanary-2.0
    展开全文
  • LeakCanary

    2017-06-20 10:20:31
    一、总结 ...thumbnail?fileGuid=Pk8VCdxhDKv8qkKh)] 总结: 1、在LeakCanary初始化的方法中,我们调用了application的registerActivityLifecycleCallbacks方法,在这里面可以监听到activity的生命周期

    一、总结

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-dPzeaHgC-1611411403417)(https://uploader.shimo.im/f/V9gp69g4D0TNV3Oc.png!thumbnail?fileGuid=Pk8VCdxhDKv8qkKh)]

    总结:

    1、在LeakCanary初始化的方法中,我们调用了application的registerActivityLifecycleCallbacks方法,在这里面可以监听到activity的生命周期。

    在onDestroyed方法中,也就是activity生命结束的时候,我们调用refWatcher.watch(activity),进行内存泄漏的检测。

    2、我们会将当前的activity生成唯一的id添加到集合retainedKeys中。然后将activity进行弱引用。当我们的弱引用对象被垃圾回收的时候,会将它添加到引用队列ReferenceQueue中。也就是引用队列存储着被垃圾回收的对象。

    3、为了保证垃圾回收执行,我们主动调用一次垃圾回收。

    4、遍历引用队列,取出对象生成唯一的key和之前集合的key进行对应,将retainedKeys集合中的数据删除。此时retainedKeys剩余的就是没有被回收的对象。说明发生了内存泄漏。

    5、接下来进行内存泄漏分析,在这里使用了IdleHandler。当 looper 空闲的时候,会回调IdleHandler的 queueIdle 方法。

    6、开启一个类型为IntentService的ForegroundService,在里面会创建通知,告诉用户发生了内存泄漏。点击会跳转到泄漏详情activity。

    二、源码解析

    1、LeakCanary.install()

    public static @NonNull RefWatcher install(@NonNull Application application) {
      return refWatcher(application).listenerServiceClass(DisplayLeakService.class)
          .excludedRefs(AndroidExcludedRefs.createAppDefaults().build())
          .buildAndInstall();
    }
    

    代码解析:
    LeakCanary.install()可以分为四步

    • 1、refWatcher(application):创建AndroidRefWatcherBuilder。并在父类RefWatcherBuilder的构造方法中新建了一个HeapDump的构造器heapDumpBuilder对象。其中HeapDump就是一个保存heap dump信息的数据结构。
    • 2、链式调用listenerServiceClass(DisplayLeakService.class):(1)传入了一个DisplayLeakService的Class对象,它的作用是展示泄露分析的结果日志,然后会展示一个用于跳转到显示泄露界面DisplayLeakActivity的通知;(2)在listenerServiceClass()这个方法中新建了一个ServiceHeapDumpListener对象。
    • 链式调用excludedRefs(AndroidExcludedRefs.createAppDefaults().build())
    • 链式调用buildAndInstall():(1)创建activityRefWatcher实例(2)调用了application的registerActivityLifecycleCallbacks()方法,这样就能够监听activity对应的生命周期事件了。(3)在ActivityLifecycleCallbacks重写了onActivityDestroyed()方法,这样便能在所有Activity执行完onDestroyed()方法之后调用 refWatcher.watch(activity)这行代码进行内存泄漏的检测了。
    • 接下来重点到了当Activity执行完onDestroyed()方法之后,会调用refWatcher.watch(activity)

    2、refWatcher.watch(activity)

    ->watch(watchedReference, "")
    public void watch(Object watchedReference, String referenceName) {
       、、、省略部分代码
       //1、使用随机的UUID保证了每个检测对象对应 key 的唯一性。
      String key = UUID.randomUUID().toString();
       //2、将生成的key添加到类型为CopyOnWriteArraySet的Set集合中
      retainedKeys.add(key);
      //3、创建自定义的弱引用KeyedWeakReference
      final KeyedWeakReference reference =
          new KeyedWeakReference(watchedReference, key, referenceName, queue);
      //4、调用ensureGoneAsync
      ensureGoneAsync(watchStartNanoTime, reference);
    }
    

    1)弱引用KeyedWeakReference

    KeyedWeakReference继承自WeakReference,在它的构造方法中将watchedReference和ReferenceQueue关联,如果弱引用watchedReference持有的对象被GC回收,JVM就会把这个弱引用加入到与之关联的引用队列ReferenceQueue中。即 :KeyedWeakReference 持有的 Activity 对象如果被GC回收,该对象就会加入到引用队列 referenceQueue 中。

    //1、在watch方法里创建reference,参数里的
    queue=new ReferenceQueue<>()
    final KeyedWeakReference reference =
        new KeyedWeakReference(watchedReference, key, referenceName, queue);
    

    2)ensureGoneAsync

    • 1、执行watchExecutor的execute方法。watchExecutor就是AndroidWatchExecutor。
    • 在execute方法中执行waitForIdle方法。
    • 2、在waitForIdle使用了MessageQueue.IdleHandler(),当 looper 空闲的时候,会回调IdleHandler的 queueIdle 方法,利用这个机制我们可以实现第三方库的延迟初始化,然后执行内部的postToBackgroundWithDelay()方法。
    • 3、postToBackgroundWithDelay()方法会执行RefWatcher#ensureGone()
    ensureGoneAsync(watchStartNanoTime, reference);
    private void ensureGoneAsync() {
      watchExecutor.execute(new Retryable() {
        @Override public Retryable.Result run() {
          return ensureGone(reference, watchStartNanoTime);
        }
      });
    }
    

    3)RefWatcher#ensureGone()

    Retryable.Result ensureGone(final KeyedWeakReference reference, final long watchStartNanoTime) {
       //reference 被回收的时候,会被加进 referenceQueue队列中。此时referenceQueue就存储着已经被回收的引用。
       //1、接下来while循环遍历 ReferenceQueue,从里面取出已经被回收的reference,并从 retainedKeys中移除对应的Reference的key。
      removeWeaklyReachableReferences();
      //2、判断 retainedKeys 集合中是否还含有 reference的key,若没有,证明已经被回收了。若含有,可能已经发生内存泄露(或Gc还没有执行回收)。
      if (gone(reference)) {
        return DONE;
      }
      //3、gcTrigger的runGc()方法进行垃圾回收
      gcTrigger.runGc();
      //4、再次执行removeWeaklyReachableReferences方法移除已经被回收的引用
      removeWeaklyReachableReferences();
      //5、再次判断retainedKeys 集合中是否还含有 reference的key,如果此时包含。说明发生了内存泄漏。
      if (!gone(reference)) {
        //6、调用堆信息转储者heapDumper的dumpHeap()生成相应的 hprof 文件。这里的heapDumper是一个HeapDumper接口,具体的实现是AndroidHeapDumper。
        File heapDumpFile = heapDumper.dumpHeap();
        //7、创建heapDump对象
        HeapDump heapDump = heapDumpBuilder.heapDumpFile(heapDumpFile).referenceKey(reference.key)
            .referenceName(reference.name)
            .watchDurationMs(watchDurationMs)
            .gcDurationMs(gcDurationMs)
            .heapDumpDurationMs(heapDumpDurationMs)
            .build();
         //8、执行heapdumpListener的analyze()对新创建的HeapDump对象进行泄漏分析。
        heapdumpListener.analyze(heapDump);
      }
      return DONE;
    }
    

    补充:gcTrigger.runGc()垃圾回收

    @Override public void runGc() {
      Runtime.getRuntime().gc();
      enqueueReferences();
      System.runFinalization();
    }
    

    解析:这里并没有使用System.gc()方法进行回收,因为system.gc()并不会每次都执行。而是调用Runtime.getRuntime().gc(),相比System.gc()更能够保证垃圾回收的工作。

    ❌4)File heapDumpFile = heapDumper.dumpHeap();

    生成heapDumpFile泄漏文件

    这里的核心操作就是调用了Android SDK的API Debug.dumpHprofData() 来生成 hprof 文件

    public File dumpHeap() {
      File heapDumpFile = leakDirectoryProvider.newHeapDumpFile();
      if (heapDumpFile == RETRY_LATER) {
        return RETRY_LATER;
      }
      FutureResult<Toast> waitingForToast = new FutureResult<>();
      showToast(waitingForToast);
      if (!waitingForToast.wait(5, SECONDS)) {
        CanaryLog.d("Did not dump heap, too much time waiting for Toast.");
        return RETRY_LATER;
      }
      Notification.Builder builder = new Notification.Builder(context)
          .setContentTitle(context.getString(R.string.leak_canary_notification_dumping));
      Notification notification = LeakCanaryInternals.buildNotification(context, builder);
      NotificationManager notificationManager =
          (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
      int notificationId = (int) SystemClock.uptimeMillis();
      notificationManager.notify(notificationId, notification);
      Toast toast = waitingForToast.get();
      try {
        Debug.dumpHprofData(heapDumpFile.getAbsolutePath());
        cancelToast(toast);
        notificationManager.cancel(notificationId);
        return heapDumpFile;
      } catch (Exception e) {
        CanaryLog.d(e, "Could not dump heap");
        // Abort heap dump
        return RETRY_LATER;
      }
    }
    

    5)heapdumpListener.analyze(heapDump);

    1、heapdumpListener的实现者是ServiceHeapDumpListener,执行analyze方法。

    @Override public void analyze(@NonNull HeapDump heapDump) {
      checkNotNull(heapDump, "heapDump");
      HeapAnalyzerService.runAnalysis(context, heapDump, listenerServiceClass);
    }
    

    2、开启了HeapAnalyzerService。HeapAnalyzerService是一个类型为IntentService的ForegroundService,并且这个服务在单独的进程中运行,为了避免降低app进程的性能或占用内存。
    3、执行startForegroundService()之后,会回调onHandleIntentInForeground()方法。

    6)调用HeapAnalyzerService的onHandleIntentInForeground方法

    @Override protected void onHandleIntentInForeground(@Nullable Intent intent) {
     //1、创建heapAnalyzer对象
      HeapAnalyzer heapAnalyzer =
          new HeapAnalyzer(heapDump.excludedRefs, this, heapDump.reachabilityInspectorClasses);
    //2、解析 hprof文件
      AnalysisResult result = heapAnalyzer.checkForLeak(heapDump.heapDumpFile, heapDump.referenceKey,
          heapDump.computeRetainedHeapSize);
     //3、创建一个由PendingIntent构建的泄漏通知用于供用户点击去展示详细的泄漏界面DisplayLeakActivity。即创建一个供用户点击跳转到DisplayLeakActivity的延时通知
      AbstractAnalysisResultService.sendResultToListener(this, listenerClassName, heapDump, result);
    }
    

    2、解析 hprof文件->checkForLeak方法

    /**
     * 在堆转储中搜索具有相应键的实例,然后计算从该实例到GC根的最短强引用路径。
     */
    public @NonNull AnalysisResult checkForLeak() {
       、、、
        //1、新建一个内存映射缓存文件buffer
        HprofBuffer buffer = new MemoryMappedFileBuffer(heapDumpFile);
        //2、使用buffer新建一个HprofParser解析器去解析出对应的引用内存快照文件snapshot
        HprofParser parser = new HprofParser(buffer);
         、、、
        //3、为了减少在Android 6.0版本中重复GCRoots带来的内存压力的影响,使用deduplicateGcRoots()删除了gcRoots中重复的根对象RootObj。
        deduplicateGcRoots(snapshot);
        listener.onProgressUpdate(FINDING_LEAKING_REF);
        //4、调用了findLeakingReference()方法将传入的referenceKey和snapshot对象里面所有类实例的字段值对应的keyCandidate进行比较,如果没有相等的,则表示没有发生内存泄漏
        Instance leakingRef = findLeakingReference(referenceKey, snapshot);
        、、、
        //回一个有泄漏分析结果的AnalysisResult对象
        return findLeakTrace(analysisStartNanoTime, snapshot, leakingRef, computeRetainedSize);
       、、、
    }
    

    3、展示泄漏路径信息的DisplayLeakService对象

    AbstractAnalysisResultService.sendResultToListener(this, listenerClassName, heapDump, result);
    

    解析:
    AbstractAnalysisResultService的实现类DisplayLeakService对象。在里面直接创建一个由PendingIntent构建的泄漏通知用于供用户点击去展示详细的泄漏界面DisplayLeakActivity。

    即创建一个供用户点击跳转到DisplayLeakActivity的延时通知

    //创建通知PendingIntent
    PendingIntent pendingIntent =
        DisplayLeakActivity.createPendingIntent(this, heapDump.referenceKey);
    
    展开全文
  • LeakCanary实现原理简析

    2021-01-11 21:13:59
    LeakCanary初始化1.1 在ContentProvider中初始化LeakCanary1.2 初始化默认观察器1.3 跟踪观察被销毁的对象2. 观察对象的存活状态3. 分析泄漏对象4. 其它 原理这两个字,会让人觉得太深奥,其实只是简单了解下。 ...
  • LeakCanary核心机制学习

    2021-04-24 15:03:40
    read the fucking source code 前言 本文不包含分析LeakCanary所使用的haha库的代码. LeakCanary 官网 本文基于:leakcanary-android:2.7 简单的使用仅是一句话,...LeakCanary初始化分析 上图便是leakCanary工程目录,而
  • LeakCanary 2.7 原理分析

    2021-06-16 15:07:29
    我们直接引入依赖即可,无需代码初始化LeakCanary 会在 app 初始化时自动初始化自身。 debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.7' Application->attachBaseContext =====> ...
  • 最近 LeakCanary做了升级,发布了2.0版本,带了了很多性能上的优化,不过一个很吸引我的点在于,他居然不像以前一样,需要手动初始化了。按照以前的使用流程,一般我们都是在dependencies 加入依赖dependencies {...
  • 一般我们在 Application 的 onCreate 中进行初始化操作。此时推荐一个小技巧:借助 ContentProvider 实现完全"无侵"的初始化, 让 SDK 更加易用。 ContentProvider 初始化原理 ContentProvider 的 onCreate 的调用...
  • LeakCanary简单分析

    2020-12-13 11:31:25
    在使用LeakCanary的时候要引入: debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.4' ...LeakCanary初始化是利用ContentProvider进行初始化的, <provider android:name="le..
  • 很多第三方框架或SDK都会有个初始化操作,比如在Application的onCreate中调用XXX.init(),最近学习了LeakCanary的做法,就不再需要手动初始化了,那么自动初始化该怎么做呢? 首先定义一个InitProvider,它是继承于...
  • LeakCanary 原理分析

    2020-09-20 10:53:16
    LeakCanary初始化 LeakCanary2.3的引入: debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.3' 2.3版本无需在Application中做额外操作。 深入了解一下具体是如何初始化的,我的是2.3版本的,...
  • LeakCanary笔记

    千次阅读 2017-03-30 19:45:44
    初始化LeakCanary.install(application); 返回一个 RefWatcher 对象,用于跟踪对象是否被回收ActivityRefWatcherRefWatcher 的代理类。通过注册 ActivityLifecycleCallbacks 回调,当 Activity 调用 onDestroy() 时...
  • 初始化注册 引用泄漏观察 Dump Heap EventBus 自定义注解 注册订阅者 发送事件 LeakCanary 初始化注册 在清单文件中注册了一个 ContentProvider 用于在应用启动时初始化代码: leakcanary-leaksentry/*/...
  • LeakCanary学习

    2016-12-04 11:08:19
    LeakCanary学习
  • 那么有些操作需要在application中初始化的工作我们完全可以放到ContentProvider中处理,leakCanary2.0就是这么做的,把 init 的逻辑放到库内部,让调用方完全不需要在 Application 里去进行初始化了,十分方便。...
  • 集成leakcanary

    2020-06-05 17:20:52
    简单集成leakcanary,记录下来,方便后期项目中直接使用地址导入依赖添加权限Application中初始化监听服务LeakService清单文件中注册监听服务 地址 github地址 官方地址 导入依赖 debugImplementation '...
  • 文章目录非侵入试获取Context进行SDK初始化picasso 初始化InstantRunLeakcanaryApp Startup 非侵入试获取Context进行SDK初始化 当我们在使用第三方SDK,或者自己进行SDK封装时,如果需要需要用到 Context 进行初始化...
  • LeakCanary的用法

    千次阅读 2017-04-20 22:46:55
    1、添加依赖 debugCompile '...releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.3'2、Application中初始化leakcanary //在自己的Application中添加如下代码 public
  • LeakCanary原理分析

    千次阅读 2018-11-03 21:38:04
    概述 在上一篇LeakCanary使用详细教程中,我们熟悉了LeakCanary的使用和初步描述了...从上一篇中我们知道,LeakCanary在Appaction的初始化方式: @Override public void onCreate() { super.onCreate(); if (LeakC...
  • LeakCanary 和 BlockCanary

    2018-04-18 14:34:20
    LeakCanary 和 BlockCanary 初始化和依赖都要放到主工程中,不要放到library 中
  • leakcanary1.5源码分析

    2019-06-09 19:21:02
    内存泄漏检测工具,square公司出品,github地址https://github.com/square/leakcanary。 gradle引用: debugCompile 'com.squareup.leakcanary:leakcanary-android:1.5' releaseCompile '...
  • LeakCanary源码分析

    2018-08-05 17:34:36
    LeakCanary是用来检测Android内存泄漏的工具。 在gradlew文件中引入: dependencies { debugCompile 'com.squareup.leakcanary:leakcanary-android:1.5.4' releaseCompile '...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 2,892
精华内容 1,156
关键字:

leakcanary初始化