跳到主要内容

数据存储开发指南 · Flutter

数据存储是云服务提供的核心功能之一，可用于存放和查询应用数据。下面的代码展示了如何创建一个对象并将其存入云端：

// 构建对象
LCObject todo = LCObject("Todo");
// 为属性赋值
todo["title"] = "工程师周会";
todo["content"] = "周二两点，全体成员";
// 将对象保存到云端
await todo.save();

我们为各个平台或者语言开发的 SDK 在底层都是通过 HTTPS 协议调用统一的 REST API，提供完整的接口对数据进行各类操作。

SDK 安装与初始化​

请阅读 Flutter 安装指南。

对象​

LCObject​

LCObject 是云服务对复杂对象的封装，每个 LCObject 包含若干与 JSON 格式兼容的属性值对（也称键值对，key-value pairs）。这个数据是无模式化的（schema free），意味着你不需要提前标注每个 LCObject 上有哪些 key，你只需要随意设置键值对就可以，云端会保存它。

比如说，一个保存着单个 Todo 的 LCObject 可能包含如下数据：

title:      "给小林发邮件确认会议时间",
isComplete: false,
priority:   2,
tags:       ["工作", "销售"]

数据类型​

LCObject 支持的数据类型包括 String、Number、Boolean、Object、Array、Date 等等。你可以通过嵌套的方式在 Object 或 Array 里面存储更加结构化的数据。

LCObject 还支持两种特殊的数据类型 Pointer 和 File，可以分别用来存储指向其他 LCObject 的指针以及二进制数据。

LCObject 同时支持 GeoPoint，可以用来存储地理位置信息。参见 GeoPoint。

以下是一些示例：

// 基本类型
int numberValue = 2018;
bool boolValue = true;
String stringValue = 'hello, world';
DateTime now = DateTime.now();
List intList = [1, 2, 3];
Map<String, dynamic> stringMap = {
  'year': 1780,
  'first': 'partridge',
  'second': 'turtledoves',
  'fifth': 'golden rings'
};

// 构建对象
LCObject object = new LCObject('Hello');
object['numberValue'] = numberValue;
object['boolValue'] = boolValue;
object['stringValue'] = stringValue;
object['time'] = now;
object['intList'] = intList;
object['stringMap'] = stringMap;

我们不推荐通过 Uint8List 在 LCObject 里面存储图片、文档等大型二进制数据。每个 LCObject 的大小不应超过 128 KB。如需存储大型文件，可创建 LCFile 实例并将将其关联到 LCObject 的某个属性上。参见 文件。

注意：时间类型在云端将会以 UTC 时间格式存储，但是客户端在读取之后会转化成本地时间。

云服务控制台 > 数据存储 > 结构化数据 中展示的日期数据也会依据操作系统的时区进行转换。一个例外是当你通过 REST API 获得数据时，这些数据将以 UTC 呈现。你可以手动对它们进行转换。

若想了解云服务是如何保护应用数据的，请阅读数据和安全。

构建对象​

下面的代码构建了一个 class 为 Todo 的 LCObject：

LCObject object = LCObject('Todo');

在构建对象时，为了使云端知道对象属于哪个 class，需要将 class 的名字作为参数传入。你可以将云服务里面的 class 比作关系型数据库里面的表。一个 class 的名字必须以字母开头，且只能包含数字、字母和下划线。

保存对象​

下面的代码将一个 class 为 Todo 的对象存入云端：

// 构建对象
LCObject todo = LCObject("Todo");
// 为属性赋值
todo['title'] = '马拉松报名';
todo['priority'] = 2;
// 将对象保存到云端
await todo.save();

为了确认对象已经保存成功，我们可以到 云服务控制台 > 数据存储 > 结构化数据 > Todo 里面看一下，应该会有一行新的数据产生。点一下这个数据的 objectId，应该能看到类似这样的内容：

{
  "title":     "马拉松报名",
  "priority":  2,
  "ACL": {
    "*": {
      "read":  true,
      "write": true
    }
  },
  "objectId":  "582570f38ac247004f39c24b",
  "createdAt": "2017-11-11T07:19:15.549Z",
  "updatedAt": "2017-11-11T07:19:15.549Z"
}

注意，无需在 云服务控制台 > 数据存储 > 结构化数据 里面创建新的 Todo class 即可运行前面的代码。如果 class 不存在，它将自动创建。

