史上最高效的ORM方案——GreenDao3.0高级用法

目录

session 缓存

多表关联

多表查询

自定义参数类型

与数据库操作相关的AS插件

session 缓存

如果你有多个相同的查询语句去执行,猜猜看返回给你的对象是一个还是多个?比如说像下面这样

QueryBuilder<Project> projectQueryBuilder = projectDao
.queryBuilder()
.where(ProjectDao.Properties.UserName.eq("123456"));
Query<Project> query = projectQueryBuilder.build();
Project project1=query.unique();
QueryBuilder<Project> projectQueryBuilder1 = projectDao
.queryBuilder()
.where(ProjectDao.Properties.UserName.eq("123456"));
Query<Project> query2 = projectQueryBuilder1.build();
Project project2=query.unique();

答案是project1==project2而且project2查询出来的速度要比project1查询出来的速度快很多倍;

这是因为在同一个session中如果一个entities已经被session记录那么下一次再次操作该实体时,greenDao会先从内存中查找,如果内存中没有再去数据库中查找。这样一方面就极大的提高greenDao的查询效率,另一方面也是需要特别注意的是当entities更新过 greenDao仍然会从内存中取出旧值,所以如果entities更新过,需要去调用daoseesion.clear()方法清除缓存后才能查到最新值,否则查询到的将还是保存在内存中的值。


下面介绍下清除缓存有两种方法

清除所所有的缓存

daoSession.clear();

清除指定Dao类的缓存

projectDao = daoSession.getNoteDao();projectDao.detachAll();

多表关联

1. 1:1关联

当我们在使用sqlite数据库来实现表的1:1关联时,通常我们会在主表中定义一个外键去关联副表,当要查询对应的数据时,首先我们要知道查询数据的外键,然后需要用外键去副表中查询所需要的数据。比如下面这样

public class Customer {
private Long id;
}
public class Order {
private Long id;
private Date date;
private long customerId;
}

Customer表通过id与Order表关联,查询Order的Customer时需要先知道Order中的customerId然后根据id=customerId值再去数据库中查询该id所对应的Customer对象。然而在greenDao中一个注释就可以搞定,只需要使用@ToOne注释来定义一个关联对象即可。

@ToOne 定义了一个entities与另一个entities的1:1对应关系。通过joinProperty参数来定义一个外键下面是代码示例

public class Order {
@Id
private Long id;

private long customerId;

@ToOne(joinProperty = "customerId")
private Customer customer;
}

@Entity
public class Customer {
@Id
private Long id;
}

这样只要获得Order对象就能通过getCustomer()方法获取Order所对应的Customer了,这样是不是很高效,很简便。其实getCustomer方法也很简单,就是在底层帮助我们封装好了查询语句而已,另外getCustomer获取的对象也是懒查询机制,只有真正使用getCustomer方法查询到的对象时greenDao才会执行查询操作。如果你想立即执行查询操作可以调用DAO类的loadDeep()与queryDeep()方法。

2. 1:N 关联

在1对1关联中每个顾客只能与一个订单对应,但是现实生活中肯定不只是这样,也会出现一个顾客下多个订单的情况。如果出现这种需求的话,按照原生Sqlite的思路一样是通过外键关联即可,只是这一次查询的对象会有很多个,但是使用greenDao的1:1关联方式显然不行。不过别担心greenDao还给我们准备了@ToMany注释。

**@ToMany **定义了一个entities(这个标记为源实体)与另一个entities(这个标记为目标实体)的多个对象的关联关系:@Tomany有一下三种方式来定义1:N的映射关系。

referencedJoinProperty 在目标实体中我们需要定义一个与源实体关联起来的外键,即Order中的customerId,然后需要在源实体里我们需要将customerId作为referencedJoinProperty的属性。说起来很拗口,其实代码很简单;

@Entity
public class Customer {
@Id private Long id;

  @ToMany(referencedJoinProperty = "customerId")
  @OrderBy("date ASC")
  private List<Order> orders;

}

@Entity
public class Order {
@Id private Long id;
private Date date;
private long customerId;
}

是不是很简单通过referencedJoinProperty来标注下俩个实体之间的外键即可

joinProperties这个参数是referencedJoinProperty 参数的升级版。在referencedJoinProperty参数中我们发现俩个实体关联的外键是CustomerId与id,但是如果我们的需求是外键不能通过id来定义,需要用自己自定义属性来定义,第一种方法就没法用了,而joinProperties就是为了解决这个需求的。

@Entity
public class Customer {
@Id private Long id;
@Unique private String tag;

  @ToMany(joinProperties = {
          @JoinProperty(name = "tag", referencedName = "customerTag")
  })
  @OrderBy("date ASC")
  private List<Site> orders;

}

@Entity
public class Order {
@Id private Long id;
private Date date;
@NotNull private String customerTag;
}

其实如果把

@ToMany(joinProperties = {
@JoinProperty(name = "id", referencedName = "customerId")
})

这样的话就和第一种方法实现原理是一样的了。

@JoinEntity 定义了N:M的映射关系。

@Entity
public class Product {
@Id private Long id;

  @ToMany
  @JoinEntity(
          entity = JoinProductsWithOrders.class,
          sourceProperty = "productId",
          targetProperty = "orderId"
  )
  private List<Order> ordersWithThisProduct;

}

@Entity
public class JoinProductsWithOrders {
@Id private Long id;
private Long productId;
private Long orderId;
}

@Entity
public class Order {
@Id private Long id;
}

3. 关联表的更新与解析

关联的查询也是懒加载机制,而且查询的结果会保存在缓存中下一次查询的时候如果缓存有会直接从缓存中获取结果。

