GreenDao设置数据库路径以及数据库升级

1. APP开发期间的数据库

上一篇文章中封装了GreenDaoManager中有个构造方法如下:

private GreenDaoManager(){
        if (mInstance == null) {
//            DaoMaster.DevOpenHelper devOpenHelper = new
//                    DaoMaster.DevOpenHelper(MyApplication.getContext(), "database_name", null);//此处openhelper为自动生成开发所使用,发布版本需自定义
            MySQLiteOpenHelper devOpenHelper = new
                    MySQLiteOpenHelper(new GreenDaoContext(), "database_name.db", null);//GreenDaoContext为创建数据库路径使用
            mDaoMaster = new DaoMaster(devOpenHelper.getWritableDatabase());
            mDaoSession = mDaoMaster.newSession();
        }
    }

其中注释掉的两行代码中:

DaoMaster.DevOpenHelper devOpenHelper = new
DaoMaster.DevOpenHelper(MyApplication.getContext(), "database_name", null);//此处DevOpenHelper 为自动生成开发所使用,发布版本需自定义

其中的MyApplication.getContext()上下文表示了数据库存储路径为手机内存。这里的DevOpenHelper即为DaoMaster中自动生成代码,完整代码如下:

/** * WARNING: Drops all table on Upgrade! Use only during development. */
public static class DevOpenHelper extends OpenHelper {    
  public DevOpenHelper(Context context, String name, CursorFactory factory) {
             super(context, name, factory);    
  }    
  @Override    
  public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {            
        Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");        
        dropAllTables(db, true);        
        onCreate(db);    
  }
}

注意看第一行注释:WARNING: Drops all table on Upgrade! Use only during development.
数据库升级的话,会删除所有表,然后重新创建。这种方式在开发期间,APP还没有上线之前是可以的。

当APP上线后,我们不能使用这种方式,因为这样会导致已经存在的数据会被删除。

2. APP上线后,数据库升级

我们需要重写一个类MySQLiteOpenHelper实现OpenHelper.

  1. 需要自己实现了onUpgrade方法来自定义升级过程。
  2. 当然升级过程中也要修改DaoMaster.SCHEMA_VERSION
  3. DaoMaster.SCHEMA_VERSION跟你当前数据库的版本比较后,会根据你当前数据库的版本,然后进行升级。
  4. 关键代码onUpgrade方法,会比较新数据库和旧数据库的版本,然后执行相应的sql升级:
public class MySQLiteOpenHelper extends DaoMaster.OpenHelper  {
    public MySQLiteOpenHelper(Context context, String name) {
        super(context, name);
    }

    public MySQLiteOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
        super(context, name, factory);
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        //数据迁移模块
        MigrationHelper.migrate(db,
                UserDao.class,
                ProfessionDao.class,
                LTestDao.class);
    }
}

数据库升级不外乎两种情况:
  1.修改表结构。
  2.添加新表。

针对onUpgrade中的实现方法可以采用两种不同策略:(稍后都会提供两种策略的代码实现,下面主要讲述第二种数据迁移实现方式)
 1.逐级版本迭代升级,比如当前版本为1,最新版本为3,此方案就是先从1-->2-->3.
 2.把数据库中的数据备份,然后全删数据库,再重新创建新的数据库,把备份数据导入。此方案直接从1-->3。

3. 数据迁移(数据库备份)的具体实现

  1. android上面对的数据库基本上就是轻量级数据库sqlite,首先我们需要了解一些后面需要用到的数据库操作语句:
  • 判断sqlite表是否存在
    SELECT * FROM sqlite_master WHERE type='table' AND name='tempTableName';
  • sqlite判断临时表是否存在
    SELECT * FROM sqlite_temp_master WHERE type='table' AND name='tempTableName';
  • sqlite创建表tableName的临时表
    create temporary table tempTableName as select * from tableName;
  • 删除临时表
    drop table tempTableName;
  1. sqlite的系统表sqlite_master、临时表sqlite_temp_master
    SQLite数据库中一个特殊的名叫 SQLITE_MASTER上执行一个SELECT查询以获得所有表的索引。每一个 SQLite 数据库都有一个叫 SQLITE_MASTER的表, 它定义数据库的模式。 SQLITE_MASTER表看起来如下:
