Android App调试内存泄露之Cursor篇

什么是内存泄露

Android应用程序中常见的问题是内存泄漏问题。内存泄漏指的是程序中的对象在使用完之后仍然被占用并未得到垃圾回收，导致内存空间不断被占满，从而引发ANR和崩溃等问题。

Cursor泄露的原因

在Android开发中，我们使用Cursor对象进行数据的操作。Cursor对象是一种轻量级的数据集，用于存储查询到的数据，如果不正确地使用和关闭，就会导致内存泄露问题。

例如，我们可能使用以下代码查询数据库并使用cursor对象来保存结果：

Cursor cursor = db.rawQuery("SELECT * FROM TABLE_NAME", null);

while (cursor.moveToNext()) {
    // ...
}

cursor.close();

如果我们在while循环中发生了异常但没有正确关闭cursor，则会导致内存泄露：

Cursor cursor = db.rawQuery("SELECT * FROM TABLE_NAME", null);

try {
    while (cursor.moveToNext()) {
        // ...
        if(something){
            throw new Exception("Error occurred"); 
        }
    }
} catch (Exception e) {
    Log.e(TAG, e.getMessage());
} finally {
    cursor.close();
}

因为我们没有在异常发生时关闭Cursor对象，导致它被占用并未得到释放，从而引发内存泄漏问题。

如何调试Cursor泄露

以下是一些常见的解决方案，可以帮助你定位和解决Cursor泄漏问题。

使用工具检查内存泄露

Android开发者可以使用以下工具来检查内存泄漏：

• Android Profiler
• LeakCanary

这些工具可以帮助我们分析内存使用情况，查找内存泄漏的原因。

检查是否正确关闭Cursor

在代码中，我们必须确保在使用完Cursor之后关闭它。通常使用try-finally语句块，在final代码块中关闭Cursor对象：

Cursor cursor = db.rawQuery("SELECT * FROM TABLE_NAME", null);

try {
    while (cursor.moveToNext()) {
        // ...
    }
} finally {
    cursor.close();
}

使用CursorLoader

CursorLoader是一种异步加载数据的机制，可以帮助我们定位和解决Cursor泄漏问题。CursorLoader会自动关闭cursor，从而避免内存泄露问题。以下是使用CursorLoader的示例代码：

public class MyActivity extends AppCompatActivity implements LoaderManager.LoaderCallbacks<Cursor> {

    private static final int LOADER_ID = 0;
    private MyCursorAdapter mAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        mAdapter = new MyCursorAdapter(this, null, 0);

        getSupportLoaderManager().initLoader(LOADER_ID, null, this);
    }

    @Override
    public Loader<Cursor> onCreateLoader(int id, Bundle args) {
        return new CursorLoader(this, MyContentProvider.CONTENT_URI, null, null, null, null);
    }

    @Override
    public void onLoadFinished(Loader<Cursor> loader, Cursor data) {
        mAdapter.swapCursor(data);
    }

    @Override
    public void onLoaderReset(Loader<Cursor> loader) {
        mAdapter.swapCursor(null);
    }
}

示例说明

示例1

在我们的应用程序中，我们使用Cursor对象查询数据库，并通过RecyclerView将查询结果显示在屏幕上。

private Cursor mCursor;
// ...
mCursor = db.rawQuery("SELECT * FROM TABLE_NAME", null);
mAdapter.swapCursor(mCursor);

由于某些原因（例如页面返回），我们决定从屏幕上删除这些数据，但是我们错过了调用mCursor.close()方法，这样就会导致内存泄漏。

我们可以使用Android Profiler来查找内存泄漏的原因。打开Android Studio的Profiler窗口，选择Memory选项卡，我们可以查看内存使用的情况和我们创建的对象。

如果我们看到“testapp.MyActivity$1.onItemClick()”出现在堆栈跟踪中，则表明我们的OnClick方法正在泄漏内存。我们可以通过添加mCursor.close()代码来修复这个问题。

@Override
public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
    Cursor cursor = mAdapter.getCursor();
    cursor.moveToPosition(position);
    // ...
    cursor.close();
}

示例2

在我们的应用程序中，我们使用Cursor对象查询数据库，并通过ViewPager将查询结果的不同部分显示在不同的页面上。

private Cursor mCursor;
// ...
mCursor = db.rawQuery("SELECT * FROM TABLE_NAME", null);
// ...
ViewPager pager = (ViewPager) findViewById(R.id.pager);
PagerAdapter adapter = new MyPagerAdapter(getSupportFragmentManager(), mCursor);
pager.setAdapter(adapter);

由于某些原因（例如页面返回），我们决定从屏幕上删除这些数据，但由于ViewPager的缓存机制，导致与这些数据相关的Cursor对象不正确地在内存中持有。为了解决这个问题，我们需要设置ViewPager的setOffscreenPageLimit()方法：

ViewPager pager = (ViewPager) findViewById(R.id.pager);
PagerAdapter adapter = new MyPagerAdapter(getSupportFragmentManager(), cursor);
pager.setAdapter(adapter);
pager.setOffscreenPageLimit(5);

这会告诉ViewPager在停用分页之前保留多少页面，从而防止内存泄漏。