android輕量級(jí)無侵入式管理數(shù)據(jù)庫自動(dòng)升級(jí)組件

更新時(shí)間：2023年02月28日 17:16:05 作者：Points

這篇文章主要為大家介紹了android輕量級(jí)無侵入式管理數(shù)據(jù)庫自動(dòng)升級(jí)組件詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

SpeSqliteManager4Android

改動(dòng)日志

2023.2.14 完成SQLiteOpenHelper 
2023.2.23 完成room
2023.2.25 完成架構(gòu)重構(gòu)
2023.2.26 新增架構(gòu)設(shè)計(jì)圖說明

介紹

一個(gè)輕量級(jí)無侵入式管理android數(shù)據(jù)庫自動(dòng)升級(jí)的管理類(支持SQLiteOpenHelper、room)

媽媽再也不用擔(dān)心寫一坨坨的migration或是手動(dòng)sql去升級(jí)數(shù)據(jù)庫

核心設(shè)計(jì)思想

1.以靜制動(dòng):配置項(xiàng)代替代碼，保證代碼穩(wěn)定性

架構(gòu)設(shè)計(jì)

關(guān)配置項(xiàng)json:

1.dbName:數(shù)據(jù)庫文件名稱,要保持穩(wěn)定，不能修改。
2.dbVersion:數(shù)據(jù)庫版本號(hào),判斷本地?cái)?shù)據(jù)庫文件是否升級(jí)就通過此key,升級(jí)時(shí)要保證新版本號(hào)大于當(dāng)前的。
3.dbTables:想要?jiǎng)?chuàng)建的表名,每個(gè)表名下是具體的字段。

集成步驟

1.導(dǎo)入依賴庫

    implementation 'com.google.code.gson:gson:2.8.9'
    implementation "androidx.room:room-runtime:2.0.0"
    annotationProcessor "androidx.room:room-compiler:2.0.0"

2.在assets目錄下新建dbupdate.json 注意:dbconfig的配置不要?jiǎng)?，自己的表在后面新?/p>

3.SQLiteOpenHelper的調(diào)用方法

    //1.直接創(chuàng)建SQLiteOpenHelper
    SpeSqliteOpenHelperService.getInstance(this);
    //2.創(chuàng)建SQLiteOpenHelper且需要監(jiān)聽db
    SpeSqliteOpenHelperService.getInstance(this, new SpeSqliteBaseInterface() {
      @Override
      public <T> void onCreate(T db, RoomDatabase room) {
               
      }
      @Override
      public <T> void onOpen(T db, RoomDatabase room) {
                                 
      }
      @Override
      public <T> void onUpgrade(T db, int oldVersion, int newVersion, RoomDatabase room) {
                                                    
       }
    });

4.Room的調(diào)用方法

    //3.直接創(chuàng)建room
        SpeSqliteRoomService.getInstance(this,AppDatabase.class);
    //4.創(chuàng)建room，且需要監(jiān)聽db
        SpeSqliteRoomService.getInstance(this,AppDatabase.class,new SpeSqliteBaseInterface() {
            @Override
            public <T> void onCreate(T db, RoomDatabase room) {
                //TODO  刪除測(cè)試插入代碼
                if(room != null){
                    ServerModel model = new ServerModel();
                    model.setId("1");
                    model.setHost("1");
                    model.setLang("1");
                    model.setName("1");
                    model.setVersion("1");
                    insert(room,model);
                }

            }
            @Override
            public <T> void onOpen(T db, RoomDatabase room) {

            }

            @Override
            public <T> void onUpgrade(T db, int oldVersion, int newVersion, RoomDatabase room) {

            }
        });

核心代碼