以下是一些对象的内置属性，会在对象保存时自动创建，无需手动指定：

内置属性类型描述
objectIdString该对象唯一的 ID 标识。
ACLLCACL该对象的权限控制，实际上是一个 JSON 对象，控制台做了展现优化。
createdAtDateTime该对象被创建的时间。
updatedAtDateTime该对象最后一次被修改的时间。

这些属性的值会在对象被存入云端时自动填入，代码中尚未保存的 LCObject 不存在这些属性。

属性名（keys）只能包含字母、数字和下划线。自定义属性不得以双下划线（__）开头或与任何系统保留字段和内置属性（ACL、className、createdAt、objectId 和 updatedAt）重名，无论大小写。

属性值（values）可以是字符串、数字、布尔值、数组或字典（任何能以 JSON 编码的数据）。参见 数据类型。

我们推荐使用驼峰式命名法（CamelCase）为类和属性来取名。类，采用大驼峰法，如 CustomData。属性，采用小驼峰法，如 imageUrl。

获取对象​

对于已经保存到云端的 LCObject，可以通过它的 objectId 将其取回：

LCQuery<LCObject> query = LCQuery('Todo');
LCObject todo = await query.get('582570f38ac247004f39c24b');
// todo 就是 objectId 为 582570f38ac247004f39c24b 的 Todo 实例
String title = todo['title'];
int priority = todo['priority'];

// 获取内置属性
String objectId = todo.objectId;
DateTime updatedAt = todo.updatedAt;
DateTime createdAt = todo.createdAt;

对象拿到之后，可以通过 get 方法来获取各个属性的值。注意 objectId、updatedAt和createdAt 这三个内置属性不能通过 get 获取或通过 set 修改，只能由云端自动进行填充。尚未保存的 LCObject 不存在这些属性。

如果你试图获取一个不存在的属性，SDK 不会报错，而是会返回 null。

LCObject todo = LCObject.createWithoutData('Todo', '582570f38ac247004f39c24b');
await todo.fetch();
//todo 已刷新
LCObject todo = LCObject.createWithoutData('Todo', '582570f38ac247004f39c24b');
await todo.fetch(includes: ['priority','location']);
// 只有 priority 和 location 会被获取和刷新

更新对象​

要更新一个对象，只需指定需要更新的属性名和属性值，然后调用 save 方法。例如：

LCObject todo = LCObject.createWithoutData('Todo', '582570f38ac247004f39c24b');
todo['content'] = '这周周会改到周三下午三点。';
await todo.save();

云服务会自动识别需要更新的属性并将对应的数据发往云端，未更新的属性会保持原样。

try {
  LCObject account = LCObject.createWithoutData('Account', '5745557f71cfe40068c6abe0');
  // 对 balance 原子减少 100
  int amount = -100;
  account.increment('balance', amount);
// 设置条件
  LCQuery<LCObject> query = LCQuery('Account');
  query.whereGreaterThanOrEqualTo('balance', -amount);
  // 操作结束后，返回最新数据。
  // 如果是新对象，则所有属性都会被返回，
  // 否则只有更新的属性会被返回。
  await account.save(fetchWhenSave: true, query: query);
  print('当前余额为：${account['balance']}');
} on LCException catch (e) {
  if (e.code == 305) {
    print("余额不足，操作失败！");
  }
}

更新计数器​

设想我们正在开发一个微博，需要统计一条微博有多少个赞和多少次转发。由于赞和转发的操作可能由多个客户端同时进行，直接在本地更新数字并保存到云端的做法极有可能导致差错。为保证计数的准确性，可以通过 原子操作 来增加或减少一个属性内保存的数字：

post.increment('likes',1);

可以指定需要增加或减少的值。若未指定，则默认使用 1。

注意，虽然原子增减支持浮点数，但因为底层数据库的浮点数存储格式限制，会有舍入误差。 因此，需要原子增减的字段建议使用整数以避免误差，例如 3.14 可以存储为 314，然后在客户端进行相应的转换。 否则，以比较大小为条件查询对象的时候，需要特殊处理， < a 需改查 < a + e，> a 需改查 > a - e，== a 需改查 > a - e 且 < a + e，其中 e 为误差范围，据所需精度取值，比如 0.0001。

更新数组​

