GreenDao 相容升級，保留舊資料的---全方面解決方案

林冠巨集發表於2018-02-10

作者：林冠巨集 / 指尖下的幽靈

掘金：https://juejin.im/user/587f0dfe128fe100570ce2d8

部落格：http://www.cnblogs.com/linguanh/

GitHub ： https://github.com/af913337456/

騰訊雲專欄： https://cloud.tencent.com/developer/user/1148436/activities

開源地址：github.com/af913337456…

本文不會花時間去談 greenDao 是什麼

使用 greenDao 作為線上APP 的本地 orm 框架時候，總有資料庫表要更新的一天，或早或遲。

目錄

  • 出問題的的情形

  • 幾個事實

  • 解決方案

  • 程式碼簡述

  • 產品級別的可能錯誤

  • 你的顧慮

出問題的的情形：

  • 欄位新增，導致舊錶格欄位與新的不匹配引發 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 ， 且成功執行至今。

相關文章