同样关联表更新时因为有缓存机制的存在你需要将改动的表手动的通过add()方法来更新关联表中的对象或者直接清除缓存。

// 获取当前顾客的订单列表
List<Order> orders1 = customer.getOrders();

// 插入一个新订单
Order order = new Order();
order.setCustomerId(customer.getId());
daoSession.insert(order);

// 再一次获取顾客的订单
List<Order> orders2 = customer.getOrders();

// 因为缓存列表没有更新所以订单1与订单2的大小相等
assert(orders1.size() == orders2.size);
// 也是相同的对象
assert(orders1.equals(orders2));

//调用该方法后,才能更新缓存列表
orders1.add(newOrder);

//删除时也许要手动将缓存列表里面的数据删除
List orders = customer.getOrders();
// 从数据库中移除
daoSession.delete(someOrder);
// 手动从缓存列表移除
orders.remove(someOrder);

//如果数据库更新后不想手动添加数据可以使用resetXX()方法来清除缓存

customer.resetOrders();
List orders = customer.getOrders();

多表查询

有些时候我们的表没有使用ToOneToMany建立关联关系,但是我们又想一步到位。这时我们可以使用greenDao的多表查询功能来帮助我们减少不必要的代码。

1. 关联单个表

//查询地址是住在迪拜大楼的用户
QueryBuilder<User> queryBuilder = userDao.queryBuilder();
queryBuilder.join(Address.class, AddressDao.Properties.userId)
.where(AddressDao.Properties.Street.eq("迪拜大楼"));
List<User> users = queryBuilder.list();

通过queryBuilder.join()方法即可完成,其用法也很简单第一个参数是关联的类,第二个是关联类中的关联属性。

2.关联多个表

//查询在欧洲人口超过100000的城市
QueryBuilder qb = cityDao.queryBuilder().where(Properties.Population.ge(1000000));
Join country = qb.join(Properties.CountryId, Country.class);
Join continent = qb.join(country, CountryDao.Properties.ContinentId,
Continent.class, ContinentDao.Properties.Id);
continent.where(ContinentDao.Properties.Name.eq("Europe"));
List<City> bigEuropeanCities = qb.list();

通过queryBuilder.join()链式调用来实现多表查询

注意:多表查询的前提是我们已经定义好了外键来关联表与表之间的关系。

自定义参数类型

1.默认类型参数 :greenDao默认支持的类型参数如下

boolean, Boolean
int, Integer
short, Short
long, Long
float, Float
double, Double
byte, Byte
byte[]
String
Date

2.自定义类型参数: 如果greenDao的默认参数类型满足不了你的需求,比如你想定义一个颜色属性,那么你可以使用数据库支持的原生数据类型通过PropertyConverter类转换成你想要的颜色属性。

首先你需要给自定义类型参数添加 @Convert注释并添加对应参数
converter:参数转换类,columnType:在数据库中对应的类型

实现PropertyConverter

下面是用通过使用数据库支持的Integer类型来转换成数据库不支持的枚举类型

@Entity
public class User {
@Id
private Long id;

@Convert(converter = RoleConverter.class, columnType = Integer.class)
private Role role;

public enum Role {
DEFAULT(0), AUTHOR(1), ADMIN(2);
final int id;

Role(int id) {
this.id = id;
}
}

public static class RoleConverter implements PropertyConverter<Role, Integer> {
//将Integer值转换成Role值
@Override
public Role convertToEntityProperty(Integer databaseValue) {
if (databaseValue == null) {
return null;
}
for (Role role : Role.values()) {
if (role.id == databaseValue) {
return role;
}
}
return Role.DEFAULT;
}

//将Role值转换成Integer值
@Override
public Integer convertToDatabaseValue(Role entityProperty) {
return entityProperty == null ? null : entityProperty.id;
}
}
}

与数据库相关的AS插件

快速清除数据库本地数据--ADB IDEA

调试工具同时可以快速查看数据表结构和数据--Stetho

感兴趣的同学可以搜索下这俩个插件真的很好用。

后记

上期有同学有同学提问greenDao的多线程同步机制,在这里我简单解释下:
greenDao多线程同步可以通过forCurrentThread()来实现的,具体原理很简单我们看下源码就知道了

  //获取当前线程id
   long threadId = Thread.currentThread().getId();
  //加锁
    synchronized (queriesForThreads) {
        //queryRef是一个Map集合
        WeakReference<Q> queryRef = queriesForThreads.get(threadId);
        Q query = queryRef != null ? queryRef.get() : null;
        if (query == null) {
            gc();
            query = createQuery();
            //保存query
            queriesForThreads.put(threadId, new WeakReference<Q>(query));
        } else {
            System.arraycopy(initialValues, 0, query.parameters, 0, initialValues.length);
        }
        return query;
    }

这是源码的核心部分,从上面我们可以看出greenDao是通过将线程id与query对象存储在Map集合中建立1:N的映射关系,不同线程只会取出属于自己的query而不会调用其他线程的query。

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

推荐阅读更多精彩内容

  • 1. 什么是greenDao 弄明白greenDao之前我们应该先了解什么是ORM(Object Relation...
    看一季残花落幕阅读 2,280评论 0 4
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,293评论 18 399
  • 本文包括:1、Hibernate 的查询方式2、HQL (Hibernate Query Language) 查询...
    廖少少阅读 2,593评论 0 15
  • 感悟:善于观察生活,善于挖掘获取新的资源,订下属于自己的标签。善于运用获取的资源,如果是自己不擅长的,那就寻找擅长...
    Louise718阅读 123评论 2 1