更新数组也是原子操作。使用以下方法可以方便地维护数组类型的数据：

  • add(key, value) 将指定对象附加到数组末尾。
  • addAll(key, values) 将一组对象附加到数组末尾。
  • addUnique(key, value) 将指定对象附加到数组末尾，确保对象唯一。
  • addAllUnique(key, values) 将指定对象数组附加到数组末尾，确保对象唯一。
  • remove(key, value) 从数组字段中删除指定对象的所有实例。
  • removeAll(key, values) 从数组对象中删除指定数组中的所有对象。

例如，Todo 用一个 alarms 属性保存所有闹钟的时间。下面的代码将多个时间加入这个属性：

DateTime alarm1 = DateTime.parse('2018-04-30 07:10:00Z');
DateTime alarm2 = DateTime.parse('2018-04-30 07:20:00Z');
DateTime alarm3 = DateTime.parse('2018-04-30 07:30:00Z');

LCObject todo = LCObject("Todo");
todo.addAllUnique('alarms', [alarm1, alarm2, alarm3]);
await todo.save();

删除对象​

下面的代码从云端删除一个 Todo 对象；

LCObject todo = LCObject.createWithoutData('Todo', '582570f38ac247004f39c24b');
await todo.delete();

如果只需删除对象的一个属性，可以用 unset：

LCObject todo = LCObject.createWithoutData('Todo', '582570f38ac247004f39c24b');

// priority 属性会被删除
todo.unset('priority');

// 保存对象
await todo.save();

注意，删除对象是一个较为敏感的操作，我们建议你阅读ACL 权限管理开发指南来了解潜在的风险。熟悉 class 级别、对象级别和字段级别的权限可以帮助你有效阻止未经授权的操作。

批量操作​

可以在一次请求中包含多个构建、保存、删除和同步对象的操作：

// 批量构建和更新
LCObject.saveAll();

// 批量删除
LCObject.deleteAll();

// 批量同步
LCObject.fetchAll();

下面的代码将所有 Todo 的 isComplete 设为 true：

LCQuery<LCObject> query = LCQuery('Todo');
List<LCObject> results = await query.find();
// 获取需要更新的 todo
for (LCObject todo in results) {
  // 更新属性值
  todo['isComplete'] = true;
}
await LCObject.saveAll(results);

虽然上述方法可以在一次请求中包含多个操作，每一个分别的保存或同步操作在计费时依然会被算作一次请求，而所有的删除操作则会被合并为一次请求。

数据模型​

对象之间可以产生关联。拿一个博客应用来说，一个 Post 对象可以与许多个 Comment 对象产生关联。云服务支持三种关系：一对一、一对多、多对多。

一对一、一对多关系​

一对一、一对多关系可以通过将 LCObject 保存为另一个对象的属性值的方式产生。比如说，让博客应用中的一个 Comment 指向一个 Post。

下面的代码会创建一个含有单个 Comment 的 Post：

// 创建 post
LCObject post = LCObject("Post");
post['title'] = '饿了……';
post['content'] = '中午去哪吃呢?';

// 创建 comment
LCObject comment = LCObject("Comment");
comment['content'] = '当然是肯德基啦!';

// 将 post 设为 comment 的一个属性值
comment['parent'] = post;

// 保存 comment 会同时保存 post
await comment.save();

云端存储时，会将被指向的对象用 Pointer 的形式存起来。你也可以用 objectId 来指向一个对象：

LCObject post = LCObject.createWithoutData('Post', '57328ca079bc44005c2472d0');
comment['post'] = post;

请参阅 关系查询 来了解如何获取关联的对象。

多对多关系​

想要建立多对多关系，最简单的办法就是使用 数组。在大多数情况下，使用数组可以有效减少查询的次数，提升程序的运行效率。但如果有额外的属性需要附着于两个 class 之间的关联，那么使用 中间表 可能是更好的方式。注意这里说到的额外的属性是用来描述 class 之间的关系的，而不是任何单一的 class 的。

我们建议你在任何一个 class 的对象数量超出 100 的时候考虑使用中间表。

序列化和反序列化​

在实际的开发中，把 LCObject 当作参数传递的时候，会涉及到复杂对象的拷贝的问题，因此 LCObject 也提供了序列化和反序列化的方法。

序列化：

LCObject object = LCObject('Hello');
object['title'] = '马拉松报名';
object['priority'] = 2;
object['owner'] = LCUser.getCurrent();
String serializedString = object.toString();