SpeSqliteUpdateManager 負(fù)責(zé)針對(duì)本地db的創(chuàng)建、新建表、表字段升級(jí)、刪除表,通過配置的方式去升級(jí)數(shù)據(jù)庫，減少代碼的改動(dòng)，核心思想：以靜制動(dòng)

  /**
     * 數(shù)據(jù)庫第一次創(chuàng)建時(shí)的調(diào)用函數(shù)
     * @param db db
     */
    public void create(SQLiteDatabase db){
        SpeSqliteSettingModel currentDBModel = SpeSqliteUpdateManager.getInstance().currentAppDBSetting();
        for(int i=0;i<currentDBModel.dbTables.size();i++){
            SpeSqliteTableSettingModel table = currentDBModel.dbTables.get(i);
            String sql = " create table if not exists "+table.tableName+" (";
            for(int j=0;j<table.columns.size();j++){
                SpeSqliteColumnSettingModel column = table.columns.get(j);
                sql+=column.key+" ";
                sql+=column.keyType;
                if(j==table.columns.size()-1){
                    sql+=" ";
                }else {
                    sql+=",";
                }
            }
            sql+=")";
            executeSQL(db,sql);
        }
        //SQLiteDatabase數(shù)據(jù)庫才需要升級(jí)本地?cái)?shù)據(jù)配置
        if(db instanceof SQLiteDatabase){
            SQLiteDatabase _db = (SQLiteDatabase)db;
            updateConfig2DB(_db,currentDBModel);
        }
    }

    /**
     * 升級(jí)數(shù)據(jù)庫，此處涉及3種改動(dòng)：1.新建表 2.老表新增字段 3.刪除表
     * 注意該方法會(huì)被兩個(gè)數(shù)據(jù)庫依次觸發(fā)，所以需要控制
     * 1.新建表的處理思路：比較簡單直接create即可
     * 2.老表新增字段需要遍歷db中的json表字段明細(xì)和當(dāng)前app中的json明細(xì)
     * @param db db
     */
    public  void upgrade(SQLiteDatabase configdb,SupportSQLiteDatabase db){
        SpeSqliteSettingModel newConfig = this.currentAppDBSetting();
        SpeSqliteSettingModel localConfig = this.getAppLoclDBSetting(configdb);
        //該處判斷可以不要，但是加了后(daupdate.json的dbversion字段)效率更高
        if(localConfig.dbVersion< newConfig.dbVersion){//通過dbversion直接判斷是否要升級(jí)
            //防止room數(shù)據(jù)未創(chuàng)建表,就alter
            if(db != null){
                for(int i=0;i<localConfig.dbTables.size();i++) {
                    SpeSqliteTableSettingModel _local = localConfig.dbTables.get(i);
                    createTableSQL(db,_local);
                }
            }
            for(int j=0;j<newConfig.dbTables.size();j++){
                SpeSqliteTableSettingModel _new = newConfig.dbTables.get(j);
                for(int i=0;i<localConfig.dbTables.size();i++){
                    SpeSqliteTableSettingModel _local = localConfig.dbTables.get(i);
                    if(_local.tableName.equals(_new.tableName)){//找到，再判斷字段是否有新增
                        _local.indexed = true;//被比較過,該表不用刪除
                        if(_local.columns.size()<_new.columns.size()){
                            //執(zhí)行alert去新增字段 //
                            alterCoulmns(db != null?db:configdb,_local,_new);
                        }
                        break;//只要匹配到就直接跳出該層循環(huán)
                    }
                }
                //本地?cái)?shù)據(jù)沒找到這個(gè)表需要新增
                createTableSQL(db != null?db:configdb,_new);
            }
            //針對(duì)被廢棄的表需要在本地庫中刪除
            for(int i=0;i<localConfig.dbTables.size();i++){
                SpeSqliteTableSettingModel table = localConfig.dbTables.get(i);
                if(!table.indexed){
                    dropTables(db != null?db:configdb,localConfig.dbTables.get(i));
                }
            }
            //只有當(dāng)是SQLiteDatabase升級(jí)時(shí)才能本地?cái)?shù)據(jù)配置
            if(db == null){
                updateConfig2DB(configdb,newConfig);
            }
        }
    }

    /**
     * 移除老表
     * @param db db
     * @param table table
     * @param <T> 范型（需考慮SQLiteOpenHelper和room）
     */
    private <T> void dropTables(T db,SpeSqliteTableSettingModel table){
        String sql = " DROP TABLE IF EXISTS "+table.tableName;
        executeSQL(db,sql);
    }

    /**
     * 老表新增字段
     * @param db db
     * @param _old 老表字段配置
     * @param _new 表新字段配置
     * @param <T> 范型（需考慮SQLiteOpenHelper和room）
     */
    private <T> void alterCoulmns(T db,SpeSqliteTableSettingModel _old,SpeSqliteTableSettingModel _new){
        for(int i=0;i<_new.columns.size();i++){
            if(i>=_old.columns.size()){
                SpeSqliteColumnSettingModel column = _new.columns.get(i);
                String sql = " alter table "+_old.tableName+" add column ";
                sql+=column.key;
                sql+=" ";
                sql+= column.keyType;
                executeSQL(db,sql);
            }
        }
    }

    /**
     * 新增表
     * @param db db
     * @param table 表配置
     * @param <T> 范型（需考慮SQLiteOpenHelper和room）
     */
    private <T> void createTableSQL(T db,SpeSqliteTableSettingModel table){
        String sql = " create table if not exists "+table.tableName+" (";
        for(int j=0;j<table.columns.size();j++){
            SpeSqliteColumnSettingModel column = table.columns.get(j);
            sql+=column.key+" ";
            sql+=column.keyType;
            if(j==table.columns.size()-1){
                sql+=")";
            }else {
                sql+=",";
            }
        }
        executeSQL(db,sql);
    }