https://github.com/leancloud/leancloud-graphql
Third party GraphQL support for LeanCloud, running on LeanEngine
https://github.com/leancloud/leancloud-graphql
Last synced: 11 months ago
JSON representation
Third party GraphQL support for LeanCloud, running on LeanEngine
- Host: GitHub
- URL: https://github.com/leancloud/leancloud-graphql
- Owner: leancloud
- License: apache-2.0
- Created: 2016-12-14T06:14:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-16T03:25:45.000Z (about 8 years ago)
- Last Synced: 2025-04-24T02:40:24.442Z (11 months ago)
- Language: JavaScript
- Homepage: https://graphql.leanapp.cn
- Size: 31.3 KB
- Stars: 105
- Watchers: 9
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LeanCloud GraphQL
运行在云引擎上的第三方 GraphQL 支持，允许你用 GraphQL 查询 LeanCloud 云存储中的所有数据。
- [部署到云引擎](#%E9%83%A8%E7%BD%B2%E5%88%B0%E4%BA%91%E5%BC%95%E6%93%8E)
- [GraphQL](#graphql)
- [获取数据](#%E8%8E%B7%E5%8F%96%E6%95%B0%E6%8D%AE)
- [查询条件](#%E6%9F%A5%E8%AF%A2%E6%9D%A1%E4%BB%B6)
* [equalTo](#equalto)
* [exists](#exists)
* [范围查询](#%E8%8C%83%E5%9B%B4%E6%9F%A5%E8%AF%A2)
* [数组查询](#%E6%95%B0%E7%BB%84%E6%9F%A5%E8%AF%A2)
* [组合查询](#%E7%BB%84%E5%90%88%E6%9F%A5%E8%AF%A2)
- [关系查询](#%E5%85%B3%E7%B3%BB%E6%9F%A5%E8%AF%A2)
* [Relation](#relation)
* [Pointer](#pointer)
* [查询条件](#%E6%9F%A5%E8%AF%A2%E6%9D%A1%E4%BB%B6-1)
* [反向关系](#%E5%8F%8D%E5%90%91%E5%85%B3%E7%B3%BB)
* [多级关系](#%E5%A4%9A%E7%BA%A7%E5%85%B3%E7%B3%BB)
- [修改对象](#%E4%BF%AE%E6%94%B9%E5%AF%B9%E8%B1%A1)
* [创建对象](#%E5%88%9B%E5%BB%BA%E5%AF%B9%E8%B1%A1)
* [更新对象](#%E6%9B%B4%E6%96%B0%E5%AF%B9%E8%B1%A1)
- [添加到现有项目](#%E6%B7%BB%E5%8A%A0%E5%88%B0%E7%8E%B0%E6%9C%89%E9%A1%B9%E7%9B%AE)
* [作为中间件添加](#%E4%BD%9C%E4%B8%BA%E4%B8%AD%E9%97%B4%E4%BB%B6%E6%B7%BB%E5%8A%A0)
* [获取 GraphQLSchema](#%E8%8E%B7%E5%8F%96-graphqlschema)
## 部署到云引擎
见 [LeanCloud 命令行工具](https://leancloud.cn/docs/leanengine_cli.html)。
## GraphQL
[GraphQL](http://graphql.org/) 是 FaceBook 开源的一套查询语言，你可以用它定义数据的格式和获取方法（这就是 leancloud-graphql 做的工作，它会自动将你在 LeanCloud 的数据结构转换为 GraphQL 的 Schema），然后便可以在客户端以一种非常灵活的语法来获取数据，甚至也可以用它来创建和更新数据。
在使用 leancloud-graphql 之前，你可能需要先了解一下 [GraphQL 的语法](http://graphql.org/learn/queries/) ，下面我们不会过多地介绍 GraphQL 本身。这篇文章将使用 JavaScript SDK 文档中的 [示例数据结构](https://leancloud.cn/docs/leanstorage_guide-js.html#示例数据结构) 进行讲解。
GraphQL 在客户端几乎不需要什么 SDK，你可以花几行代码封装一个工具函数：
```javascript
function requestGraphQL(query) {
return fetch('/', {
method: 'POST',
body: query
}).then( res => {
return res.json();
}).then( result => {
return result.data;
});
}
```
我们也用 GraphiQL 提供了一个支持自动补全等功能的 GraphQL 控制台（本地调试时为 ），你可以在这里测试你的查询。
我们会应用客户端发来的 sessionToken，确保在用户的权限范围内进行查询。你可以从我们的 JavaScript SDK 上获取 sessionToken 并随着请求发送，修改 requestGraphQL：
```diff
headers: {
'Content-Type': 'application/graphql',
+ 'X-LC-Session': AV.User.current() && AV.User.current().getSessionToken()
},
```
## 获取数据
最简单的一个查询：
```graphql
requestGraphQL(`
query {
Todo {
title, priority
}
}
`)
```
默认会返回最多 100 条数据：
```javascript
{
Todo: [
{title: "紧急 Bug 修复", priority: 0},
{title: "打电话给 Peter",priority: 5},
{title: "还信用卡账单", priority: 10},
{title: "买酸奶", priority: 10},
{title: "团队会议", priority: 5}
]
}
```
你可以在此基础上添加排序、条数限制等选项：
- `ascending` 按照指定字段升序。
- `descending` 按照指定字段降序。
- `limit` 条数限制。
例如我们按照优先级升序排序，取最重要的两个任务：
```graphql
query {
Todo(ascending: priority, limit: 2) {
title, priority
}
}
```
结果：
```javascript
{
Todo: [
{title: "紧急 Bug 修复", priority: 0},
{title: "打电话给 Peter",priority: 5}
]
}
```
## 查询条件
首先你可以按照 objectId 进行简单的查询：
```graphql
query {
Todo(objectId: "5853a0e5128fe1006b5ce449") {
title, priority
}
}
```
结果：
```javascript
{
Todo: [
{title: "还信用卡账单", priority: 10}
]
}
```
### equalTo
你也可以像 LeanCloud 的 SDK 一样使用多种查询条件：
```graphql
query {
Todo(equalTo: {title: "团队会议"}) {
title
}
}
```
### exists
exists 可以用来查询存在或不存在某一字段的对象，例如我们查询存在 title 但不存在 content 的 Todo：
```graphql
query {
Todo(exists: {title: true, content: false}) {
title, content
}
}
```
### 范围查询
```graphql
query {
Todo(greaterThanOrEqualTo: {priority: 10}) {
title, priority
}
}
```
目前支持的查询包括：
- `greaterThan` 约束指定列大于特定值。
- `greaterThanOrEqualTo` 约束指定列大于等于特定值。
- `lessThan` 约束指定列小于特定值。
- `lessThanOrEqualTo` 约束指定列小于等于特定值。
### 数组查询
```graphql
query {
Todo(containedIn: {tags: ["Online"]}) {
title, tags
}
}
```
目前支持的数组查询包括：
- `containedIn` 约束指定列中包含特定元素。
- `containsAll` 约束指定列中包含所有元素。
### 组合查询
你可以将我们前面提到的所有查询条件组合在一起：
```graphql
query {
Todo(exists: {content: true}, ascending: priority, greaterThan: {priority: 5}) {
title, content, priority
}
}
```
## 关系查询
### Relation
如果对象的一个字段是 Relation，那么你就可以在 GraphQL 中将它展开，例如我们可以查询每个 TodoFolder 中包含的 Todo：
```graphql
query {
TodoFolder {
name, containedTodos {
title, priority
}
}
}
```
结果：
```javascript
{
TodoFolder: [{
name: "工作",
containedTodos: [
{title: "紧急 Bug 修复", priority: 0},
{title: "打电话给 Peter", priority: 5},
{title: "团队会议", priority: 5}
]
}, {
name: "购物清单",
containedTodos: [
{title: "买酸奶", priority: 10}
]
}]
}
```
### Pointer
如果一个字段是 Pointer 你也可以将它展开，例如我们可以查询 Todo 的创建者（到用户表的指针）：
```graphql
query {
Todo(limit: 1) {
title, owner {
username, email
}
}
}
```
结果：
```javascript
{
Todo: [
{
title: "紧急 Bug 修复",
owner: {
username: "someone",
email: "test@example.com"
}
}
]
}
```
### 查询条件
你也可以在关系查询上附加查询参数或查询条件：
```graphql
query {
TodoFolder {
name, containedTodos(limit: 1, exists: {content: true}) {
title, content
}
}
}
```
结果：
```javascript
{
TodoFolder: [{
name: "工作",
containedTodos: [
{title: "团队会议", content: "BearyChat"}
]
}, {
name: "购物清单",
containedTodos: []
}, {
name: "someone",
containedTodos: [
{title: "还信用卡账单", content: "2016 年 12 月"}
]
}]
}
```
支持的参数和条件包括：`ascending`、`descending`、`limit`、`objectId`、`equalTo`、`exists`、`greaterThan`、`greaterThanOrEqualTo`、`lessThan`、`lessThanOrEqualTo`、`containedIn`、`containsAll`。
### 反向关系
在实现一对多关系时，我们经常会在「多」上面保存一个到「一」的指针，leancloud-graphql 会自动在「多」上面创建一个属性，用来表示反向关系。例如因为 Todo 的 owner 是一个指向 \_User 的 Pointer，所以 \_User 上会自动出现一个 `ownerOfTodo`：
```graphql
query {
_User {
username, ownerOfTodo {
title
}
}
}
```
这样我们便可以查到每个用户的 Todo：
```javascript
{
_User: [{
username: "someone",
ownerOfTodo: [
{title: "紧急 Bug 修复"},
{title: "打电话给 Peter"},
{title: "还信用卡账单"},
{title: "买酸奶"}
]
}]
}
```
你也可以在 Relation 上进行反向查询，例如查询每个 Todo 所属的 TodoFolder：
```graphql
query {
Todo {
title, containedTodosOfTodoFolder {
name
}
}
}
```
结果（省略了一部分）：
```javascript
{
Todo: [{
title: "紧急 Bug 修复",
containedTodosOfTodoFolder: [
{name: "工作"},
{name: "someone"}
]
}, {
title: "买酸奶",
containedTodosOfTodoFolder: [
{name: "购物清单"},
{name: "someone"}
]
}, {
title: "团队会议",
containedTodosOfTodoFolder: [
{name: "工作"}
]
}]
}
```
### 多级关系
在 GraphQL 中你甚至可以进行多层级的关系查询：
```graphql
query {
TodoFolder {
name,
containedTodos {
title, owner {
username, email
}
}
}
}
```
结果（省略了一部分）：
```javascript
{
TodoFolder: [{
name: "工作",
containedTodos: [{
title: "紧急 Bug 修复",
owner: {
username: "someone",
email: "test@example.com"
}
}, // ...
]
}, // ...
]
}
```
## 修改对象
GraphQL 毕竟是一个数据查询语言，因此我们仅提供了非常有限的创建和更新对象的功能。
### 创建对象
你可以这样创建一个对象，并要求服务器返回 objectId、标题和优先级：
```graphql
mutation {
Todo(title: "思考巨石阵是如何修建的") {
objectId, title, priority
}
}
```
结果：
```javascript
{
Todo: {
objectId: "5853adb7b123db006562f83b",
title: "思考巨石阵是如何修建的",
priority: 10
}
}
```
### 更新对象
然后你可以用非常相似的语法来更新这个对象（当你提供了 objectId 便是更新对象）：
```graphql
mutation {
Todo(objectId: "5853adb7b123db006562f83b", priority: 5) {
title, priority
}
}
```
结果：
```javascript
{
Todo: {
title: "思考巨石阵是如何修建的",
priority: 5
}
}
```
## 添加到现有项目
如果要添加到现有项目，需要先将 leancloud-graphql 添加为依赖：
npm install --save leancloud-graphql
请确保 Node.js 版本在 4.0 以上。
### 作为中间件添加
leancloud-graphql 导出了一个 express 中间件，可以直接添加到现有的 express 项目上：
```javascript
var leancloudGraphQL = require('leancloud-graphql').express;
var app = express();
app.use('/graphql', leancloudGraphQL());
```
leancloudGraphQL 有一些选项：
- `graphiql` 开启调试控制台，默认 true.
- `cors` 提供跨域支持，默认 true.
- `pretty` 格式化返回的 JSON。
使用该中间件时请确保环境变量中有 `LEANCLOUD_` 系列的环境变量，即需要运行在云引擎上或用 `lean up` 启动。
### 获取 GraphQLSchema
leancloud-graphql 默认导出了一个构建 GraphQLSchema 的函数：
```javascript
var buildSchema = require('leancloud-graphql');
var {printSchema} = require('graphql');
buildSchema({
appId: process.env.LEANCLOUD_APP_ID,
appKey: process.env.LEANCLOUD_APP_KEY,
masterKey: process.env.LEANCLOUD_APP_MASTER_KEY
}).then( schema => {
console.log(printSchema(schema));
});
```