反序列化：

LCObject newObject = LCObject.parseObject(json);
await newObject.save();

查询​

我们已经了解到如何从云端获取单个 LCObject，但你可能还会有一次性获取多个符合特定条件的 LCObject 的需求，这时候就需要用到 LCQuery 了。

基础查询​

执行一次基础查询通常包括这些步骤：

  1. 构建 LCQuery；
  2. 向其添加查询条件；
  3. 执行查询并获取包含满足条件的对象的数组。

下面的代码获取所有 lastName 为 Smith 的 Student：

LCQuery<LCObject> query = LCQuery('Student');
query.whereEqualTo('lastName', 'Smith');
// students 是包含满足条件的 Student 对象的数组
List<LCObject> students = await query.find();

查询条件​

可以给 LCObject 添加不同的条件来改变获取到的结果。

下面的代码查询所有 firstName 不为 Jack 的对象：

query.whereNotEqualTo('firstName', 'Jack');

对于能够排序的属性（比如数字、字符串），可以进行比较查询：

// 限制 age < 18
query.whereLessThan('age', 18);

// 限制 age <= 18
query.whereLessThanOrEqualTo('age', 18);

// 限制 age > 18
query.whereGreaterThan('age', 18);

// 限制 age >= 18
query.whereGreaterThanOrEqualTo('age', 18);

可以在同一个查询中设置多个条件，这样可以获取满足所有条件的结果。可以理解为所有的条件是 AND 的关系：

query.whereEqualTo('firstName', 'Jack');
query.whereGreaterThan('age', 18);

可以通过指定 limit 限制返回结果的数量（默认为 100）：

// 最多获取 10 条结果
query.limit(10);

由于性能原因，limit 最大只能设为 1000。即使将其设为大于 1000 的数，云端也只会返回 1,000 条结果。

如果只需要一条结果，可以直接用 first：

LCQuery<LCObject> query = LCQuery('Todo');
query.whereEqualTo('priority', 2);
// todo 是第一个满足条件的 Todo 对象
LCObject todo = await query.first();

可以通过设置 skip 来跳过一定数量的结果：

query.skip(20);

把 skip 和 limit 结合起来，就能实现翻页功能：

LCQuery<LCObject> query = LCQuery('Todo');
query.whereEqualTo('priority', 2);
query.limit(10);
query.skip(20);

需要注意的是，skip 的值越高，查询所需的时间就越长。作为替代方案，可以通过设置 createdAt 或 updatedAt 的范围来实现更高效的翻页，因为它们都自带索引。 同理，也可以通过设置自增字段的范围来实现翻页。

对于能够排序的属性，可以指定结果的排序规则：

// 按 createdAt 升序排列
query.orderByAscending('createdAt');

// 按 createdAt 降序排列
query.orderByDescending('createdAt');

还可以为同一个查询添加多个排序规则；

query.addAscendingOrder('priority');
query.addDescendingOrder('createdAt');

下面的代码可用于查找包含或不包含某一属性的对象：

// 查找包含 'images' 的对象
query.whereExists('images');

// 查找不包含 'images' 的对象
query.whereDoesNotExist('images');

可以通过 .select 指定需要返回的属性。下面的代码只获取每个对象的 title 和 content（包括内置属性 objectId、createdAt 和 updatedAt）：

LCQuery<LCObject> query = LCQuery('Todo');
query.select('title');
query.select('content');
LCObject todo = await query.first();

String title = todo['title']; // √
String content = todo['content']; // √
String notes = todo['notes']; // null

.select 支持点号（author.firstName），详见点号使用指南。 另外，字段名前添加减号前缀表示反向选择，例如 -author 表示不返回 author 字段。 反向选择同样适用于内置字段，比如 -objectId，也可以和点号组合使用，比如 -pubUser.createdAt。

字符串查询​

可以用 whereStartsWith 来查找某一属性值以特定字符串开头的对象。和 SQL 中的 LIKE 一样，你可以利用索引带来的优势：

LCQuery<LCObject> query = new LCQuery('Todo');
// 相当于 SQL 中的 title LIKE 'lunch%'
query.whereStartsWith('title', 'lunch');

可以用 whereContains 来查找某一属性值包含特定字符串的对象：

