GreenDao3.0 源码分析-DaoMaster和DaoSeesion

GreenDao3.0系列文章:

GreenDao3.0源码分析-Helper

GreenDao3.0 源码分析-DaoMaster和DaoSeesion

GreenDao3.0 源码分析-Dao层

AbstractDaoMaster

image

从图中我们知道,DaoMaster和AbstractDaoMaster是父子类的关系,我们先看AbstractDaoMaster:

image

从上面类图中,我们知道daoMaster维护一个daoConfigMap以Dao.class为key维护一个映射关系,而且通过调用

image

我们可以知道 AbstractDaoMaster的功能主要职责之一是创建注册DaoConfig,并且维护他和dao之间的关系。

实现类DaoMaster的功能

功能一:创建所有表和删除所有表

image

通过调用XXXDAO的静态方法来进行建表和删表。

功能二:创建Session会话

public DaoSession newSession() {
    return new DaoSession(db, IdentityScopeType.Session, daoConfigMap);
}

public DaoSession newSession(IdentityScopeType type) {
    return new DaoSession(db, type, daoConfigMap);
}

两个创建的默认数据缓存的类型,一个是随我们定义的类型,IdentityScopeType定义了两个类型,后面再说。

功能三:注册Config:

 public DaoMaster(Database db) {
        super(db, SCHEMA_VERSION);
      registerDaoClass(NoteDao.class);
}

创建DaoMaster对象的时候以 Class<?> 来作为key,对DaoConfig进行配置缓存绑定。

功能四:定义内部类OpenHelper和DevOpenHelper。

Dao配置类DaoConfig

源码对DaoConfig是这样评价的:在GreenDao内部使用,通过AbstractDaoMaster创建和持有其对象,存储一些DAO实体所必须的数据。这个类实例能通过以Dao class为Key ,使用map维护,通过key取出必要的信息。

也就是说,DaoConfig就是用来存储dao,必要的一些数据的。

DaoConfig,维护了以下的字段:

image

上图源码可知,DaoConfig 维护了数据库对象、数据库名称、Dao实体类表所有的属性对应关系等,并且这些字段都是在这个类进行初始化的,核心功能有两个。

根据xxxDao.class反射获得属性对象:

private static Property[] reflectProperties(Class<? extends AbstractDao<?, ?>> daoClass)
        throws ClassNotFoundException, IllegalArgumentException, IllegalAccessException {
    Class<?> propertiesClass = Class.forName(daoClass.getName() + "$Properties");
    Field[] fields = propertiesClass.getDeclaredFields();

    ArrayList<Property> propertyList = new ArrayList<Property>();
    //根据反射的字段 拿出静态和公开的属性对象
    final int modifierMask = Modifier.STATIC | Modifier.PUBLIC;
    for (Field field : fields) {
        //有些工具可能会引入其他字段,可以忽略它们
        if ((field.getModifiers() & modifierMask) == modifierMask) {
            Object fieldValue = field.get(null);
            if (fieldValue instanceof Property) {
                propertyList.add((Property) fieldValue);
            }
        }
    }
    //列表转成数组,并通过序号进行排序
    Property[] properties = new Property[propertyList.size()];
    for (Property property : propertyList) {
        if (properties[property.ordinal] != null) {
            throw new DaoException("Duplicate property ordinals");
        }
        properties[property.ordinal] = property;
    }
    return properties;
}</pre>

初始化缓存的策略

public enum IdentityScopeType {
        Session, None
}

数据库缓存的种类有两种。Session,就是使用内存缓存,None就是不使用内存缓存。

public void initIdentityScope(IdentityScopeType type) {
    if (type == IdentityScopeType.None) {
        identityScope = null;
    } else if (type == IdentityScopeType.Session) {
        if (keyIsNumeric) {
            identityScope = new IdentityScopeLong();
        } else {
            identityScope = new IdentityScopeObject();
        }
    } else {
        throw new IllegalArgumentException("Unsupported type: " + type);
    }
}

可以看到,当我们创建Dao之前会调用这个方法,就说明,如果type==IdentityScopeType.None没有内存缓存,反之会根据主键的类型,赋予内存缓存的管理对象。

还有其他功能就是对TableStatements初始化,判断主键是否是数字类型,分拣主键的数据和非主键的数组,记录所有属性行等大家可以看源码,都比较简单。

Property、TableStatements是两个非常重要的对象,留待后面我们再讲。

AbstractDaoSession

AbstractDaoSession维护是的Dao.calss对应AbstractDao的关系,AbstractDao是所有实体Dao对象的父类,AbstractDaoSession里面就是实现一个从映射表中取出AbstractDao对象来进行增删改查的操作,也提供了runInTx(Runnable runnable)在事务中做任务不需要返回结果,和callInTx(Callable<V> callable)在事务中做任务并且等待结果等一些方法。

注:一些关于Rx和异步的操作留待后面统一再说。

DaoSession

DaoSession是一个Dao会话,首先我们看构造方法中的初始化

  public DaoSession(Database db, IdentityScopeType type, Map<Class<? extends AbstractDao<?, ?>>, DaoConfig>
        daoConfigMap) {
    super(db);

    //根据Class<?>取出配置信息
    noteDaoConfig = daoConfigMap.get(NoteDao.class).clone();
    //根据Session的缓存类型初始化定制的缓存范围
    noteDaoConfig.initIdentityScope(type);
    //根据配置初始化得到一个NoteDao实体
    noteDao = new NoteDao(noteDaoConfig, this);
    //注册到映射表中
    registerDao(Note.class, noteDao);
}

由注释可知,DaoSession会创建我们需要的Dao对象并注册到映射表中管理起来。

每个Dao还会生成这样的格式的语句,所以我们可以根据Session对象直接获取到XXDao:

public XXDao getxxDao() {
    return xxDao;
}

还有一个清除所有内存缓存的方法:

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

推荐阅读更多精彩内容