从入门到精通：Objectify查询API实战指南（含10个常用示例）-拓冰建站

从入门到精通：Objectify查询API实战指南（含10个常用示例）

【免费下载链接】objectifyThe simplest convenient interface to the Google Cloud Datastore项目地址: https://gitcode.com/gh_mirrors/ob/objectify

Objectify是Google Cloud Datastore的简化接口工具，它提供了强大而直观的查询API，让开发者能够轻松地从数据存储中检索所需信息。本文将通过10个实用示例，帮助你快速掌握Objectify查询API的使用方法，提升数据操作效率。

一、基础查询：获取实体列表

最基本的查询操作是获取指定类型的所有实体。通过load().type()方法指定实体类型，然后使用list()或iterable()方法获取结果：

// 获取所有Trivial实体 List<Trivial> allTrivials = ofy().load().type(Trivial.class).list();

这行代码会返回数据存储中所有Trivial类型的实体。list()方法会将所有结果一次性加载到内存中，适合数据量较小的情况。如果数据量较大，建议使用iterable()方法进行流式处理：

// 流式处理大量Trivial实体 QueryResultIterable<Trivial> iterable = ofy().load().type(Trivial.class).iterable(); for (Trivial trivial : iterable) { // 处理每个实体 }

二、条件过滤：精准筛选数据

Objectify提供了灵活的条件过滤功能，通过filter()方法可以设置各种查询条件。条件表达式由属性名、操作符和值组成：

// 查询someString属性不等于"foo1"的Trivial实体 List<Trivial> result = ofy().load().type(Trivial.class) .filter("someString !=", "foo1") .list();

常用的操作符包括：

=或省略：等于
!=或<>：不等于
>：大于
<：小于
>=：大于等于
<=：小于等于
IN：在指定集合中
!IN：不在指定集合中

例如，使用IN操作符查询符合多个值的实体：

// 查询someString属性为"foo2"或"foo3"的Trivial实体 List<String> conditions = Arrays.asList("foo2", "foo3"); List<Trivial> result = ofy().load().type(Trivial.class) .filter("someString in", conditions) .list();

三、排序结果：按属性排序

使用order()方法可以对查询结果进行排序。默认是升序排序，在属性名前加-表示降序排序：

// 按someString属性升序排序 List<Trivial> ascending = ofy().load().type(Trivial.class) .order("someString") .list(); // 按someString属性降序排序 List<Trivial> descending = ofy().load().type(Trivial.class) .order("-someString") .list();

四、分页查询：限制结果数量与偏移

当数据量较大时，分页查询是必不可少的。使用limit()方法设置每页显示的记录数，offset()方法设置查询的起始位置：

// 获取第11-20条记录（假设每页10条） List<Trivial> page2 = ofy().load().type(Trivial.class) .limit(10) .offset(10) .list();

五、游标分页：高效的分页方式

相比offset()，使用游标（Cursor）进行分页更加高效，特别是当数据量很大时。游标记录了查询的位置，避免了从头开始扫描：

// 获取第一页数据和游标 Query<Trivial> query = ofy().load().type(Trivial.class).limit(10); QueryResultIterable<Trivial> iterable = query.iterable(); Iterator<Trivial> iterator = iterable.iterator(); List<Trivial> firstPage = new ArrayList<>(); while (iterator.hasNext()) { firstPage.add(iterator.next()); } Cursor cursor = iterable.getCursorAfter(); // 使用游标获取下一页数据 List<Trivial> secondPage = ofy().load().type(Trivial.class) .limit(10) .startAt(cursor) .list();

六、投影查询：只获取需要的属性

当只需要实体的部分属性时，可以使用投影查询来提高性能，减少数据传输量：

// 只获取Trivial实体的someString属性 List<Trivial> projections = ofy().load().type(Trivial.class) .project("someString") .list();

七、键查询：通过键获取实体

使用keys()方法可以只获取实体的键，而不是完整实体。这在只需要键的场景下非常有用：

// 获取所有Trivial实体的键 QueryResultIterable<Key<Trivial>> keys = ofy().load().type(Trivial.class).keys().iterable(); for (Key<Trivial> key : keys) { // 处理键 }

也可以通过键来过滤实体：

// 查询指定键的实体 Key<Trivial> key = Key.create(Trivial.class, 123); List<Trivial> result = ofy().load().type(Trivial.class) .filter("__key__ in", Collections.singleton(key)) .list();

八、祖先查询：查询实体组

在Google Cloud Datastore中，实体可以组成实体组，通过祖先查询可以获取整个实体组的实体：

// 查询指定祖先的所有Child实体 Key<Parent> parentKey = Key.create(Parent.class, "parentId"); List<Child> children = ofy().load().type(Child.class) .ancestor(parentKey) .list();

九、命名空间查询：跨命名空间查询

如果你的应用使用了命名空间来隔离数据，可以在查询中指定命名空间：

// 在"foo"命名空间中查询Trivial实体 QueryResultIterable<Key<Trivial>> q1 = ofy().namespace("foo") .load().type(Trivial.class) .keys().iterable();

十、复合查询：组合多个条件

Objectify支持组合多个查询条件，实现复杂的查询需求。多个filter()调用会产生AND关系：

// 查询someString大于"blah"且按__key__降序排序的Trivial实体 Query<Trivial> query = ofy().load().type(Trivial.class) .filter("someString >", "blah") .order("-__key__"); List<Trivial> results = query.list();