LCQuery<LCObject> query = LCQuery('Todo');
// 相当于 SQL 中的 title LIKE '%lunch%'
query.whereContains('title', 'lunch');

和 whereStartsWith 不同，whereContains 无法利用索引，因此不建议用于大型数据集。

注意 whereStartsWith 和 whereContains 都是 区分大小写 的，所以上述查询会忽略 Lunch、LUNCH 等字符串。

如果想查找某一属性值不包含特定字符串的对象，可以使用 whereMatches 进行基于正则表达式的查询：

LCQuery query = LCQuery('Todo');
// 'title' 不包含 "ticket"（不区分大小写）
query.whereMatches('title', '^((?!ticket).)*\$', modifiers: 'i');

不过我们并不推荐大量使用这类查询，尤其是对于包含超过 100,000 个对象的 class， 因为这类查询无法利用索引，实际操作中云端会遍历所有对象来获取结果。如果有进行全文搜索的需求，可以使用全文搜索服务。

使用查询时如果遇到性能问题，可参阅 查询性能优化。

数组查询​

下面的代码查找所有数组属性 tags 包含 工作 的对象：

query.whereEqualTo('tags', '工作');

下面的代码查询数组属性长度为 3 （正好包含 3 个标签）的对象：

query.whereSizeEqualTo('tags', 3);

下面的代码查找所有数组属性 tags 同时包含 工作、销售 和 会议 的对象：

query.whereContainsAll('tags', ['工作', '销售', '会议']);

如需获取某一属性值包含一列值中任意一个值的对象，可以直接用 whereContainedIn 而无需执行多次查询。下面的代码构建的查询会查找所有 priority 为 1 或 2 的 todo 对象：

// 单个查询
LCQuery<LCObject> priorityOneOrTwo = LCQuery('Todo');
priorityOneOrTwo.whereContainedIn('priority', [1, 2]);
// 这样就可以了 :)

// ---------------
//       vs.
// ---------------

// 多个查询
LCQuery<LCObject> priorityOne = LCQuery('Todo');
priorityOne.whereEqualTo('priority', 1);

LCQuery<LCObject> priorityTwo = LCQuery('Todo');
priorityTwo.whereEqualTo('priority', 2);

LCQuery<LCObject> priorityOneOrTwo = LCQuery.or([priorityOne, priorityTwo]);
List<LCObject> results = await priorityOneOrTwo.find();
// 好像有些繁琐 :(

反过来，还可以用 whereNotContainedIn 来获取某一属性值不包含一列值中任何一个的对象。

关系查询​

查询关联数据有很多种方式，常见的一种是查询某一属性值为特定 LCObject 的对象，这时可以像其他查询一样直接用 whereEqualTo。比如说，如果每一条博客评论 Comment 都有一个 post 属性用来存放原文 Post，则可以用下面的方法获取所有与某一 Post 相关联的评论：

LCObject post = LCObject.createWithoutData('Post', '57328ca079bc44005c2472d0');
LCQuery<LCObject> query = LCQuery('Comment');
query.whereEqualTo('post', post);
// comments 包含与 post 相关联的评论
List<LCObject> comments = await query.find();

如需获取某一属性值为另一查询结果中任一 LCObject 的对象，可以用 whereMatchesQuery。下面的代码构建的查询可以找到所有包含图片的博客文章的评论：

LCQuery innerQuery = LCQuery('Post');
innerQuery.whereExists('image');

LCQuery query = LCQuery('Comment');
query.whereMatchesQuery('post', innerQuery);

如需获取某一属性值不是另一查询结果中任一 LCObject 的对象，则使用 whereDoesNotMatchQuery。

有时候可能需要获取来自另一个 class 的数据而不想进行额外的查询，此时可以在同一个查询上使用 include。下面的代码查找最新发布的 10 条评论，并包含各自对应的博客文章：

LCQuery<LCObject> query = LCQuery('Comment');

// 获取最新发布的
query.orderByDescending('createdAt');

// 只获取 10 条
query.limit(10);

// 同时包含博客文章
query.include('post');

// comments 包含最新发布的 10 条评论，包含各自对应的博客文章
List<LCObject> comments = await query.find();
for (LCObject comment in comments) {
// 该操作无需网络连接
  LCObject post = comment['post'];
}

可以用 dot 符号（.）来获取多级关系，例如 post.author，详见点号使用指南的《在查询对象时使用点号》一节。

