Android ORM 框架：GreenDao 數據庫升級

本文做者：Speedy
CSDN 專欄：blog.csdn.net/speedystone
掘金專欄：juejin.im/user/57e082…

前言

在 Android ORM 框架：GreenDao 使用詳解（進階篇） 中漏講了一個很是重要的模塊 ( GreenDao 數據庫升級 )，如今補上 。

一，GreenDao 默認的升級方式

GreenDao 默認的升級方式是刪除全部舊版，在從新建新表，這樣一來用戶的本地歷史數據則會丟失，這點咱們經過DaoMaster 的內部類 DevOpenHelper 源碼能夠了解到。

/** WARNING: Drops all table on Upgrade! Use only during development. */
    public static class DevOpenHelper extends OpenHelper {
        public DevOpenHelper(Context context, String name) {
            super(context, name);
        }

        public DevOpenHelper(Context context, String name, CursorFactory factory) {
            super(context, name, factory);
        }

        @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);// 從新建立新表
        }
    }複製代碼

2、自定義升級方式

1，修改 schemaVersion 版本號（schemaVersion 只能往上升，不能降）

greendao {
    schemaVersion 2 //數據庫版本號
    daoPackage 'com.speedystone.greendaodemo.db'// 設置DaoMaster、DaoSession、Dao包名
    targetGenDir 'src/main/java'//設置DaoMaster、DaoSession、Dao目錄
}複製代碼

2，自定義 OpenHelper ：繼承 DaoMaster.OpenHelper，從新 onUpgrade 方法

/**
 * Created by Speedy on 2017/7/4.
 */
public class DbHelper extends DaoMaster.OpenHelper {

    public DbHelper(Context context, String name) {
        super(context, name);
    }

    @Override
    public void onUpgrade(Database db, int oldVersion, int newVersion) {

        Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion );

        if(newVersion == 2){
            // 修改 USER 表
            db.execSQL("ALTER TABLE 'USER' ADD  'NICKNAME' String");
        }
    }
}複製代碼

3，在初始化GreenDao 階段，採用自定義的 OpenHelper 替換 DaoMaster.DevOpenHelper

/**
     * 初始化 GreenDao
     */
    private void initGreenDao() {
     //DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this,"test.db");//默認的

        DbHelper helper = new DbHelper(this,"test.db");//自定義的 OpenHelper 
        SQLiteDatabase db = helper.getWritableDatabase();
        DaoMaster daoMaster = new DaoMaster(db);
        daoSession = daoMaster.newSession();
    }複製代碼

三，注意事項

1, @Id 標記的ID字段，對應數據庫列名會轉化爲 「_id 」

2, 經過註解創建的表若是沒有使用 @Property 指明表列名，默認表中列名是大寫單詞

例如：

@Entity
public class User {

    @Id
    private long userId;

    private String name;

    //指明列名
    @Property(nameInDb = "age")
    private int age;
}複製代碼

對應表結構：