Android ORM 框架 greenDao 3.x 第一篇: 介绍,使用与踩坑

最近接触greenDao3.x,总结一些业务中用到的东西和坑。
greenDao 到3.x之后用法比2.x和1.x时候更加简单,通过对bean类增加注解实现持续化。
许多文章介绍了大致情况,如 http://www.jianshu.com/p/f2737d23cb2a

如何上手和了解大致情况也可以阅读greenDao的官方文档 http://greenrobot.org/greendao/

其他文章介绍的东西就不再重复了,本文总结一下实际应用中用到的一些特性和遇到的坑。
除了注解方式以外,实际上,3.X仍然支持像2.x中的generator的方式来生成相关类。并且generator支持更多新特性,如多schema,生成ContentProvider等,这些功能还不支持通过注解来实现。(见http://greenrobot.org/greendao/documentation/updating-to-greendao-3-and-annotations/

  1. greenDao3.x 原理简介:
    greenDao3.x引入了新的Gradle plugin:greendao-gradle-plugin 。用Gradle插件来生成所需要的类。greenrobot目前还没把gradle插件源码还没放出来。可以见所有注解都是@Retention(RetentionPolicy.SOURCE)。gradle plugin就是根据这些注解,为实体生成对应的各种类。
    主要的类包括:
    (1) DaoMaster :Dao的顶层对象,包含DevOpenHelper内部类,并可以新建DaoSession。获取
    (2) DaoSession :管理各个Dao类,用Map管理了各个Dao类的实例对象(key是Dao的类对象,value是实例对象)。
    (3) xxxDao:与Entity一一对应,管理对应的表,完成从对象到表的增删改查。我们实际对实例对象的操作都是通过该Entity对应的Dao对象完成的。

Database/DaoMaster/DaoSession对象的初始化过长如下:

DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(application,     
DATABASE_NAME, null);
SQLiteDatabase db = helper.getWritableDatabase();
DaoMaster daoMaster = new DaoMaster(db);
mDaoSession = daoMaster.newSession();

此外如果阅读源码还有xxxDaoConfig类。但此类为GreenDao的内部所用,实际不会应用到, 但对理解源码比较有帮助。

  1. 相关注解的实际用法
    (1) Entity:该注解是给bean类的。注意了,greenDao目前只支持一个Entity对应一张表(见https://github.com/greenrobot/greenDAO/issues/455#issuecomment-249790184)。
    一对多或者多对一目前还实现不了。如果有类似需求可以用ToOne 和 ToMany 代替(下文会介绍)。
    Entity的属性:
    indexes:可以用来创建该表的索引。可以与unique一同使用实现唯一索引,如:
@Entity(indexes = {
        @Index(value = "primaryCode, secondCode", unique = true)
})

nameInDb:自定义Entity对应的表名(默认是用类名)
createInDb:是否在数据库中创建该表,源码的注释这么说的:

    /**
     * Advanced flag to disable table creation in the database (when set to false). This can be used to create partial
     * entities, which may use only a sub set of properties. Be aware however that greenDAO does not sync multiple
     * entities, e.g. in caches.
     */

大意是在只需持久化某Entity类中的一部分属性时使用,不是特别理解,实操确实没创建该类的表。但貌似是不能实现多个实体对应到一张表里。希望有高人能解答该属性有何用。
(2).Id:被修饰的域会成为表中的主键,该Id对应了xxxDao类中相关操作中的Key。
(3).Convert:修饰域,如果Entity中的一个域的类型不能直接保存(比如枚举类型)或者该域的值与您想保存到数据库中的类型不一样的话,可以用Convert修改该域实际保存的类型。如下将Convert讲时间(String)转成了Long来保存。

public class TimeConverter implements PropertyConverter<String, Long> {
    private static final String TAG = "TimeConverter";
    static SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public String convertToEntityProperty(Long databaseValue) {
        Log.d(TAG, "convertToEntityProperty:"+formatter.format(new Date(databaseValue)));
        return formatter.format(new Date(databaseValue));
    }

    @Override
    public Long convertToDatabaseValue(String entityProperty) {
        try {
            Log.d(TAG, "convertToDatabaseValue:"+formatter.parse(entityProperty).getTime());
            return formatter.parse(entityProperty).getTime();
        } catch (ParseException e) {
            Log.e(TAG, e.getMessage());
        }
        return null;
    }
}

(4).Index:与Indexs标签一起添加索引,见indexes标签。
(5).ToOne/ToMany:Entity的某个域是Entity,对应数据库的表连接。ToOne为一对一,ToMany为该域是List,对应多个实体。
要用joinProperty属性指明连接的key,该域对应被连接的Entity的Id。
例:

    @ToOne(joinProperty = "amountId")
    private PaymentAmount amount;
    private long amountId;

注意:这里保存和读取时候都有坑:
当存一个Entity的时候,与其ToOne和ToMany的Entity都不会被保存,需要单独再去存每个对象,并且要在设置amountId :如:

    mPaymentAmountDao.insert(paymentAmount);
    record.setAmountId(record.getAmount().getId());
    mPaymentRecordDao.insert(record);
  1. 数据的增删改查:与Entity对应的Dao类提供了对应每个Entity的相关方法。这里列举一些常 用的:
public void save(T entity)
public void delete(T entity)
public void update(T entity)
public long insertOrReplace(T entity)
public void deleteAll()
public Long getKey(PaymentRecord entity) 
public boolean hasKey(PaymentRecord entity)
public List<T> loadAll()
public PaymentRecord loadDeep(Long key)
public List<PaymentRecord> queryDeep(String where, String... selectionArg)
public QueryBuilder<T> queryBuilder()

注意
(1) 如果该Entity有ToMany或者ToOne字段,该Dao类中会有xxxDeep的方法:该方法会一起获取ToMany和ToOne字段,也就是其ToMany和ToOne字段不为空(查询过程中会join相关的表),如果用其他方法查询该对象的ToMany和ToOne字段是null。
其中,queryDeep中的where和selectionArg直接传给数据库做查询,所以需要为数据库的相关字段名而非实体的,可见源码:

    /** A raw-style query where you can pass any WHERE clause and arguments. */
    public List<PaymentRecord> queryDeep(String where, String... selectionArg) {
        Cursor cursor = db.rawQuery(getSelectDeep() + where, selectionArg);
        return loadDeepAllAndCloseCursor(cursor);
    }

(2) queryBuilder
这与SQLiteQueryBuilder不同,queryBuilder方法是直接对应的Entity的字段的,而非数据库。如:

      List<DayRecord> list = mDayRecordDao.queryBuilder()
              .where(DayRecordDao.Properties.CurrencyCode.eq(currencyCode))
              .where(DayRecordDao.Properties.Day.eq(day)).list();

(3) 这里查询是有缓存的:比如:

Long id = record1.getId();//record1已保存过
Record record2 = mRecordDao.loadDeep(id);
boolean isSameObj = (record1 == record2) // true

如果record1被修改,还想读原来数据库中其值,请在loadDeep前调用:daoSession.clear()。

自动生成的xxxDao类的代码可见 dentityScope为缓存,

public abstract class AbstractDao<T, K> {
 ...
protected final IdentityScope<K, T> identityScope;
...
public AbstractDao(DaoConfig config, AbstractDaoSession daoSession) {
       ...
        identityScope = (IdentityScope<K, T>) config.getIdentityScope();
      ...
    }
}

daoSession.clear():

    public void clear() {
        xxxDaoConfig.clearIdentityScope();
    }
  1. 相关的坑:
    (1)不支持Entity继承: Entity类在生成表和Dao类时候,是不支持其父类的相关属性的,即父类中的相关域不会在表中有对应字段。这就导致了所有的model类都不能继承,导致有些model类比较类似,也都需要都写两遍,破坏了代码结构。。蛋疼
    (2)不支持一个Entity对应多表,或多个Entity对应成一个表。蛋疼如上
    (3)不支持一个字段convert成多字段,智能convert成一个其他字段。蛋疼如上
    (4)注解方式不支持provider生成:不能自动生成provider。generator方式可以,但provider的功能还没完善。所以如果工程需要跨进程提供数据则还需要手动写provider。

总结:整体来讲,GreenDao 作为对象持久化框架还是比较好用,但不足也比较明显:Entity的灵活性不足,有时Bean类的一些由于业务上的设计并不适合直接转成数据库表存储,而Entity映射到数据库表的方法灵活性不高,导致表结构和Bean类的结构要互相迁就。
接下来后续还会再去总结GreenDao的数据库升级/加密等。

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

推荐阅读更多精彩内容