let query = LCQuery(className: "City")
query.whereKey("name", .equalTo: "广州")
query.whereKey("dependent", .included)
_ = query.getFirst { result in
switch result {
case .success(object: let city):
let province = city["dependent"] as? LCObject
case .failure(error: let error):
print(error)
}
}
AVQuery<AVObject> query = new AVQuery<>("City");
query.whereEqualTo("name", "广州");
query.include("dependent");
query.getFirstInBackground().subscribe(new Observer<AVObject>() {
public void onSubscribe(Disposable disposable) {}
public void onNext(List<AVObject> city) {
AVObject province = city.getAVObject("dependent");
}
public void onError(Throwable throwable) {}
public void onComplete() {}
});
const query = new AV.Query('City');
query.equalTo('name', '广州');
query.include(['dependent']);
query.first().then((city) => {
const province = city.get('dependent');
});
query = leancloud.Query("City")
query.equal_to('name', '广州')
query.include('dependent')
city = query.first()
province = city.get('dependent')
let guangDong = LCObject(className: "Province", objectId: "56545c5b00b09f857a603632")
let query = LCQuery(className: "City")
query.whereKey("dependent", .equalTo(GuangDong))
_ = query.find { (result) in
switch result {
case .success(objects: let cities):
for city in cities {
// cities 为广东省下辖的所有城市
}
case .failure(error: let error):
print(error)
}
}
AVObject guangDong = AVObject.createWithoutData("Province", "56545c5b00b09f857a603632");
AVQuery<AVObject> query = new AVQuery<>("City");
query.whereEqualTo("dependent", guangDong);
query.findInBackground().subscribe(new Observer<List<AVObject>>() {
@Override
public void onSubscribe(Disposable d) {}
@Override
public void onNext(List<AVObject> cities) {
for (AVObject city : cities) {
// cities 为广东省下辖的所有城市
}
}
@Override
public void onError(Throwable e) {}
@Override
public void onComplete() {}
});
let query = LCQuery(className: "StudentCourseMap")
let courseLinearAlgebra = LCObject(className: "Course", objectId: "562da3fdddb2084a8a576d49")
query.whereKey("course", equalTo: courseLinearAlgebra)
_ = query.find { (result) in
switch result {
case .success(objects: let studentCourseMaps):
for studentCourseMap in studentCourseMaps {
let student = studentCourseMap["student"] as? LCObject
let duration = studentCourseMap["duration"] as? LCArray
let platform = studentCourseMap["platform"] as? LCString
}
case .failure(error: let error):
print(error)
}
}
数据模型设计指南
多年以来,关系型数据库已经成为了企业数据管理的基础,很多工程师对于关系模型和 6 个范式都比较了解,但是如今来构建和运行一个应用,随着数据来源的越发多样和用户量的不断增长,关系数据库的限制逐渐成为业务的瓶颈,因此越来越多的公司开始向其它 NoSQL 数据库进行迁移。
LeanCloud 的存储后台大量采用了 MongoDB 这种文档数据库来存储结构化数据,正因如此我们才能提供面向对象的、海量的、无需创建数据表结构即存即用的存储能力。从传统的关系型数据库转换到 LeanCloud 或者 MongoDB 存储系统,最基础的改变就是「数据建模 Schema 设计」。
首先来梳理一下关系型数据库、MongoDB 和 LeanCloud 的对应术语:
在 LeanCloud 上进行数据建模设计需要数据架构师、开发人员和 DBA 在观念上做一些转变:之前是传统的关系型数据模型,所有数据都会被映射到二维的表结构「行」和「列」;现在是丰富、动态的对象模型,即 MongoDB 的「文档模型」,包括内嵌子对象和数组。
文档模型
后文中我们有时候采用 LeanCloud 的核心概念 Object(对象),有时候提到 MongoDB 中的名词 Document(文档),它们是等同的。
我们现在使用的大部分数据都有比较复杂的结构,用「JSON 对象」来建模比用「表」会更加高效。通过内嵌子对象和数组,JSON 对象可以和应用层的数据结构完全对齐。这对开发者来说,会更容易将应用层的数据映射到数据库里的对象。相反,将应用层的数据映射到关系数据库的表,则会降低开发效率。而比较普遍的增加额外的对象关系映射(ORM)层的做法,也同时降低了 schema 扩展和查询优化的灵活性,引入了新的复杂度。
例如,在 RDBMS 中有父子关系的两张表,通常就会变成 LeanCloud 里面含有内嵌子对象的单文档结构。以下图的数据为例:
PERSON 表
CAR 表
RDBMS 中通过 Person_ID 域来连接 PERSON 表和 CAR 表,以此支持应用中显示每辆车的拥有者信息。使用文档模型,通过内嵌子对象和数组可以将相关数据提前合并到一个单一的数据结构中,传统的跨表的行和列现在都被存储到了一个文档内,完全省略掉了 join 操作。
换成 LeanCloud 来对同样的数据建模,则允许我们创建这样的 schema:一个单一的 Person 对象,里面通过一个子对象数组来保存该用户所拥有的每一部 Car,例如:
文档数据库里的一篇文档,就相当于 LeanCloud 平台里的一个对象。这个例子里的关系模型虽然只由两张表组成(现实中大部分应用可能需要几十、几百甚至上千张表),但是它并不影响我们思考数据的方式。
为了更好地展示关系模型和文档模型的区别,我们用一个博客平台来举例。从下图中可以看出,依赖 RDBMS 的应用需要 join 五张不同的表来获得一篇博客的完整数据,而在 LeanCloud 中所有的博客数据都包含在一个文档中,博客作者和评论者的用户信息则通过一个到 User 的引用(指针)进行关联。
文档模型的优点
除了数据表现更加自然之外,文档模型还有性能和扩展性方面的优势:
定义文档 Schema
应用的数据访问模式决定了 schema 设计,因此我们需要特别明确以下几点:
以此来设计更合适的 schema 结构。
对于普通的「属性名:值」来说,设计比较简单,和 RDBMS 中平坦的表结构差别不大。对于「一对一」或「一对多」的关系会很自然地考虑使用内嵌对象:
例如,为了记录每个学生的家庭住址,我们可以把住址信息作为一个整体嵌入 Student 类里面。
但并不是所有的一对一关系都适合内嵌的方式,对下面的情况后文介绍的「引用」(等同于 MongoDB 的 reference)方式会更加合适:
接下来我们重点讨论一下在 LeanCloud 上如何通过「引用」机制来实现复杂的关系模型。
数据对象之间存在 3 种类型的关系:「一对一」将一个对象与另一个对象关联,「一对多」是一个对象关联多个对象,「多对多」则用来实现大量对象之间的复杂关系。
我们支持 3 种方式来构建对象之间的关系,这些都是通过 MongoDB 的文档引用来实现的:
Arrays(一对多、多对多)不建议使用,请参考 何时使用数组。一对多关系
Pointers 存储
中国的「省份」与「城市」具有典型的一对多的关系。深圳和广州(城市)都属于广东省(省份),而朝阳区和海淀区(行政区)只能属于北京市(直辖市)。广东省对应着多个一级行政城市,北京对应着多个行政区。下面我们使用 Pointers 来存储这种一对多的关系。
保存关联对象的同时,被关联的对象也会随之被保存到云端。 执行上述代码后,在应用控制台可以看到
dependent
字段显示为 Pointer 数据类型,而它本质上存储的是一个指向Province
这张表的某个 AVObject 的指针。要关联一个已经存在于云端的对象,例如将「东莞市」添加至「广东省」(假设广东的 objectId 为
56545c5b00b09f857a603632
),方法如下:注意,为了节约篇幅,以上代码中省略了保存对象的代码。
Pointers 查询
想知道广州属于哪个省份:
想知道哪些城市属于广东省(假定代表广东省的对象的 objectId 是
56545c5b00b09f857a603632
) ?大多数场景下,Pointers 是实现一对多关系的最好选择。
多对多关系
假设有选课应用,我们需要为
Student
对象和Course
对象建模。一个学生可以选多门课程,一个课程也有多个学生,这是一个典型的多对多关系。我们必须使用 Arrays 或创建自己的中间表来实现这种关系。决策的关键在于是否需要为这个关系附加一些属性。如果不需要附加属性,使用 Arrays 最为简单。通常情况下,使用 Arrays 可以使用更少的查询并获得更好的性能。
如果多对多关系中任何一方对象数量可能达到或超过 100,使用中间表是更好的选择。
反之,若需要为关系附加一些属性,就创建一个独立的表(中间表)来存储两端的关系。记住,附加的属性是描述这个关系的,不是描述关系中的任何一方。所附加的属性可以是:
使用中间表实现多对多关系(推荐)
有时我们需要知道更多关系的附加信息,比如在一个学生选课系统中,我们要了解学生打算选修的这门课的课时有多长,或者学生选修是通过手机选修还是通过网站操作的,此时我们可以使用传统的数据模型设计方法「中间表」。
为此,我们创建一个独立的表
StudentCourseMap
来保存Student
和Course
的关系:course
student
duration
["2016-02-19","2016-04-21"]
。platform
iOS
。如此,实现选修功能的代码如下:
查询选修了某一课程的所有学生:
同样我们也可以很简单地查询某一个学生选修的所有课程,只需将上述代码变换查询条件即可:
我们在上面的代码中省略了执行查询的语句,以节省篇幅。
一对一关系
当你需要将一个对象拆分成两个对象时,一对一关系是一种重要的需求,例如:
在这个场景中,你可以将此对象拆分成两部分,一部分包含所有用户可见的数据,另一部分包含所有仅自己可见的数据(通过 ACL 控制 )。同样你也可以实现一部分包含所有用户可修改的数据,另一部分包含所有仅自己可修改的数据。
原始对象大小超过了对象的 128 KB 的上限值,此时你可以创建另一个对象来存储额外的数据。当然通常的作法是更好地设计和优化数据模型来避免出现大对象,但如果确实无法避免,则可以考虑使用 AVFile 存储大数据。
AVFile 可以方便地存取文件,但对对象进行查询和修改等操作就不是很方便了。此时可以使用 AVObject 构造一个自己的文件对象并与 AVFile 建立一对一关联,将文件属性存于 AVObject 中,这样既可以方便查询修改文件属性,也可以方便存取文件。
关联数据的删除
当表中有一个 Pointer 指向的源数据被删除时,这个源数据对应的 Pointer 不会被自动删除。所以建议用户在删除源数据时自行检查是否有 Pointer 指向这条数据,基于业务场景有必要做数据清理的话,可以调用对应的对象上的删除接口将 Pointer 关联的对象删除。
索引
在任何一个数据库系统中,索引都是优化性能的重要手段,同时它与 Schema 设计也是密不可分的。LeanCloud 也支持索引,其索引与关系数据库中基本相同。在索引的选择上,应用查询操作的模式和频率起决定性作用。
同时也要注意,索引不是没有代价的。在加速查询的同时,它也会降低写入速度、消耗更多存储空间。是否建索引,如何建索引,建多少索引,我们需要综合权衡后来下决定。
索引类型
LeanCloud 的索引可以包含任意的属性(包括数组),下面是一些索引选项:
复合索引
在多个属性域上构建一个单独的索引结构。例如,以一个存储客户数据的应用为例,我们可能需要根据姓、名和居住地来查询客户信息。通过在「姓、名、居住地」上建立复合索引,LeanCloud 可以快速给出满足这三个条件的结果。此外,这一复合索引也能加速任何前置属性的查询。例如根据「姓」或者根据「姓+名」的查询都会使用到这个复合索引。
注意,如果单按照「名」来查询,此复合索引会失效。
唯一索引
通过给索引加上唯一性约束,LeanCloud 就会拒绝含有相同索引值的对象插入和更新。所有的索引默认都不是唯一索引,如果把复合索引指定为唯一索引,那么应用层必须保证索引列的组合值是唯一的。
对数组属性也能创建索引。
LeanCloud 会自动为 GeoPoint 类型的属性建立地理空间索引,但是要求一个 Object 内 GeoPoint 的属性不能超过一个。
这种索引只包含那些含有指定属性的文档,如果文档不含有目标属性,那么就不会进入索引。稀疏索引体积更小,查询性能更高。LeanCloud 默认都会创建稀疏索引。
LeanCloud 的索引可以在任何域上建立,包括内嵌对象和数组类型,这使它带来了比 RDBMS 更强大的功能。
通过索引优化性能
LeanCloud 后台会根据每天的访问日志,自动归纳和学习频繁使用的访问模式,并自动创建合适的索引。不过如果你对索引优化比较有经验,也可以在控制台为每一个 Class 手动创建索引。
持续优化 Schema
在 LeanCloud 的存储系统里,Class 可以在没有完整的结构定义(包含哪些属性、数据类型如何等)时就提前创建好,一个 Class 下的对象(Object)也无需包含所有属性域,我们可以随时往对象中增减新的属性。
这种灵活、动态的 Schema 机制,使 Schema 的持续优化变得非常简单。相比之下,关系数据库的开发人员和 DBA 在开始一个新项目的时候,写下第一行代码之前,就需要制定好数据库 Schema,这至少需要几天,有的需要数周甚至更长。而 LeanCloud 则允许开发者通过不断迭代和敏捷过程,持续优化 Schema。开发者可以开始写代码并将他们创建的对象持久化存储起来,以后当需要增加新的功能,LeanCloud 可以继续存储新的对象而不需要对原来的 Class 做 ALTER TABLE 操作,这会给我们的开发带来很大的便利。
最佳的建模方式
选择最适合的建模方式,首先要确定关系是否:
例如学生选课,学生在选课的时候有的从电脑浏览器里选,有的从手机上选,手机系统还区分 iOS、Android 等等。那么假设要统计一下学生选课的来源,那么建立选课关系的时候就需要记录一下附加属性,这时只有中间表可以满足这个需求。
其次判断:
决定了用哪种方式之后,就按照前文介绍的一对多或多对多的实例代码构建自己的业务逻辑代码。但是 Pointer 可以实现的,中间表也可以实现,并且开发者可控的余地更多。具体可以参照如下伪代码:
案例分析
婴儿与监护人之间的关系
做一个应用统计婴儿吃饭、睡觉、玩耍的时间分布,而婴儿的监护人可能会有多个,爷爷奶奶外公外婆还有可能是月嫂。首先按照我们之前设定的思路来逐步分析应该采用哪种方式建模:
一个婴儿和一个监护人之间的关系是否有附加属性?答案是有附加属性,父子关系跟母子关系是不一样的关系,因为对于婴儿监护人的身份称呼就是这个关系的附加属性。因此不用多想,果断使用中间表。不用再纠结是一对多还是多对多。
用户与设备之间的关系
婴儿的状态改变,可以通过推送服务做到实时推送给监护人,比如孩子的爸爸设备较多,他会在 iPad、iPhone 以及 Windows 上安装这个应用,那么他一般情况下会有 3 台设备。监护人在每一台设备上登录后,每当孩子的状态发生改变,服务端都会向这 3 台设备推送,那么我们接着按照之前的思路来分析应该采用哪种方式建模。
一般来说这种情况是可以省略附加属性的,因为 LeanCloud 的
_Installation
表里有一个字段是专门用来存储客户端设备的 deviceType,因此设备的信息是不需要存储在中间表的。 而除非有其他特殊的属性条件,设备和用户之间的关系就是一个简单的一对多的关系,并且并不需要附加属性。其次判断:
一个用户在多个设备上登录一般就可以定义为一对多,而很少会出现类似 iPhone/iPad 版 QQ 那样内置了多账户管理系统,因此定义为一对多比较满足我们现在的需求。
何时使用数组
当要关联的数据是简单数据并且查询多于修改的时候,用数组比较合适。比如社交类应用里给朋友加标签,就可以使用 string 数组来存储这个属性。
为节省篇幅,上面的代码省略了保存对象的语句。
数组过长可能会影响性能,建议数组长度控制在 1000 以下。 数组长度达到 10000 后,云端会拒绝向数组追加元素的请求。