GreenDao3.0系列文章:
GreenDao3.0 源码分析-DaoMaster和DaoSeesion
AbstractDaoMaster
从图中我们知道,DaoMaster和AbstractDaoMaster是父子类的关系,我们先看AbstractDaoMaster:
从上面类图中,我们知道daoMaster维护一个daoConfigMap以Dao.class为key维护一个映射关系,而且通过调用
我们可以知道 AbstractDaoMaster的功能主要职责之一是创建注册DaoConfig,并且维护他和dao之间的关系。
实现类DaoMaster的功能
功能一:创建所有表和删除所有表
通过调用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就是用来存储dao,必要的一些数据的。
DaoConfig,维护了以下的字段:
上图源码可知,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;
}
初始化缓存的策略
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();
}