CREATE TABLE sqlite_master ( 
type TEXT, 
name TEXT, 
tbl_name TEXT, 
rootpage INTEGER, 
sql TEXT 
); 

type 字段永远是 ‘table’,name 字段永远是对应表的名字。所以,要获得数据库中所有表的列表, 使用下列SELECT语句:

SELECT name FROM sqlite_master 
WHERE type=’table’ 
ORDER BY name; 

对于索引,type 等于 ‘index’, name 则是索引的名字,tbl_name 是该索引所属的表的名字。 不管是表还是索引,sql 字段是原先用 CREATE TABLE 或 CREATE INDEX 语句创建它们时的命令文本。对于自动创建的索引(用来实现 PRIMARY KEY 或 UNIQUE 约束),sql字段为NULL。
SQLITE_MASTER 表是只读的。不能对它使用 UPDATE、INSERT 或 DELETE。 它会被 CREATE TABLE、CREATE INDEX、DROP TABLE 和 DROP INDEX 命令自动更新。
临时表及其索引和触发器存放在另外一个叫 SQLITE_TEMP_MASTER 的表中。SQLITE_TEMP_MASTER 跟 SQLITE_MASTER 差不多, 但它只是对于创建那些临时表的应用可见。如果要获得所有表的列表, 不管是永久的还是临时的,可以使用类似下面的命令:

