LeakCanary 内存泄漏监测性能优化简介原理

Posted 2021-01-09 baiqiantao

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了LeakCanary 内存泄漏监测性能优化简介原理相关的知识，希望对你有一定的参考价值。

LeakCanary 内存泄漏监测性能优化简介原理
GitHub：https://github.com/square/leakcanary
Demo地址：https://github.com/baiqiantao/LeakCanaryTest.git

简单使用

A memory leak detection 内存泄露检测 library for android and Java.

A small leak will sink a great ship. -- Benjamin Franklin
千里之堤，毁于蚁穴。 -- 《韩非子·喻老》

添加依赖:

dependencies {
  debugImplementation ‘com.squareup.leakcanary:leakcanary-android:1.6.1‘
  debugImplementation ‘com.squareup.leakcanary:leakcanary-support-fragment:1.6.1‘ //当使用support库时添加
  releaseImplementation ‘com.squareup.leakcanary:leakcanary-android-no-op:1.6.1‘ //发布时用的是无任何操作的版本
}

初始化:

LeakCanary.install(application);

配置完以后，在 debug 构建的版本中，如果检测到某个 activity 或 fragment 有内存泄露，LeakCanary 就会自动地显示一个通知。

自定义 LeakCanary

技术分享图片

如何观察具有生命周期的对象

在您的应用程序中，您可能有其他具有生命周期的对象，例如Fragment，Service，Dagger组件等。可以使用RefWatcher来监视应该进行垃圾回收的实例：refWatcher.watch(schrodingerCat);
使用 no-op 依赖

release 版本的leakcanary-android-no-op依赖项仅包含LeakCanary和RefWatcher类。如果您要自定义LeakCanary，您需要确保自定义仅出现在 debug 版本中，因为它可能会引用leakcanary-android-no-op依赖项中不存在的类。
自定义图标和标签

DisplayLeakActivity附带了一个默认图标和标签，您可以通过在应用中提供R.mipmap.leak_canary_icon和R.string.leak_canary_display_activity_label来更改它：
install 方法的默认逻辑

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

不监测特定的Activity
默认情况下，LeakCanary会监视所有的Activity。您可以自定义 installation steps 以执行不同的操作，例如忽略某种类型Activity的泄漏：

RefWatcher refWatcher = LeakCanary.refWatcher(this)
      .watchActivities(false)
      .buildAndInstall();

registerActivityLifecycleCallbacks(new ActivityLifecycleCallbacks() {
   @Override
   public void onActivityDestroyed(Activity activity) {
      if (activity instanceof IgnoreActivity) {
         return;
      }
      refWatcher.watch(activity);
   }
   //...
});

在运行时打开和关闭 LeakCanary

refWatcher = LeakCanary.refWatcher(this)
      .heapDumper(getHeapDumper()) //在运行时开启和关闭LeakCanary
      .buildAndInstall();

public TogglableHeapDumper getHeapDumper() {
 if (heapDumper == null) {
  LeakDirectoryProvider leakDirectoryProvider = LeakCanaryInternals.getLeakDirectoryProvider(this);
  AndroidHeapDumper defaultDumper = new AndroidHeapDumper(this, leakDirectoryProvider);
  heapDumper = new TogglableHeapDumper(defaultDumper);
 }
 return heapDumper;
}

public class TogglableHeapDumper implements HeapDumper {
 private final HeapDumper defaultDumper;
 private boolean enabled = true;

 public TogglableHeapDumper(HeapDumper defaultDumper) {
  this.defaultDumper = defaultDumper;
 }

 public void setEnabled(boolean enabled) {
  this.enabled = enabled;
 }

 @Override
 public File dumpHeap() {
  return enabled ? defaultDumper.dumpHeap() : HeapDumper.RETRY_LATER;
 }
}

MyApplication.app().getHeapDumper().setEnabled(false);

测试案例

Application

public class MyApplication extends Application {
 private RefWatcher refWatcher;
 private static MyApplication app;
 private TogglableHeapDumper heapDumper;

 @Override
 public void onCreate() {
  super.onCreate();
  if (LeakCanary.isInAnalyzerProcess(this)) {
   Log.i("bqt", "此进程是专用于LeakCanary进行堆分析用的。您不应该在此进程中初始化您的应用。");
   return;
  }

  refWatcher = LeakCanary.refWatcher(this)
    .watchActivities(true) //默认为true，会监视所有Activity，你可以设置为false然后再指定要监测的Activity
    .watchFragments(true) //默认为true，会监视 native Fragment，如果添加了support依赖，则也会监视support中的Fragment
    .watchDelay(1, TimeUnit.SECONDS) //设置应该等待多长时间，直到它检查跟踪对象是否已被垃圾回收
    .maxStoredHeapDumps(7) //设置LeakCanary最多可以保存的 heap dumps 个数，默认为7
    .excludedRefs(getExcludedRefs()) //忽略特定的引用，这个垃圾东西设置后总是不生效
    .heapDumper(getHeapDumper()) //在运行时开启和关闭LeakCanary
    //.listenerServiceClass() //可以更改默认行为以将 leak trace 和 heap dump 上载到您选择的服务器。
    .buildAndInstall();
  app = this;
 }