可以在同一查询上应用多次 .include 以包含多个属性。通过这种方法获取到的对象同样接受 .first() 等 LCQuery 辅助方法。

通过 .include 进行多级查询的方式不适用于数组属性内部的 LCObject，只能包含到数组本身。

关系查询的注意事项​

云端使用的并非关系型数据库，无法做到真正的联表查询，所以实际的处理方式是：先执行内嵌/子查询（和普通查询一样，limit 默认为 100，最大 1000），然后将子查询的结果填入主查询的对应位置，再执行主查询。如果子查询匹配到的记录数量超出 limit，且主查询有其他查询条件，那么可能会出现没有结果或结果不全的情况，因为只有 limit 数量以内的结果会被填入主查询。

我们建议采用以下方案进行改进：

  • 确保子查询的结果在 100 条以下，如果在 100 至 1,000 条之间的话请将子查询的 limit 设为 1000。
  • 将需要查询的字段冗余到主查询所在的表上。
  • 进行多次查询，每次在子查询上设置不同的 skip 值来遍历所有记录（注意 skip 的值较大时可能会引发性能问题，因此不是很推荐）。

统计总数量​

如果只需知道有多少对象匹配查询条件而无需获取对象本身，可使用 count 来代替 find。比如说，查询有多少个已完成的 todo：

LCQuery<LCObject> query = LCQuery('Todo');
query.whereEqualTo('isComplete', true);
int count = await query.count();
print('$count 个 todo 已完成');

组合查询​

组合查询就是把诸多查询条件用一定逻辑合并到一起（OR 或 AND）再交给云端去查询。

组合查询不支持在子查询中包含 GeoPoint 或其他非过滤性的限制（例如 near、withinGeoBox、limit、skip、ascending、descending、include）。

OR 查询​

OR 操作表示多个查询条件符合其中任意一个即可。 例如，查询优先级大于等于 3 或者已经完成了的 todo：

LCQuery<LCObject> priorityQuery = LCQuery('Todo');
priorityQuery.whereGreaterThanOrEqualTo('priority', 3);

LCQuery<LCObject> isCompleteQuery = LCQuery('Todo');
isCompleteQuery.whereEqualTo('isComplete', true);

LCQuery<LCObject> priorityOneOrTwo = LCQuery.or([priorityQuery, isCompleteQuery]);
List<LCObject> results = await priorityOneOrTwo.find();

使用 OR 查询时，子查询中不能包含 GeoPoint 相关的查询。

AND 查询​

使用 AND 查询的效果等同于往 LCQuery 添加多个条件。下面的代码构建的查询会查找创建时间在 2016-11-13 和 2016-12-02 之间的 todo：

LCQuery<LCObject> startDateQuery = new LCQuery('Todo');
startDateQuery.whereGreaterThanOrEqualTo('createdAt', DateTime.parse('2016-11-13 00:00:00Z'));

LCQuery<LCObject> endDateQuery = new LCQuery('Todo');
endDateQuery.whereLessThan('createdAt', DateTime.parse('2016-12-03 00:00:00Z'));

LCQuery<LCObject> query = LCQuery.and([startDateQuery, endDateQuery]);
List<LCObject> results = await query.find();

单独使用 AND 查询跟使用基础查询相比并没有什么不同，不过当查询条件中包含不止一个 OR 查询时，就必须使用 AND 查询：

LCQuery<LCObject> createdAtQuery = LCQuery('Todo');
createdAtQuery.whereGreaterThanOrEqualTo('createdAt', DateTime.parse('2018-04-30 00:00:00Z'));
createdAtQuery.whereLessThan('createdAt', DateTime.parse('2018-05-01 00:00:00Z'));

LCQuery<LCObject> locationQuery = LCQuery('Todo');
locationQuery.whereDoesNotExist('location');

LCQuery<LCObject> priority2Query = LCQuery('Todo');
priorityQuery.whereEqualTo('priority', 2);

LCQuery<LCObject> priority3Query = LCQuery('Todo');
priorityQuery.whereEqualTo('priority', 3);

LCQuery<LCObject> priorityQuery = LCQuery.or([priority2Query, priority3Query]);
LCQuery<LCObject> timeLocationQuery = LCQuery.or([locationQuery, createdAtQuery]);
LCQuery<LCObject> query = LCQuery.and([priorityQuery, timeLocationQuery]);