SELECT name FROM 
(SELECT * FROM sqlite_master UNION ALL 
SELECT * FROM sqlite_temp_master) 
WHERE type=’table’ 
ORDER BY name
  1. 数据迁移的工具类MigrationHelper
    public final class MigrationHelper {
    public static boolean DEBUG = true;
    private static String TAG = "MigrationHelper";
    private static final String SQLITE_MASTER = "sqlite_master";
    private static final String SQLITE_TEMP_MASTER = "sqlite_temp_master";
    public static void migrate(SQLiteDatabase db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
    Database database = new StandardDatabase(db);

       printLog("【The Old Database Version】" + db.getVersion());
       printLog("【Generate temp table】start");
       generateTempTables(database, daoClasses);
       printLog("【Generate temp table】complete");
    
       dropAllTables(database, true, daoClasses);
       createAllTables(database, false, daoClasses);
    
       printLog("【Restore data】start");
       restoreData(database, daoClasses);
       printLog("【Restore data】complete");
     }
     private static void generateTempTables(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses)   {
       for (int i = 0; i < daoClasses.length; i++) {
         String tempTableName = null;
    
         DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
         String tableName = daoConfig.tablename;
         if (!isTableExists(db, false, tableName)) {//不存在系统表中,表明是新增表,不需要创建临时表
             printLog("【New Table】" + tableName);
             continue;
         }
         try {
             tempTableName = daoConfig.tablename.concat("_TEMP");
             StringBuilder dropTableStringBuilder = new StringBuilder();
             dropTableStringBuilder.append("DROP TABLE IF EXISTS ").append(tempTableName).append(";");
             db.execSQL(dropTableStringBuilder.toString());
    
             StringBuilder insertTableStringBuilder = new StringBuilder();
             insertTableStringBuilder.append("CREATE TEMPORARY TABLE ").append(tempTableName);
             insertTableStringBuilder.append(" AS SELECT * FROM ").append(tableName).append(";");
             db.execSQL(insertTableStringBuilder.toString());
             printLog("【Table】" + tableName +"\n ---Columns-->"+getColumnsStr(daoConfig));
             printLog("【Generate temp table】" + tempTableName);
         } catch (SQLException e) {
             Log.e(TAG, "【Failed to generate temp table】" + tempTableName, e);
         }
      }
     }
    
    private static boolean isTableExists(Database db, boolean isTemp, String tableName) {
     if (db == null || TextUtils.isEmpty(tableName)) {
         return false;
     }
     String dbName = isTemp ? SQLITE_TEMP_MASTER : SQLITE_MASTER;
     String sql = "SELECT COUNT(*) FROM " + dbName + " WHERE type = ? AND name = ?";
     Cursor cursor=null;
     int count = 0;
     try {
         cursor = db.rawQuery(sql, new String[]{"table", tableName});
         if (cursor == null || !cursor.moveToFirst()) {
             return false;
         }
         count = cursor.getInt(0);
     } catch (Exception e) {
         e.printStackTrace();
     } finally {
         if (cursor != null)
             cursor.close();
     }
     return count > 0;
    }
    private static String getColumnsStr(DaoConfig daoConfig) {
     if (daoConfig == null) {
         return "no columns";
     }
     StringBuilder builder = new StringBuilder();
     for (int i = 0; i < daoConfig.allColumns.length; i++) {
         builder.append(daoConfig.allColumns[i]);
         builder.append(",");
     }
     if (builder.length() > 0) {
         builder.deleteCharAt(builder.length() - 1);
     }
     return builder.toString();
    }
     private static void dropAllTables(Database db, boolean ifExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
     reflectMethod(db, "dropTable", ifExists, daoClasses);
     printLog("【Drop all table】");
      }
      private static void createAllTables(Database db, boolean ifNotExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
     reflectMethod(db, "createTable", ifNotExists, daoClasses);
     printLog("【Create all table】");
     }
     /**
      * dao class already define the sql exec method, so just invoke it
      */
     private static void reflectMethod(Database db, String methodName, boolean isExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
     if (daoClasses.length < 1) {
         return;
     }
     try {
         for (Class cls : daoClasses) {
             Method method = cls.getDeclaredMethod(methodName, Database.class, boolean.class);
             method.invoke(null, db, isExists);
         }
     } catch (NoSuchMethodException e) {
         e.printStackTrace();
     } catch (InvocationTargetException e) {
         e.printStackTrace();
     } catch (IllegalAccessException e) {
         e.printStackTrace();
     }
    }
    private static void restoreData(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
     for (int i = 0; i < daoClasses.length; i++) {
         DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
         String tableName = daoConfig.tablename;
         String tempTableName = daoConfig.tablename.concat("_TEMP");
    
         if (!isTableExists(db, true, tempTableName)) {
             continue;
         }
    
         try {
             // get all columns from tempTable, take careful to use the columns list
             List<String> columns = getColumns(db, tempTableName);
             ArrayList<String> properties = new ArrayList<>(columns.size());
             for (int j = 0; j < daoConfig.properties.length; j++) {
                 String columnName = daoConfig.properties[j].columnName;
                 if (columns.contains(columnName)) {
                     properties.add(columnName);
                 }
             }
             if (properties.size() > 0) {
                 final String columnSQL = TextUtils.join(",", properties);
    
                 StringBuilder insertTableStringBuilder = new StringBuilder();
                 insertTableStringBuilder.append("INSERT INTO ").append(tableName).append(" (");
                 insertTableStringBuilder.append(columnSQL);
                 insertTableStringBuilder.append(") SELECT ");
                 insertTableStringBuilder.append(columnSQL);
                 insertTableStringBuilder.append(" FROM ").append(tempTableName).append(";");
                 db.execSQL(insertTableStringBuilder.toString());
                 printLog("【Restore data】 to " + tableName);
             }
             StringBuilder dropTableStringBuilder = new StringBuilder();
             dropTableStringBuilder.append("DROP TABLE ").append(tempTableName);
             db.execSQL(dropTableStringBuilder.toString());
             printLog("【Drop temp table】" + tempTableName);
         } catch (SQLException e) {
             Log.e(TAG, "【Failed to restore data from temp table 】" + tempTableName, e);
         }
     }
    }
    private static List<String> getColumns(Database db, String tableName) {
     List<String> columns = null;
     Cursor cursor = null;
     try {
         cursor = db.rawQuery("SELECT * FROM " + tableName + " limit 0", null);
         if (null != cursor && cursor.getColumnCount() > 0) {
             columns = Arrays.asList(cursor.getColumnNames());
         }
     } catch (Exception e) {
         e.printStackTrace();
     } finally {
         if (cursor != null)
             cursor.close();
         if (null == columns)
             columns = new ArrayList<>();
     }
     return columns;
    }
    private static void printLog(String info){
     if(DEBUG){
         Log.d(TAG, info);
     }
    }
    }
    

