GreenDao 详解

GreenDao 简介

GreenDAO 是一款开源的面向 Android 的轻便、快捷的 ORM 框架，将 Java 对象映射到 SQLite 数据库中，我们操作数据库的时候，不在需要编写复杂的 SQL语句， 在性能方面，GreenDAO 针对 Android 进行了高度优化， 最小的内存开销 、依赖体积小 同时还是支持数据库加密。

GreenDAO 官网地址：http://greenrobot.org/greendao/

PS： 官网上，GreenDAO官方推荐最新的应用使用最好使用新的数据库框架 ObjectBox。

升级的问题：

主键问题：

默认可以用@Id来设置主键，但是如果需要复合主键的要怎么处理呢:

如果是sql可以这样写：

create table test 
( 
   name varchar(19), 
   id number, 
   value varchar(10), 
   primary key (name,id) 
) 

但是 GreenDao 需要使用 约束来实现： 是个例子：

@Entity(nameInDb = "MoodBean", indexes = {@Index(value = "id,uid", unique = true)})
public class MoodBean {

    /**
     * 20180827 日期转为数值
     */
    public long id = 0;
    /**
     * 用户Id
     */
    public String uid = "";
    /**
     * 当前日期字符串，：如2018-08-28
     */
    public String date = "";

    /**
     * 心情类型： 0：未选择：
     */
    public int moodType = 0;

    }

主键最好是用基础类型的包装类，如果是基础类型，GreenDao转化为SQL的时候会要求自动加上 not null 限制。
long ，int 等会对应是数据库的 INTEGER

"CREATE TABLE " + constraint + "\"RecordBean\" (" + //
                "\"ID\" INTEGER NOT NULL ," + // 0: id
                "\"UID\" TEXT," + // 1: uid

数据库升级

自动生成的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);    
  }
}

可以看到，数据库默认的行为是：删掉所有数据库，在重新建数据库。

但是这样会 导致已经存在的数据都被清掉。因此我需要继承OpenHelper来实现自己的数据库升级方法：

public class CalendarDaoOpenHelper extends DaoMaster.OpenHelper {
    public CalendarDaoOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
        super(context, name, factory);
    }

    @Override
    public void onUpgrade(Database db, int oldVersion, int newVersion) {
        super.onUpgrade(db, oldVersion, newVersion);
        if (oldVersion == newVersion) {
            return;
        }
        LogUtil.d(String.format("版本升级：oldVersion= %s,newVersion= %s ", oldVersion, newVersion));
        switch (oldVersion) {
            case 1:
            //todo
            break;
            case 2:
            //todo
            break;
            default:
                break;

        }
    }

}

或者使用GitHub上现成的库：

https://github.com/yuweiguocn/GreenDaoUpgradeHelper

通过 MigrationHelper 在删表重建的过程中，使用临时表保存数据并还原。

public class MySQLiteOpenHelper extends DaoMaster.OpenHelper {
    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, TestDataDao.class, TestData2Dao.class, TestData3Dao.class);
    }
}

// 初始化
MigrationHelper.DEBUG = true; //如果你想查看日志信息，请将 DEBUG 设置为 true
MySQLiteOpenHelper helper = new MySQLiteOpenHelper(this, "test.db", null);
DaoMaster daoMaster = new DaoMaster(helper.getWritableDatabase());

translate缓存问题

对象字段用 @translate 标识，代表这个字段不会被保存到数据库中。但是会被缓存到是内存。
如果要 让下次查询的 对象字段还原，需要调用方法来强制清除缓存：

 com.babytree.apps.pregnancy.db.DaoSession#clear