查询性能优化​

影响查询性能的因素很多。特别是当查询结果的数量超过 10 万，查询性能可能会显著下降或出现瓶颈。以下列举一些容易降低性能的查询方式，开发者可以据此进行有针对性的调整和优化，或尽量避免使用。

  • 不等于和不包含查询（无法使用索引）
  • 通配符在前面的字符串查询（无法使用索引）
  • 有条件的 count（需要扫描所有数据）
  • skip 跳过较多的行数（相当于需要先查出被跳过的那些行）
  • 无索引的排序（另外除非复合索引同时覆盖了查询和排序，否则只有其中一个能使用索引）
  • 无索引的查询（另外除非复合索引同时覆盖了所有条件，否则未覆盖到的条件无法使用索引，如果未覆盖的条件区分度较低将会扫描较多的数据）

文件​

有时候应用需要存储尺寸较大或结构较为复杂的数据，这类数据不适合用 LCObject 保存，此时文件对象 LCFile 便成为了更好的选择。文件对象最常见的用途是保存图片，不过也可以用来保存文档、视频、音乐等其他二进制数据。

构建文件​

可以通过字符串构建文件：

LCFile file = LCFile.fromBytes('resume.txt', utf8.encode('LeanCloud'));

除此之外，还可以通过 URL 构建文件：

LCFile file = LCFile.fromUrl('logo.png', 'https://leancloud.cn/assets/imgs/press/Logo%20-%20Blue%20Padding.a60eb2fa.png');

通过 URL 构建文件时，SDK 并不会将原本的文件转储到云端，而是会将文件的物理地址存储为字符串，这样也就不会产生任何文件上传流量。使用其他方式构建的文件会被保存在云端。

云端会根据文件扩展名自动检测文件类型。如果需要的话，也可以手动指定 Content-Type（一般称为 MIME 类型）：

LCFile file = LCFile.fromBytes('resume.txt', utf8.encode('LeanCloud'));
file.mimeType = 'application/json';

与前面提到的方式相比，一个更常见的文件构建方式是从本地路径上传。

LCFile file = await LCFile.fromPath('avatar.jpg', './avatar.jpg');

这里上传的文件名字叫做 avatar.jpg。需要注意：

  • 每个文件会被分配到一个独一无二的 objectId，所以在一个应用内是允许多个文件重名的。
  • 文件必须有扩展名才能被云端正确地识别出类型。比如说要用 LCFile 保存一个 PNG 格式的图像，那么扩展名应为 .png。
  • 如果文件没有扩展名，且没有手动指定类型，那么云服务将默认使用 application/octet-stream。

保存文件​

将文件保存到云端后，便可获得一个永久指向该文件的 URL：

await file.save();
print(file.url);

文件上传后，可以在 _File class 中找到。已上传的文件无法再被修改。如果需要修改文件，只能重新上传修改过的文件并取得新的 objectId 和 URL。

已经保存到云端的文件可以关联到 LCObject：

LCObject todo = LCObject('Todo');
todo['title'] = '买蛋糕';
// attachments 是一个 File 类型
todo.add('attachments', file);
await todo.save();

也可以通过构建 LCQuery 进行查询：

LCQuery<LCObject> query = LCQuery('_File');

需要注意的是，内部文件（上传到文件服务的文件）的 url 字段是由云端动态生成的，其中涉及切换自定义域名的相关处理逻辑。 因此，通过 url 字段查询文件仅适用于外部文件（直接保存外部 URL 到 _File 表创建的文件），内部文件请改用 key 字段（URL 中的路径）查询。

注意，如果文件被保存到了 LCObject 的一个数组属性中，那么在查询 LCObject 时如果需要包含文件，则要用到 LCQuery 的 .include 方法。比如说，在获取所有标题为 买蛋糕 的 todo 的同时获取附件中的文件：

// 获取同一标题且包含附件的 todo
LCQuery<LCObject> query = LCQuery('Todo');
query.whereEqualTo('title', '买蛋糕');
query.whereExists('attachments');

// 同时获取附件中的文件
query.include('attachments');
List<LCObject> todos = await query.find();
for (LCObject todo in todos) {
// 获取每个 todo 的 attachments 数组
  List<LCObject> attachments = todo['attachments'];
}

上传进度监听​

上传过程中可以实时向用户展示进度：