4. 设置数据库路径

在第一模块中有句代码:
MySQLiteOpenHelper devOpenHelper = new MySQLiteOpenHelper(new GreenDaoContext(), "database_name.db", null);//GreenDaoContext为创建数据库路径使用
里面有个上下文GreenDaoContext继承了ContextWrapper,里面设置了数据库路径,代码如下:

public class GreenDaoContext  extends ContextWrapper {

    private String currentUserId = "greendao";//一般用来针对一个用户一个数据库,以免数据混乱问题
    private Context mContext;

    public GreenDaoContext() {
        super(MyApplication.getContext());
        this.mContext = MyApplication.getContext();
//        this.currentUserId = "greendao";//初始化
    }

    /**
     * 获得数据库路径,如果不存在,则创建对象
     *
     * @param dbName
     */
    @Override
    public File getDatabasePath(String dbName) {
        String dbDir = CommonUtils.getDBPath();
        if (TextUtils.isEmpty(dbDir)){
            Log.e("SD卡管理:", "SD卡不存在,请加载SD卡");
            return null;
        }
        File baseFile = new File(dbDir);
        // 目录不存在则自动创建目录
        if (!baseFile.exists()){
            baseFile.mkdirs();
        }
        StringBuffer buffer = new StringBuffer();
        buffer.append(baseFile.getPath());
        buffer.append(File.separator);
        buffer.append(currentUserId);
        dbDir = buffer.toString();// 数据库所在目录
        buffer.append(File.separator);
//        buffer.append(dbName+"_"+currentUserId);//也可以采用此种方式,将用户id与表名联系到一块命名
        buffer.append(dbName);
        String dbPath = buffer.toString();// 数据库路径
        // 判断目录是否存在,不存在则创建该目录
        File dirFile = new File(dbDir);
        if (!dirFile.exists()){
            dirFile.mkdirs();
        }
        // 数据库文件是否创建成功
        boolean isFileCreateSuccess = false;
        // 判断文件是否存在,不存在则创建该文件
        File dbFile = new File(dbPath);
        if (!dbFile.exists()) {
            try {
                isFileCreateSuccess = dbFile.createNewFile();// 创建文件
            } catch (IOException e) {
                e.printStackTrace();
            }
        } else
            isFileCreateSuccess = true;
        // 返回数据库文件对象
        if (isFileCreateSuccess)
            return dbFile;
        else
            return super.getDatabasePath(dbName);
    }

    /**
     * 重载这个方法,是用来打开SD卡上的数据库的,android 2.3及以下会调用这个方法。
     *
     * @param name
     * @param mode
     * @param factory
     */
    @Override
    public SQLiteDatabase openOrCreateDatabase(String name, int mode,
                                               SQLiteDatabase.CursorFactory factory) {
        SQLiteDatabase result = SQLiteDatabase.openOrCreateDatabase(getDatabasePath(name), factory);
        return result;
    }

    /**
     * Android 4.0会调用此方法获取数据库。
     *
     * @param name
     * @param mode
     * @param factory
     * @param errorHandler
     * @see android.content.ContextWrapper#openOrCreateDatabase(java.lang.String, int,
     * android.database.sqlite.SQLiteDatabase.CursorFactory,
     * android.database.DatabaseErrorHandler)
     */
    @Override
    public SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory,
                                               DatabaseErrorHandler errorHandler) {
        SQLiteDatabase result = SQLiteDatabase.openOrCreateDatabase(getDatabasePath(name), factory);

        return result;
    }

}

OK,先到这了。。。
源码奉上,自行参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容