Android内存泄漏 ——检测、解决和避免
albertq7f3
9年前
<p>作为开发人员，在我们的日常开发中，为了构建更好的应用程序，我们需要考虑很多事情以保证应用运行在正轨上，其中之一是要确保我们的应用程序不会崩溃。应用崩溃的一个常见原因是内存泄漏。这方面的问题可以以各种形式表现出来。在大多数情况下，我们看到内存使用率稳步上升，直到应用程序不能分配更多的资源，并不可避免地崩溃。在Java中这往往导致一个<strong>OutOfMemoryException异常</strong>被抛出。在某些罕见的情况下，泄露的类甚至可以逗留很长时间来接收已注册的回调，这会导致一些非常奇怪的错误，并往往抛出臭名昭著的<strong>IllegalStateException异常</strong>。</p> <p>为了帮助他人在代码分析上减少花费时间，我将介绍内存泄漏的几个例子，阐述在Android Studio中如何检查它们，当然最重要的是如何将其解决。</p> <h2>声明</h2> <p>在这篇文章中的代码示例的目的是为了促进大家对内存管理有更深的了解，特别是在java。其通用的体系结构，线程管理和代码示例的 HTTP 请求处理在真实的生产环境并不是理想的，这些示例仅仅为了说明一个问题：在Android中，内存泄漏是一件要考虑的事情。</p> <h2>监听器注册</h2> <p>这真的不应该是个问题，但我经常看到各种注册方法的调用，但他们对应的注销方法却无处可寻。这是泄漏的潜在来源，因为这些方法明确设计成互相抵消。如果没有调用注销方法，被引用的对象已经被终止后，监听实例可能会持有该对象很长的时间，从而导致泄漏内存。在Android中，如果该对象是一个Activity对象，是特别麻烦的，因为他们往往拥有大量的数据。让我告诉你，可能是什么样子。</p> <pre> <code class="language-java">public class LeaksActivity extends Activity implements LocationListener { private LocationManager locationManager; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_leaks); locationManager = (LocationManager) getSystemService(LOCATION_SERVICE); locationManager.requestLocationUpdates(LocationManager.NETWORK_PROVIDER, TimeUnit.MINUTES.toMillis(5), 100, this); } // Listener implementation omitted }</code></pre> <p>在这个例子中，我们让Android的 <a href="/misc/goto?guid=4959675104526565918"><strong>LocationManager</strong></a>通知我们位置更新。我们所需要做的就是获取系统服务本身和设置一个回调来接收更新。在这里，我们在Activity中实现了位置监听接口，这意味着<strong>LocationManager</strong>将持有该Activity的引用。现在，如果该设备被旋转，新的Activity将被创建并取代已经注册位置更新接口的旧的Activity。由于系统服务存活时间肯定比任何Activity都要长，<strong>LocationManager</strong>仍然持有以前的Activity的引用，这使GC不可能回收依赖于以前的Activity的资源，从而导致内存泄漏。如果反复旋转设备，将导致大量的不可回收的Activity填满内存，最终导致<strong>OutOfMemoryException异常</strong>。</p> <p>但为了解决内存泄漏，我们首先必须要能够找到它。幸运的是，<strong>Android Studio</strong>有一个叫做 <strong>Android Monitor</strong>的内置工具，我们可以用它来 观察除应用内存使用情况。我们需要做的仅仅是打开Android Monitor 并转到对应tab，看看使用了多少内存和内存实时分配情况。</p> <p><img alt="Android内存泄漏 ——检测、解决和避免" src="https://simg.open-open.com/show/8b15e0f4b8a9b43e06bfa952f9b155fe.png"></p> <p>任何导致资源分配的交互都在这里反映出来，使之成为跟踪应用程序的资源使用情况的理想场所。为了找到内存泄露，当我们怀疑在某个时间点内存被泄露时，我们需要知道在该时间点包含了那些内存。对于这个特殊的例子，我们所要做的就是启动我们的应用程序，然后旋转设备一次，然后调用<strong>Dump Java Heap</strong>操作（在<strong>Memory</strong>的旁边，从左边数起第三个图标）。这将生成一个<strong>HPROF</strong>文件，其中包含我们调用该操作时的一个内存快照。几秒钟后，Android Studio 会自动打开该文件，给我们更易于分析内存的直观表示。</p> <p>我不会去深入有关如何分析巨大的内存堆。相反，我会把你的注意力引导到 <strong>Analyzer Tasks</strong>（下面截图中的右上角）。为了检测上面的例子中引入的内存泄漏，你所需要做的检测是检查泄露的Activity（<strong>Detect Leaked Activities</strong>），点击播放按钮然后在<strong>Analysis Results</strong>下面就会显示泄露的Activity情况。</p> <p><img alt="Android内存泄漏 ——检测、解决和避免" src="https://simg.open-open.com/show/3912e5572266e9b21ccf0f21ee7ca191.png"></p> <p>如果我们选中泄露的Activity，可以得到一个引用树，该引用树可以检测持有该Activity的引用。通过寻找深度为零的实例，我们发现位置管理器中的实例<strong>mListener</strong>，是我们的Activity不能被GC回收的原因。回到我们的代码，我们可以看到，这个引用是由于我们在<strong>requestLocationsUpdates</strong>方法中设置Activity作为位置更新回调导致的。通过阅读<a href="/misc/goto?guid=4959675104526565918">位置管理器文档</a>，问题很快变得清晰，为了取消回调设置，我们简单地调用<strong>removeUpdates</strong>方法就行了。在我们的例子，因为我们注册更新是在<strong>onCreate</strong>方法，显然要注销的地方在<strong>onDestroy</strong>方法。</p> <pre> <code class="language-java">public class LeaksActivity extends Activity implements LocationListener { private LocationManager locationManager; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_leaks); locationManager = (LocationManager) getSystemService(LOCATION_SERVICE); locationManager.requestLocationUpdates(LocationManager.NETWORK_PROVIDER, TimeUnit.MINUTES.toMillis(5), 100, this); } @Override protected void onDestroy() { locationManager.removeUpdates(this); super.onDestroy(); } // Listener implementation omitted }</code></pre> <p>重新构建程序并执行与上述相同的内存分析，无论旋转多少次设备，应该都不会导致Activity泄漏。</p> <h2>内部类</h2> <p>内部类在Java中是一个很常见的数据结构。它们很受欢迎，因为它们可以以这样的方式来定义：即只有外部类可以实例化它们。很多人可能没有意识到的是这样的类会持有外部类的隐式引用。隐式引用很容易出错，尤其是当两个类具有不同的生命周期。以下是常见的Android Activity写法。</p> <pre> <code class="language-java">public class AsyncActivity extends Activity { TextView textView; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_async); textView = (TextView) findViewById(R.id.textView); new BackgroundTask().execute(); } private class BackgroundTask extends AsyncTask<Void, Void, String> { @Override protected String doInBackground(Void... params) { // Do background work. Code omitted. return "some string"; } @Override protected void onPostExecute(String result) { textView.setText(result); } } }</code></pre> <p>这种特殊的实现在执行上没有问题。问题是，它保留内存的时间肯定会超过必要的时间。由于<strong>BackgroundTask</strong>持有一个<strong>AsyncActivity</strong>隐式引用并运行在另一个没有取消策略的线程上，它将保留AsyncActivity在内存中的所有资源连接，直到后台线程终止运行。在HTTP请求的情况下，这可能需要很长的时间，尤其是在速度较慢的连接。</p> <p>通过执行相同的步骤，如同前面的示例，并确保长时间运行的后台任务，我们最终会得到下面的分析结果。</p> <p><img alt="Android内存泄漏 ——检测、解决和避免" src="https://simg.open-open.com/show/53f583dbd96340121fdae122de1b764b.png"></p> <p>从上面的分析中可以看出，<strong>BackgroundTask</strong> 确实是这种内存泄漏的罪魁祸首。我们第一要务是使用静态类的实现方式来消除指向Activity的引用，但这样我们也不能直接访问 textView 了。因此我们还需要添加一个构造函数，把textView作为参数传递进来。最后，我们需要引入<a href="/misc/goto?guid=4959553655931252883">AsyncTask文档</a>中所述的取消策略。考虑到所有这一切，让我们看看我们的代码最终呈现。</p> <pre> <code class="language-java">public class AsyncActivity extends Activity { TextView textView; AsyncTask task; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_async); textView = (TextView) findViewById(R.id.textView); task = new BackgroundTask(textView).execute(); } @Override protected void onDestroy() { task.cancel(true); super.onDestroy(); } private static class BackgroundTask extends AsyncTask<Void, Void, String> { private final TextView resultTextView; public BackgroundTask(TextView resultTextView) { this.resultTextView = resultTextView; } @Override protected void onCancelled() { // Cancel task. Code omitted. } @Override protected String doInBackground(Void... params) { // Do background work. Code omitted. return "some string"; } @Override protected void onPostExecute(String result) { resultTextView.setText(result); } } }</code></pre> <p>现在，隐式引用已被消除，我们通过构造函数传递相关实例，并在合适的地方取消任务。让我们再运行分析任务，看看这种改变是否消除了内存泄漏。</p> <p><img alt="Android内存泄漏 ——检测、解决和避免" src="https://simg.open-open.com/show/8f4c00c7273f81364fbe82077142663c.png"></p> <p>看来我们还有一些工作要做。根据前一个例子的经验，我们可以知道在引用树中高亮标注的实例导致了Activity泄露。那么这是什么回事？我们看一下它的父节点就可以发现resultTextView持有一个<strong>mContext</strong>引用，毫无疑问，它就是泄露的Activity的引用。那么如何解决这个问题？我们无法消除resultTextView绑定的context引用，因为我们需要在<strong>BackgroundTask</strong>中使用resultTextView的引用，以便更新用户界面。为了解决这个问题，一种简单的方法是使用<a href="/misc/goto?guid=4959675104661054282"><strong>WeakReference</strong></a>。我们持有的<strong>resultTextView</strong>引用是强引用，具有防止GC回收的能力。相反，<strong>WeakReference</strong>不保证其引用的实例存活。当一个实例最后一个强引用被删除，GC会把其资源回收，而不管这个实例是否有弱引用。下面是使用WeakReference的最终版本：</p> <pre> <code class="language-java">public class AsyncActivity extends Activity { TextView textView; AsyncTask task; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_async); textView = (TextView) findViewById(R.id.textView); task = new BackgroundTask(textView).execute(); } @Override protected void onDestroy() { task.cancel(true); super.onDestroy(); } private static class BackgroundTask extends AsyncTask<Void, Void, String> { private final WeakReference<TextView> textViewReference; public BackgroundTask(TextView resultTextView) { this.textViewReference = new WeakReference<>(resultTextView); } @Override protected void onCancelled() { // Cancel task. Code omitted. } @Override protected String doInBackground(Void... params) { // Do background work. Code omitted. return "some string"; } @Override protected void onPostExecute(String result) { TextView view = textViewReference.get(); if (view != null) { view.setText(result); } } } }</code></pre> <p>请注意，在<strong>onPostExecute</strong>我们要检查空值，判断实例是否被回收。</p> <p>最后，再一次运行分析器任务，确认我们的Activity不再被泄露 ！</p> <h2>匿名类</h2> <p>这种类型的类和内部类有同样的缺点，即他们持有外部类的引用。如同内部类，一个匿名类在Activity生命周期之外执行或在其他线程执行工作时，可能会导致内存泄漏。在这个例子中，我将使用流行的HTTP请求库<a href="/misc/goto?guid=4958837204152834453">Retrofit</a>执行API调用，并传递响应给对应回调。根据<a href="/misc/goto?guid=4958837204152834453">Retrofit homepage</a>上面例子对Retrofit进行配置。我会在Application中持有<strong>GitHubService</strong>引用，这不是一个特别好的设计，这仅仅服务于这个例子的目的。</p> <pre> <code class="language-java">public class ListenerActivity extends Activity { TextView textView; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_listener); textView = (TextView) findViewById(R.id.textView); GitHubService service = ((LeaksApplication) getApplication()).getService(); service.listRepos("google") .enqueue(new Callback<List<Repo>>() { @Override public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) { int numberOfRepos = response.body().size(); textView.setText(String.valueOf(numberOfRepos)); } @Override public void onFailure(Call<List<Repo>> call, Throwable t) { // Code omitted. } }); } }</code></pre> <p>这是常见的解决方案，不应该导致任何泄漏。但是，如果我们在慢速连接中执行这个例子，分析结果会有所不同。请记住，直到该线程终止，该Activity会一直被持有，就像在内部类的例子。</p> <p><img alt="Android内存泄漏 ——检测、解决和避免" src="https://simg.open-open.com/show/c53f8eb75dd14957148e748a48f1e825.png"></p> <p>根据在内部类的例子中同样的推理，我们得出一个结论：匿名回调类是内存泄漏的原因。然而，正如内部类的例子，此代码包含两个问题。首先，请求没有取消策略。其次，需要消除对Activity的隐式引用。明显的解决办法：我们在内部类的例子做了同样的事情。</p> <pre> <code class="language-java">public class ListenerActivity extends Activity { TextView textView; Call call; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_listener); textView = (TextView) findViewById(R.id.textView); GitHubService service = ((LeaksApplication) getApplication()).getService(); call = service.listRepos("google"); call.enqueue(new RepoCallback(textView)); } @Override protected void onDestroy() { call.cancel(); super.onDestroy(); } private static class RepoCallback implements Callback<List<Repo>> { private final WeakReference<TextView> resultTextView; public RepoCallback(TextView resultTextView) { this.resultTextView = new WeakReference<>(resultTextView); } @Override public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) { TextView view = resultTextView.get(); if (view != null) { int numberOfRepos = response.body().size(); view.setText(String.valueOf(numberOfRepos)); } } @Override public void onFailure(Call<List<Repo>> call, Throwable t) { // Code omitted. } } }</code></pre> <p>根据上述解决方案，运行分析任务，将不会再有Activity的泄露。</p> <h2>结论</h2> <p>后台任务独立于Activity的生命周期运行是一件麻烦事。再加上需要协调用户界面和各种后台任务之间的数据流，如果你不小心，那将是一个灾难。所以要知道你在做什么，以及你的代码是否对性能有影响。这些基本准则是处理Activity的良好开端：</p> <ul> <li><strong>尽量使用静态内部类。</strong>每个非静态内部类将持有一个外部类的隐式引用，这可能会导致不必要的问题。使用静态内部类代替非静态内部类，并通过弱引用存储一些必要的生命周期引用。</li> <li><strong>考虑后台服务等手段，</strong> Android提供了多种在非主线程工作的方法，如<strong>HandlerThread</strong>，<strong>IntentService</strong>和<strong>AsyncTask</strong>，它们每个都有自己的优缺点。另外，Android提供了一些机制来传递信息给主线程以更新UI。譬如，<strong>广播接收器</strong>就可以很方便实现这一点。</li> <li><strong>不要一味依赖垃圾回收器。</strong>使用具有垃圾回收功能的语言编码很容易有这样的想法：即没必要考虑内存管理。我们的示例清楚地表明，并非如此。因此，请确保你分配的资源都被预期回收。</li> </ul> <p><br> </p> <p><a href="/misc/goto?guid=4959675104783098518">阅读原文</a></p>