 private ExcludedRefs getExcludedRefs() {
  return AndroidExcludedRefs.createAppDefaults()//经过大量测试，我感觉TMD完全忽略不了Activity和Fragment中内存泄漏
    .instanceField("com.bqt.test.Single", "imageView") //类名，字段名
    .staticField("com.bqt.test.StaticLeakActivity", "bitmap") //类名，静态字段名
    .clazz("com.bqt.test.StaticLeakActivity") //忽略提供的类名的所有子类的所有字段和静态字段
    .thread("Thread-10086") //忽略指定的线程，一般主线程名为【main】，子线程名为【Thread-整数】
    .build(); //忽略的引用如果又通过watch手动监测了，则仍会监测其内存泄漏情况
 }

 public static MyApplication app() {
  return app;
 }

 public RefWatcher getRefWatcher() {
  return refWatcher;
 }

 public TogglableHeapDumper getHeapDumper() {
  if (heapDumper == null) {
   LeakDirectoryProvider leakDirectoryProvider = LeakCanaryInternals.getLeakDirectoryProvider(this);
   AndroidHeapDumper defaultDumper = new AndroidHeapDumper(this, leakDirectoryProvider);
   heapDumper = new TogglableHeapDumper(defaultDumper);
  }
  return heapDumper;
 }
}

MainActivity

public class MainActivity extends FragmentActivity implements AdapterView.OnItemClickListener {
 private FrameLayout frameLayout;

 @Override
 protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  ListView listView = new ListView(this);
  String[] array = {"静态成员导致的内存泄漏",
    "单例导致的内存泄漏：Fragment",
    "禁用 LeakCanary",
    "",};
  listView.setAdapter(new ArrayAdapter<>(this, android.R.layout.simple_list_item_1, Arrays.asList(array)));
  listView.setOnItemClickListener(this);
  frameLayout = new FrameLayout(this);
  frameLayout.setId(R.id.fragment_id);
  listView.addFooterView(frameLayout);
  setContentView(listView);
 }

 @Override
 public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
  switch (position) {
   case 0:
    startActivity(new Intent(this, StaticLeakActivity.class));
    break;
   case 1:
    getSupportFragmentManager().beginTransaction()
      .add(frameLayout.getId(), new SingleLeakFragment(), "SingleLeakFragment")
      .commit();
    break;
   case 2:
    MyApplication.app().getHeapDumper().setEnabled(false);
    break;
   default:
    break;
  }
 }
}

静态成员导致的内存泄漏

public class StaticLeakActivity extends Activity {
 private static Bitmap bitmap;

 @Override
 protected void onCreate(@Nullable Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  ImageView imageView = new ImageView(this);
  bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.icon);
  imageView.setImageBitmap(bitmap);
  setContentView(imageView);
 }
}

技术分享图片

单例导致的内存泄漏

public class SingleLeakFragment extends Fragment {
 private ImageView imageView;

 @Nullable
 @Override
 public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
  imageView = new ImageView(getContext());
  return imageView;
 }

 @Override
 public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
  super.onViewCreated(view, savedInstanceState);
  imageView.setImageResource(R.drawable.icon);
  Single.SINGLETON.setImageView(imageView);//单例中引用View同样会导致Activity内存泄漏
 }
}

public enum Single {
 @SuppressLint("StaticFieldLeak")
 SINGLETON; //定义一个枚举的元素，它就代表了Single的一个实例
 private ImageView imageView;

 public void setImageView(ImageView imageView) {
  this.imageView = imageView;
 }
}

技术分享图片

LeakCanary 内存泄漏监测性能优化简介原理

目录

简单使用

更多介绍

自定义 LeakCanary

测试案例

Application

MainActivity

静态成员导致的内存泄漏

单例导致的内存泄漏

LeakCanary 内存泄漏 监测 性能优化 简介 原理

目录

简单使用

更多介绍

自定义 LeakCanary

测试案例

Application

MainActivity

静态成员导致的内存泄漏

单例导致的内存泄漏

LeakCanary 内存泄漏监测性能优化简介原理