LeakCanary2的免写 初始化代码 原理

最近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文件，可以看到下面的内容：

接着我们去看下那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?,
    s: String?,
    strings1: Array?,
    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?
  ): Int {
    return 0
  }

  override fun update(
    uri: Uri,
    contentValues: ContentValues?,
    s: String?,
    strings: Array?
  ): Int {
    return 0
  }
}

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

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

ref

1. https://github.com/square/leakcanary/wiki/Migrating-to-LeakCanary-2.0