await file.save(onProgress: (int count, int total) {
print('$count/$total');
if (count == total) {
  print('done');
}
});

文件元数据​

上传文件时，可以用 metaData 添加额外的属性。文件一旦保存，metaData 便不可再修改。

file.addMetaData('size', 1024);
file.addMetaData('width', 128);
file.addMetaData('height', 256);
file.mimeType = 'image/jpg';
await file.save();

删除文件​

下面的代码从云端删除一个文件：

LCFile file = LCObject.createWithoutData('_File', '552e0a27e4b0643b709e891e');
await file.delete();

默认情况下，文件的删除权限是关闭的，需要进入 云服务控制台 > 数据存储 > 结构化数据 > _File，选择 权限 > delete 来开启。

GeoPoint​

云服务允许你通过将 LCGeoPoint 关联到 LCObject 的方式存储折射真实世界地理位置的经纬坐标，这样做可以让你查询包含一个点附近的坐标的对象。常见的使用场景有「查找附近的用户」和「查找附近的地点」。

要构建一个包含地理位置的对象，首先要构建一个地理位置。下面的代码构建了一个 LCGeoPoint 并将其纬度（latitude）设为 39.9，经度（longitude）设为 116.4：

LCGeoPoint point = LCGeoPoint(39.9, 116.4);

现在可以将这个地理位置存储为一个对象的属性：

todo['location'] = point;

地理位置查询​

给定一些含有地理位置的对象，可以从中找出离某一点最近的几个，或者处于某一范围内的几个。要执行这样的查询，可以向普通的 LCQuery 添加 whereNear 条件。下面的代码查找 location 属性值离某一点最近的 Todo 对象：

LCQuery<LCObject> query = LCQuery('Todo');
LCGeoPoint point = LCGeoPoint(39.9, 116.4);
query.whereNear('location', point);

// 限制为 10 条结果
query.limit(10);
// todos 是包含满足条件的 Todo 对象的数组
List<LCObject> todos = await query.find();

像 orderByAscending 和 orderByDescending 这样额外的排序条件会获得比默认的距离排序更高的优先级。

若要限制结果和给定地点之间的距离，可以参考 API 文档中的 参数。

若要查询在某一矩形范围内的对象，可以用 whereWithinGeoBox：

withinGeoBox

LCQuery<LCObject> query = LCQuery('Todo');
LCGeoPoint southwest = LCGeoPoint(30, 115);
LCGeoPoint northeast = LCGeoPoint(40, 118);
query.whereWithinGeoBox('location', southwest, northeast);

GeoPoint 的注意事项​

GeoPoint 的经纬度的类型是数字，且经度需在 -180.0 到 180.0 之间，纬度需在 -90.0 到 90.0 之间。 另外，每个对象最多只能有一个类型为 GeoPoint 的属性。

用户​

请参阅内建账户指南。

角色​

随着用户量的增长，你可能会发现相比于为每一名用户单独设置权限，将预先设定好的权限直接分配给一部分用户是更好的选择。为了迎合这种需求，云服务支持基于角色的权限管理。请参阅ACL 权限管理开发指南。

子类化​

子类化推荐给进阶的开发者在进行代码重构的时候做参考。你可以用 LCObject 重载符 [] 访问/赋值任意字段；你也可以使用子类化的属性来封装获取字段的方法，增强编码体验。子类化有很多优势，包括减少代码的编写量，具有更好的扩展性，和支持自动补全等等。

实现​

要实现子类化，需要下面三个步骤：

  1. 继承 LCObject；
  2. 重载构造方法，传入 类名；
  3. 注册子类

下面是实现 Student 子类化的例子：

// 定义 Student 类型
class Student extends LCObject {
  String get name => this['name'];

  set name(String value) => this['name'] = value;

  Student() : super('Student');
}

// 注册 Student 子类
LCObject.registerSubclass<Student>('Student', () => new Student());

使用​

如下所示，两段代码对 name 字段的赋值方式等价。

LCObject student = new LCObject("Student");
student["name"] = "小明";
await student.save();
Student student = new Student();
student.name = "小明";
await student.save();

全文搜索​

全文搜索是一个针对应用数据进行全局搜索的接口，它基于搜索引擎构建，提供更强大的搜索功能。要深入了解其用法和阅读示例代码，请阅读 全文搜索指南。