GreenDao 兼容升級，保留舊數據的---全方面解決方案
阿新 • • 發佈：2018-02-10
ner 描述 騰訊 can data 重載 數據丟失 void which
作者：林冠宏 / 指尖下的幽靈
掘金：https://juejin.im/user/587f0dfe128fe100570ce2d8
博客：http://www.cnblogs.com/linguanh/
GitHub ： https://github.com/af913337456/
騰訊雲專欄： https://cloud.tencent.com/developer/user/1148436/activities
GreenDaoCompatibleUpdateHelper
一個能幫助你成功升級基於 greenDao 創建的數據庫而不會丟失之前數據的工具
A helper which can help you to update you database without lost your old datas, simple to use , enjoy.
開源地址
https://github.com/af913337456/LghGreenDaoCompatibleUpdateHelper
目錄
- 出問題的的情形
- 幾個事實
- 解決方案
- 代碼簡述
- 產品級別的可能錯誤
- 你的顧慮
出問題的的情形：
- 字段添加，導致舊表格字段與新的不匹配引發
android.database.sqlite.SQLiteException類異常。 - 服務端數據返回無法與就表格匹配，無法進行插入操作
第一個情況會直接導致 APP 閃退掉，第二種就是數據不匹配。
幾個事實
GreenDao 目前的 3.+ 版，自動生成的代碼的升級方式都是
先刪除原來的表格，再創建新的/** WARNING: Drops all table on Upgrade! Use only during development. */public static class DevOpenHelper extends OpenHelper { ...... @Override public void onUpgrade(Database db, int oldVersion, int newVersion) { Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables"); dropAllTables(db, true); // 刪除-----①onCreate(db); } }- 凡是自動生成的代碼文件，例如
xxxDao.java類的，都會在每一次 build 的時候重新被生成，意味著個人的內嵌修改總是無效，因為總是覆蓋你的。 數據庫的升級方式需求更多是需要往後兼容的，舊數據不能丟失
解決方案
自定義升級策略。
思路參考
在上面的基礎上做出如下步驟總結： (看不懂的看下面的符號描述)
- 創建之前舊表中不存在的新表
- 創建中間表 & 把舊表的數據遷移到中間表
- 把舊表全部刪除
- 創建所有新表
- 把中間表的數據遷移到新表 & 刪除中間表
對應上面的步驟描述：
- A -> A + B , old: A , new: B
- use (A+B) -> create temp (A‘+B‘) & insert data
- drop (A+B) , contain old datas
- create (A+B) , abs empty tables
- restore data to (A+B) from (A‘+B‘) then drop (A‘+B‘)
代碼簡述
基於上面的二次修改和拓展
GreenDaoCompatibleUpdateHelper.java顧名思義，兼容舊表性質的 greenDao 數據庫升級，不會造成舊表的數據丟失- 拓展了最終的成功和失敗的回調
- 添加了錯誤日誌的處理
- 解決了字段名稱的沖突 bug，例如 delete 之類
MyGreenDaoDbHelper.java自定義的 dbHelper，重載 onUpgrade
調用例子
if (oldVersion < newVersion) {
Log.e("MyGreenDaoDbHelper","進行數據庫升級");
new GreenDaoCompatibleUpdateHelper()
.setCallBack(
new GreenDaoCompatibleUpdateHelper.GreenDaoCompatibleUpdateCallBack() {
@Override
public void onFinalSuccess() {
Log.e("MyGreenDaoDbHelper","進行數據庫升級 ===> 成功");
}
@Override
public void onFailedLog(String errorMsg) {
Log.e("MyGreenDaoDbHelper","升級失敗日誌 ===> "+errorMsg);
}
}
)
.compatibleUpdate(
db,
PostBeanDao.class,
MatterUserBeanDao.class,
PropsBeanDao.class,
ChannelChatsBeanDao.class,
JoinToChannelReqBeanDao.class
);
Log.e("MyGreenDaoDbHelper","進行數據庫升級--完成");
}GreenDaoCompatibleUpdateHelper
public final class GreenDaoCompatibleUpdateHelper {
public interface GreenDaoCompatibleUpdateCallBack{
void onFinalSuccess();
void onFailedLog(String errorMsg);
}
private static GreenDaoCompatibleUpdateCallBack callBack;
@SuppressWarnings("all")
public void compatibleUpdate(SQLiteDatabase sqliteDatabase, Class<? extends AbstractDao<?, ?>>... daoClasses) {
StandardDatabase db = new StandardDatabase(sqliteDatabase);
/** 創建之前舊表中不存在的新表 */
if(!generateNewTablesIfNotExists_withNoExchangeData(db, daoClasses))
return;
/** 創建中間表 & 把舊表的數據遷移到中間表 */
if(!generateTempTables_withExchangeDataFromOldTable(db, daoClasses))
return;
/** 把舊表全部刪除 */
if(!dropAllTables(db, true, daoClasses))
return;
/** 創建所有新表 */
if(!createAllTables_withNoExchangeData(db, false, daoClasses))
return;
/** 把中間表的數據遷移到新表 & 刪除中間表 */
restoreData_fromTempTableToNewTable(db, daoClasses);
if(callBack != null)
callBack.onFinalSuccess();
callBack = null;
}
public GreenDaoCompatibleUpdateHelper setCallBack(GreenDaoCompatibleUpdateCallBack callBack1){
callBack = callBack1;
return this;
}
...... // 去 gitHub 下載完整代碼
}MyGreenDaoDbHelper
public class MyGreenDaoDbHelper extends DaoMaster.DevOpenHelper {
public MyGreenDaoDbHelper(Context context, String name) {
super(context, name);
}
public MyGreenDaoDbHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
super(context, name, factory);
}
@Override
@SuppressWarnings("all")
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
Log.e("MyGreenDaoDbHelper", "----"+oldVersion + "---先前和更新之後的版本---" + newVersion+"----");
if (oldVersion < newVersion) {
Log.e("MyGreenDaoDbHelper","進行數據庫升級");
new GreenDaoCompatibleUpdateHelper()
.setCallBack(
new GreenDaoCompatibleUpdateHelper.GreenDaoCompatibleUpdateCallBack() {
@Override
public void onFinalSuccess() {
Log.e("MyGreenDaoDbHelper","進行數據庫升級 ===> 成功");
}
@Override
public void onFailedLog(String errorMsg) {
Log.e("MyGreenDaoDbHelper","升級失敗日誌 ===> "+errorMsg);
}
}
)
.compatibleUpdate(
db,
PostBeanDao.class,
MatterUserBeanDao.class,
PropsBeanDao.class,
ChannelChatsBeanDao.class,
JoinToChannelReqBeanDao.class
);
Log.e("MyGreenDaoDbHelper","進行數據庫升級--完成");
}
}
@Override
public void onUpgrade(Database db, int oldVersion, int newVersion) {
// 不要調用父類的，它默認是先刪除全部表再創建
// super.onUpgrade(db, oldVersion, newVersion);
}
}產品級別的可能錯誤
- 因為混淆了 dao 類文件，導致 createTable 方法找不到，解決方法，不要混淆 dao 文件
- restore 步驟中因為新加入的字段含有 int boolean 基礎類型，因為不具備默認值而導致出現
SQLiteConstraintException: NOT NULL constraint failed錯誤，解決方法，采用 Integer Boolean 類型替換，這個你只能妥協，因為 greenDao 作者不屑於在你建表的時候提供默認值方法。詳情可以去看看 issue
你的顧慮
- 如果我的表太多了，升級會不會造成 ANR 或者導致讀寫混亂？
- 是否實踐過？
1, 答： sqlLite 的源碼裏面調用 onUpdrade方法的入口皆加上了同步瑣，這樣不會造成在升級中還能讓你去讀寫的情況。
這點設計得非常優秀！表太多的，幾百張？那麽就放入子線程升級。
2, 答： 我已經使用到線上多個APP ， 且成功運行至今。
GreenDao 兼容升級，保留舊數據的---全方面解決方案