Concurrent database access

对于 Android Dev 而言，有关 SQLite 的操作再经常不过了，相比你一定经历过控制台一片爆红的情况，这不禁让我们疑问：SQLite 到底是线程安全的吗？

OK 废话不多说，我们 ⬇️

直接开始

首先，假设你已经实现了一个 SQLiteHelper 类，如下所示：

public class DatabaseHelper extends SQLiteOpenHelper { ... }
复制代码

现在你想要在两个子线程中，分别地向 SQLite 里写入一些数据：

 // Thread 1
 Context context = getApplicationContext();
 DatabaseHelper helper = new DatabaseHelper(context);
 SQLiteDatabase database = helper.getWritableDatabase();
 database.insert(…);
 database.close();

 // Thread 2
 Context context = getApplicationContext();
 DatabaseHelper helper = new DatabaseHelper(context);
 SQLiteDatabase database = helper.getWritableDatabase();
 database.insert(…);
 database.close();
复制代码

对吧？看上去很 OK 没啥毛病。

那么这时，我们点一下 run ，gio～ 你将会在你的 logcat 里收到如下礼物「报错」：

android.database.sqlite.SQLiteDatabaseLockedException: database is locked (code 5)
复制代码

到底是怎么回事呢？

我们分析一下报错终于发现：这是由于你每次创建 SQLiteHelper 时，都对数据库进行了一个链接操作。这时，如果你尝试着，同时从实际不同的链接中，对数据库进行写入操作，失败就是必然的了。

总结一下 如果我们想再不同的线程中，对数据库进行包括读写操作在内的任何使用，我们就必须得确保，我们使用的是同一个的连接

好，那现在问题就明了了。现在让我们创建一个单例模式类：DatabaseManager 用来创建和返回的，单例 DatabaseManager 对象。

ps 有些同学问我什么是单例模式，我专门跑去写了这篇博客来解释下，单例模式-全局可用的 context 对象，这一篇就够了

public class DatabaseManager {

    private static DatabaseManager instance;
    private static SQLiteOpenHelper mDatabaseHelper;

    public static synchronized void initializeInstance(SQLiteOpenHelper helper) {
        if (instance == null) {
            instance = new DatabaseManager();
            mDatabaseHelper = helper;
        }
    }

    public static synchronized DatabaseManager getInstance() {
        if (instance == null) {
            throw new IllegalStateException(DatabaseManager.class.getSimpleName() +
                    " is not initialized, call initialize(..) method first.");
        }

        return instance;
    }

    public synchronized SQLiteDatabase getDatabase() {
        return mDatabaseHelper.getWritableDatabase();
    }

}
复制代码

现在，我们在回来修改下之前的代码，结果如下所示：

// In your application class
DatabaseManager.initializeInstance(new DatabaseHelper());

// Thread 1
DatabaseManager manager = DatabaseManager.getInstance();
SQLiteDatabase database = manager.getDatabase()
database.insert(…);
database.close();

// Thread 2
DatabaseManager manager = DatabaseManager.getInstance();
SQLiteDatabase database = manager.getDatabase()
database.insert(…);
database.close();
复制代码

逻辑比之前更清晰，代码冗余也少了。现在我们在跑下代码，这时我们会收到，另一个 cache ：

java.lang.IllegalStateException: attempt to re-open an already-closed object: SQLiteDatabase
复制代码

不要慌，我们仔细分析下报错，我们发现：单例模式的使用保证了我们，在线程一、二「Thread 1、Thread 2 中」只会获得到的 SQLiteHelper 对象，但这时问题就来了，当我们运行完线程一「Thread 1」时，我们的 database.close(); 已经替我们关闭了对数据库的连接，但与此同时我们的线程二「Thread 2」依然保持这对 SQLiteHelper 的引用。正是这个原因，我们收到了IllegalStateException的报错。

所以，这时我们就需要保证，当没有人使用 SQLiteHelper 时，再将其断开连接。

保证 SQLIiteHelper 在无人使用时才断开连接

关于这个问题的解决 stackoveflow 上很多人建议我们：永远不要断开 SQLiteHelper 的连接，但是这样以来你会在 logcat 上得到如下输出：

Leak found
Caused by: java.lang.IllegalStateException: SQLiteDatabase created and never closed
复制代码

所以，我非常不建议你用这个方法。为了解决这个问题，我们引入计数器的概念

标准样例

通过如下方法，你将通过一个计数器来完美解决 打开/关闭 数据库连接的问题：

public class DatabaseManager {

    private AtomicInteger mOpenCounter = new AtomicInteger();

    private static DatabaseManager instance;
    private static SQLiteOpenHelper mDatabaseHelper;
    private SQLiteDatabase mDatabase;

    public static synchronized void initializeInstance(SQLiteOpenHelper helper) {
        if (instance == null) {
            instance = new DatabaseManager();
            mDatabaseHelper = helper;
        }
    }

    public static synchronized DatabaseManager getInstance() {
        if (instance == null) {
            throw new IllegalStateException(DatabaseManager.class.getSimpleName() +
                    " is not initialized, call initializeInstance(..) method first.");
        }

        return instance;
    }

    public synchronized SQLiteDatabase openDatabase() {
        if(mOpenCounter.incrementAndGet() == 1) {
            // Opening new database
            mDatabase = mDatabaseHelper.getWritableDatabase();
        }
        return mDatabase;
    }

    public synchronized void closeDatabase() {
        if(mOpenCounter.decrementAndGet() == 0) {
            // Closing database
            mDatabase.close();

        }
    }
}
复制代码

我们在线程中可以这样使用它：

SQLiteDatabase database = DatabaseManager.getInstance().openDatabase();
database.insert(...);
// database.close(); Don't close it directly!
DatabaseManager.getInstance().closeDatabase(); // correct way
复制代码

每当你需要使用数据库时，你只要调用 DatabaseManager 中的 openDatabase() 方法。在这个方法中，我们有一个，用来记录数据库被“打开”了几次的 mOpenCounter 对象。当它等于 1 时，这意味着你需要去创建新的数据库连接来使用数据库，否则的话，就说明数据库已经在使用中了。

同样的情况也发生在 closeDatabase() 方法中，当你每次调用该方法时，我们的 mOpenCounter 对象就会减一。当它减到 0 时，我们就去关闭这个数据库的连接。