最近公司的项目处于重构阶段,观察后台crash log的时候发现了一个发生很多的问题:
android.database.sqlite.SQLiteDatabaseLockedException: database is locked (code 5): , while compiling: PRAGMA journal_mode
看了一下报错具体位置:
嗯,很简单,那就改成同步。
这边先说一下database is locked产生的原因:sqlite同一时间只能进行一个写操作,当同时有两个写操作的时候,后执行的只能先等待,如果等待时间超过5秒,就会产生这种错误.同样一个文件正在写入,重复打开数据库操作更容易导致这种问题的发生。
那首先,得避免重复打开数据库,首先引入单例方法与SQLiteOpenHelper类:
public class DBOpenHelper extends SQLiteOpenHelper{
private DBOpenHelper(Context context,String dbPath, int version) {
super(context, dbPath , null, version);
}
private volatile static DBOpenHelper uniqueInstance;
public static DBOpenHelper getInstance(Context context) {
if (uniqueInstance == null) {
synchronized (DBOpenHelper.class) {
if (uniqueInstance == null) {
uniqueInstance = new DBOpenHelper(context,context.getFilesDir().getAbsolutePath()+"/foowwlite.db",1);
}
}
}
return uniqueInstance;
}
@Override
public void onCreate(SQLiteDatabase db) {
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
}
}
然后通过代理类SQLiteDataProxy来控制对数据库的访问:
private static SQLiteDataProxy proxy;
private static DBOpenHelper helper;
public static SQLiteDataProxy getSQLiteProxy(Context context) {
helper = DBOpenHelper.getInstance(context);
if (proxy == null) {
synchronized (SQLiteDataProxy.class) {
if (proxy == null) {
proxy = new SQLiteDataProxy();
}
}
}
return proxy;
}
@Override
public boolean execSQL(String sql) {
boolean result = true;
if (!db.isOpen()) {
db = helper.getWritableDatabase();
}
try {
db.execSQL(sql);
} catch (Exception e) {
Log.e("SQLERROR", "In SQLDA:" + e.getMessage() + sql);
result = false;
} finally {
db.close();
}
return result;
}
每次获取db对象即SQLiteDataBase的时候先判断是否已经打开,如果已经打开则不需要重新获取,避免了db的重复开启。
接下来我们试验一下,这边我通过viewpager+fragment的方式测试,因为fragment会同时被加载。在两个fragment中各自新建一个子线程来执行大量insert语句:
new Thread(new Runnable() {
@Override
public void run() {
for (String sql:getSQLList()){
SQLiteDataProxy.getSQLiteProxy(getActivity()).execSQL(sql);
}
}
}).start();
先分析一下:虽然都是子线程,但是两个fragment都是通过单例获得db对象来执行sql语句,因此db应该是同一个的,这时候他们并发执行sql应该没有问题。
但是运行还是报错了:
attempt to re-open an already-closed object,意思是数据库已经关闭了,但是我却仍然用一个已经关闭的db去执行sql语句,可是为什么错呢,明明已经判断了db.isOpen,再执行sql的。
其实此时的原因如下:
线程一和线程二同时执行execSQL方法,线程一先获取到了db对象,开始执行sql语句,于此同时,线程二判断db.isOpen,发现是打开的于是不重新get,直接调用db开始执行sql语句。但现在问题来了,线程二准备执行sql的时候,线程一已经把sql执行完,并且关闭,由于线程一和线程二得到的db是同一个对象,线程二的db也关闭了,这时执行sql就导致了这个错误。
接下来如何是好。。。
这种情况,我们可以引入一个全局变量来计算打开关闭db的次数,而java刚好提供了这个方法AtomicInteger
AtomicInteger是一个线程安全的类,我们可以通过它来计数,无论什么线程AtomicInteger值+1后都会改变
我们讲判断db是否打开的方法改成以下:
private AtomicInteger mOpenCounter = new AtomicInteger();
private SQLiteDatabase getSQLiteDataBase() {
if (mOpenCounter.incrementAndGet() == 1) {
db = helper.getWritableDatabase();
}
return db;
}
关闭db的方法改为如下:
private void closeSQLiteDatabase(){
if(mOpenCounter.decrementAndGet() == 0){
db.close();
}
}
每当想要获得db对象是计数器mOpenCounter会+1,第一次打开数据库mOpenCounter是0,mOpenCounter调用incrementAndGet()方法后+1等于1说明还没有被获得,此时有第二个线程想执行sql语句,它在执行getSQliteDataBase方法的时候mOpenCounter是1,然后mOpenCounter+1=2不等于1,说明db已经开启,直接return db即可。
在关闭db的时候,mOpenCounter会首先减1,如果mOpenCounter==0则说明此时没有其他操作,就可以关闭数据库,如果不等于则说明还有其他sql在执行,就不去关闭。
接着上面的说,两个线程各自执行想执行sql,此时mOpenCounter是2,当线程一的sql执行完后,线程一的db尝试关闭,会调用mOpenCounter.decrementAndGet()自减1,decrementAndGet-1后就等于1,说明还有一个正在执行的sql,即线程二正在执行。因此db不会去关闭,然后线程二正常执行,线程二执行完sql,尝试关闭db,此时decrementAndGet再自减1,就等于0,说明已经没有其他真正执行的sql,于是可以正常关闭。
这种判断方法保证了只有在所有sql都执行完后才去关闭,并且只会最后一次关闭,保证了不会出现re-open an already-closed这种问题。
这个方法再其他博客中也有说明,说是保证了觉得安全,但是,经过测试说明,那些博客都是抄袭的,并没去真正实验,接下来我就说明一下它为什么不行。
修改以后,我们再测试一下。
结果还是报错。
很显然db为null,这是一个空指针错误,但是为什么会导致这种错误呢?
分析一下AtomicInteger,并没有逻辑上的问题啊。
我们把代码改成如下,便于打印log日志:
private SQLiteDatabase getSQLiteDataBase() {
Log.e("111", "Once start");
if (mOpenCounter.incrementAndGet() == 1 || db == null) {
db = helper.getWritableDatabase();
}
if (db == null) {
Log.e("111", mOpenCounter.intValue() + "");
} else {
Log.e("111", mOpenCounter.intValue() + " NOT NULL");
}
return db;
}
稍微想一下就知道了,线程一和二同时尝试获取db,线程一中mOpenCounter+1==1,但此时db还没有获取的情况下,线程二也执行了获取db的方法,mOpenCounter+1==2,单由于获取db的getWritableDatabase()需要一定的时间,而先执行的线程一db还没有被获取到,线程二却已经也经过判断并且return db,此时的db就是null了,导致了空指针错误。
原因已经找到了,那么解决就很简单,只需要多加一个非空判断就行,而getWriteableDataBase本身就是线程安全的,应该只需要这样就可以解决。
private SQLiteDatabase getSQLiteDataBase() {
if (mOpenCounter.incrementAndGet() == 1 || db == null) {
db = helper.getWritableDatabase();
}
return db;
}
这样修改好以后,经过测试没有问题。
接下来解决另一个问题:如果当前执行的是许多sql语句,要用到事务怎么办?
如果是事物,大家都知道,事物执行的时候调用beginTransaction(),完成后调用db.setTransactionSuccessful()、db.endTransaction()标志着事务的结束,但是如果多线程下调用了事务怎么办?尤其还是单例模式下,同时调用方法开启事务,这肯定会出问题。
如以下方法:
public boolean execSQLList(List sqlList) {
boolean result = true;
db = getSQLiteDataBase();
String currentSqlString = "";
try {
db.beginTransaction();
for (String sql : sqlList) {
currentSqlString = sql;
db.execSQL(sql);
}
db.setTransactionSuccessful();
result = true;
} catch (Exception e) {
result = false;
Log.e("SQLERROR", "IN SQLDA: " + e.getMessage() + currentSqlString);
} finally {
db.endTransaction();
closeSQLiteDatabase();
}
return result;
}
为了解决这个问题,只有保证执行事务时是同步的,但是多线程调用我们如何控制其同步呢。
这里要引入一个类java.util.concurrent.Semaphore,这个类可以用来协调多线程下的控制同步的问题。
首先初始化这个类,并且设置信号量为1
private java.util.concurrent.Semaphore semaphoreTransaction = new java.util.concurrent.Semaphore(1);
semaphoreTransaction.acquire()
执行后,semaphore会检测是否有其他信号量已经执行,如果有,改线程就会停止,直到另一个semaphore释放资源之后,才会继续执行下去,即:
semaphoreTransaction.release();
我们只需要在开始事务前调用acquire方法,当其他事务想要执行,会先判断,如果有事务在执行,该线程就会等待,直到前一个事物结束并调用release之后,该线程的事务就会继续进行,这样解决事务并发产生的问题,也保证了事务都可以执行完毕。
改进后代码如下:
private java.util.concurrent.Semaphore semaphoreTransaction = new java.util.concurrent.Semaphore(1);
public boolean execSQLList(List sqlList) {
boolean result = true;
db = getSQLiteDataBase();
String currentSqlString = "";
try {
semaphoreTransaction.acquire();
db.beginTransaction();
for (String sql : sqlList) {
currentSqlString = sql;
db.execSQL(sql);
}
db.setTransactionSuccessful();
result = true;
} catch (Exception e) {
result = false;
Log.e("SQLERROR", "IN SQLDA: " + e.getMessage() + currentSqlString);
} finally {
db.endTransaction();
semaphoreTransaction.release();
closeSQLiteDatabase();
}
return result;
}
全部代码如下:
ISQLiteOperate:
package com.xiaoqi.sqlitedemo;
import android.database.Cursor;
import java.util.List;
/**
* Created by xiaoqi on 2016/9/1.
*/
public interface ISQLiteOperate {
boolean execSQL(String sql);
boolean execSQLList(List sqlList);
boolean execSQLs(List sqlList);
boolean execSQLIgnoreError(List sqlList);
Cursor query(String sql);
Cursor query(String sql, String[] params);
void close();
}
DBOpenHelper:
package com.xiaoqi.sqlitedemo;
import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
/**
* Created by xiaoqi on 2016/9/1.
*/
public class DBOpenHelper extends SQLiteOpenHelper{
private DBOpenHelper(Context context,String dbPath, int version) {
super(context, dbPath , null, version);
}
private volatile static DBOpenHelper uniqueInstance;
public static DBOpenHelper getInstance(Context context) {
if (uniqueInstance == null) {
synchronized (DBOpenHelper.class) {
if (uniqueInstance == null) {
uniqueInstance = new DBOpenHelper(context,context.getFilesDir().getAbsolutePath()+"/foowwlite.db",1);
}
}
}
return uniqueInstance;
}
@Override
public void onCreate(SQLiteDatabase db) {
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
}
}
package com.xiaoqi.sqlitedemo;
import android.content.Context;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.util.Log;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
public class SQLiteDataProxy implements ISQLiteOperate {
private java.util.concurrent.Semaphore semaphoreTransaction = new java.util.concurrent.Semaphore(1);
private AtomicInteger mOpenCounter = new AtomicInteger();
private SQLiteDatabase db;
private Cursor cursor;
private SQLiteDataProxy() {
}
private static SQLiteDataProxy proxy;
private static DBOpenHelper helper;
public static SQLiteDataProxy getSQLiteProxy(Context context) {
helper = DBOpenHelper.getInstance(context);
if (proxy == null) {
synchronized (SQLiteDataProxy.class) {
if (proxy == null) {
proxy = new SQLiteDataProxy();
}
}
}
return proxy;
}
private SQLiteDatabase getSQLiteDataBase() {
if (mOpenCounter.incrementAndGet() == 1) {
db = helper.getWritableDatabase();
}
return db;
}
private void closeSQLiteDatabase(){
if(mOpenCounter.decrementAndGet() == 0){
db.close();
}
}
@Override
public boolean execSQL(String sql) {
boolean result = true;
db = getSQLiteDataBase();
try {
db.execSQL(sql);
} catch (Exception e) {
Log.e("SQLERROR", "In SQLDA:" + e.getMessage() + sql);
result = false;
} finally {
closeSQLiteDatabase();
}
return result;
}
@Override
public boolean execSQLList(List sqlList) {
boolean result = true;
db = getSQLiteDataBase();
String currentSqlString = "";
try {
semaphoreTransaction.acquire();
db.beginTransaction();
for (String sql : sqlList) {
currentSqlString = sql;
db.execSQL(sql);
}
db.setTransactionSuccessful();
result = true;
} catch (Exception e) {
result = false;
Log.e("SQLERROR", "IN SQLDA: " + e.getMessage() + currentSqlString);
} finally {
db.endTransaction();
semaphoreTransaction.release();
closeSQLiteDatabase();
}
return result;
}
@Override
public boolean execSQLs(List sqlList) {
boolean result = true;
db = getSQLiteDataBase();
String currentSql = "";
try {
semaphoreTransaction.acquire();
db.beginTransaction();
for (String[] arr : sqlList) {
currentSql = arr[0];
Cursor curCount = db.rawQuery(arr[0], null);
curCount.moveToFirst();
int count = curCount.getInt(0);
curCount.close();
if (count == 0) {
if (arr[1] != null && arr[1].length() > 0) {
currentSql = arr[1];
db.execSQL(arr[1]);
}
} else {
if (arr.length > 2 && arr[2] != null && arr[2].length() > 0) {
currentSql = arr[2];
db.execSQL(arr[2]);
}
}
}
db.setTransactionSuccessful();
result = true;
} catch (Exception e) {
Log.e("SQLERROR", "IN SQLDA: " + currentSql + e.getMessage());
result = false;
} finally {
db.endTransaction();
semaphoreTransaction.release();
closeSQLiteDatabase();
}
return result;
}
@Override
public boolean execSQLIgnoreError(List sqlList) {
db = getSQLiteDataBase();
try {
semaphoreTransaction.acquire();
} catch (InterruptedException e) {
e.printStackTrace();
}
db.beginTransaction();
for (String sql : sqlList) {
try {
db.execSQL(sql);
} catch (Exception e) {
Log.e("SQLERROR", "IN SQLDA: " + sql + e.getMessage());
}
}
db.setTransactionSuccessful();
db.endTransaction();
semaphoreTransaction.release();
closeSQLiteDatabase();
return true;
}
@Override
public Cursor query(String sql) {
return query(sql, null);
}
@Override
public Cursor query(String sql, String[] params) {
db = getSQLiteDataBase();
cursor = db.rawQuery(sql, params);
return cursor;
}
@Override
public void close() {
if (cursor != null) {
cursor.close();
}
closeSQLiteDatabase();
}
}
package com.xiaoqi.sqlitedemo;
import android.content.Context;
import android.database.Cursor;
import java.util.List;
public class DBManager {
public static void asyncExecSQL(final Context context, final String sql){
new Thread(new Runnable() {
@Override
public void run() {
SQLiteDataProxy.getSQLiteProxy(context).execSQL(sql);
}
}).start();
}
public static void asyncExecSQLList(final Context context,final List sqlList){
new Thread(new Runnable() {
@Override
public void run() {
SQLiteDataProxy.getSQLiteProxy(context).execSQLList(sqlList);
}
}).start();
}
public static void asyncExecSQLs(final Context context,final List sqlList){
new Thread(new Runnable() {
@Override
public void run() {
SQLiteDataProxy.getSQLiteProxy(context).execSQLs(sqlList);
}
}).start();
}
public static void asyncExecSQLIgnoreError(final Context context,final List sqlList){
new Thread(new Runnable() {
@Override
public void run() {
SQLiteDataProxy.getSQLiteProxy(context).execSQLIgnoreError(sqlList);
}
}).start();
}
public static boolean execSQL( Context context, String sql){
return SQLiteDataProxy.getSQLiteProxy(context).execSQL(sql);
}
public static boolean execSQLList( Context context, List sqlList){
return SQLiteDataProxy.getSQLiteProxy(context).execSQLList(sqlList);
}
public static boolean execSQLs( Context context, List sqlList){
return SQLiteDataProxy.getSQLiteProxy(context).execSQLs(sqlList);
}
public static boolean execSQL( Context context, List sqlList){
return SQLiteDataProxy.getSQLiteProxy(context).execSQLIgnoreError(sqlList);
}
public static Cursor query(Context context, String sql){
return SQLiteDataProxy.getSQLiteProxy(context).query(sql);
}
public static Cursor query(Context context, String sql, String[] params){
return SQLiteDataProxy.getSQLiteProxy(context).query(sql, params);
}
public static void close(Context context){
SQLiteDataProxy.getSQLiteProxy(context).close();
}
}
使用方法很简单:
DBManager.asyncExecSQLList(context,getSQLList())
DBManager.execSQLList(context,getSQLList())
-------------------------------------------------------------------------------------------------------------------------------------------
补充:如果在多线程下执行query方法怎么办,如何处理close?
public Cursor query(String sql, String[] params) {
db = getSQLiteDataBase();
cursor = db.rawQuery(sql, params);
return cursor;
}
其他的方法无论什么情况最后都会执行close方法,但是query方法不一样,因为调用这个方法需要我们手动控制close,如果多线程下执行这个方法,并且有一个线程的query出现异常了怎么办?这样close方法就不能正常调用,会导致数据库永远关闭不了。
为了解决这个方法,可以引入一个变量
private ThreadLocal isQuery = new ThreadLocal<>();
具体修改部分如下:
private ThreadLocal isQuery = new ThreadLocal<>();
@Override
public Cursor query(String sql) {
return query(sql, null);
}
@Override
public Cursor query(String sql, String[] params) {
isQuery.set(true);//设置为true,表示正在查询
db = getSQLiteDataBase();
cursor = db.rawQuery(sql, params);
return cursor;
}
/*如果调用query方法,抛异常时要调用此方法
*/
@Override
public void closeWhileError(){
if (cursor != null) {
cursor.close();
}
if(isQuery.get()){//没有执行完毕,异常后需要去关闭数据库
closeSQLiteDataBase();
}
}
private void closeSQLiteDataBase(){
if(mOpenCounter.decrementAndGet() == 0){
db.close();
isQuery.set(false);//设置为false,表示执行完毕
Log.i("DataBaseState","DB------Closed");
}
}
补充二:
这个版本的项目已经完成,在实际使用过程中,很容易导致一个错误,当cursor或者db已经关闭的时候,又去调用了它,导致异常。
思考了一下,上面写法容错率太低,每次query和close都得对应,否则很容易导致上述错误。因此,使用了新的解决方法,产品上线到目前为止基本没有出现数据库的问题。
新的解决方法是:
因为在我们写代码的时候,用上述方法,如果稍不小心,少写了一个close,就会导致数据库永远不能关闭,为了避免这个问题,同时避免调用已经关闭的cursor、db的问题,我将所有的close方法都取消了,新建了一个service,监听最后一次查询的时间,如果超过5秒没有进行新的数据库操作,再去关闭db,同时,每次查询时,用HashSet存储cursor,关闭db前先把所有的cursor关闭。
这种解决方法降级了容错率,同时避免了数据库的一直打开关闭,减少了资源的消耗。
如有什么问题和建议欢迎大家提出。
下载地址:点击打开链接 (注意,由于资源提早上传了,没有修改多线程下调用query下可能导致的问题,请根据上面的内容,自己修改一下)