GraphQL 渐进学习 07-graphql-node-server-模块化
目标
- 为了便于维护，模块化
node 服务端代码 - 代码抽取层次分为
-
schema定义类型业务对象查询更改
-
resolvers实现查询方法
-
typeResolvers实现自定义类型标准类型
-
utils工具mock
-
代码
- graphQL-example/modular/
目录结构
.
├── index.js | 主程序
├── resolvers | 查询 更新 实现
│ ├── Mutations.js | 更新
│ ├── Querys.js | 查询
│ └── index.js | 入口
├── schema | 模型定义
│ ├── business | 业务定义
│ │ ├── comment.graphql | 评论
│ │ └── post.graphql | 文章
│ └── std | 类型定义
│ ├── Mutation.graphql | 更新
│ ├── Query.graphql | 查询
│ ├── enum.graphql | 枚举
│ ├── interface.graphql | 接口
│ ├── scalar.graphql | 自定义类型
│ └── union.graphql | 联合
├── typeResolvers | 类型实现
│ ├── index.js | 入口
│ ├── interfaces.js | 接口
│ ├── scalars.js | 自定义类型
│ ├── types.js | 业务类型
│ └── unions.js | 联合
└── utils | 工具
└── mock.js | 模拟
- 说明
- 这是按
Graphql组件层次来切分的，适合小业务项目 - 如果是业务系统庞大，就需要外面套一层
子业务模块的目录 - 如果业务很微小，可以把目录下的多个文件合成一个，切的过于细小也带来维护的麻烦，具体尺度自己感觉哈
- 这是按
步骤
1. schema 定义采用文件扩展名 .graphql
规范点总有好处的，你可以写成 .gpl 或者 .graphql
2. 安装 VSCode 语法支持插件 GraphQL for VSCode
安装地址 GraphQL for VSCode
语法高亮
[图片上传失败...(image-946a1-1526182107083)]前去定义
[图片上传失败...(image-7b878c-1526182107083)]自动完成代码
[站外图片上传中...(image-f7dbb3-1526182107083)]
我主要用语法高亮
3. 安装 npm 插件 require-graphql-file 支持模块化 .graphql 文件
- 安装插件
npm i -S require-graphql-file
- 使用，打开
index.js
import requireGraphQLFile from 'require-graphql-file'
...
// 读取 schema
const typeDefs = [
requireGraphQLFile('./schema/std/scalar'),
// requireGraphQLFile('./schema/std/enum'),
// requireGraphQLFile('./schema/std/interface'),
// requireGraphQLFile('./schema/std/union'),
requireGraphQLFile('./schema/business/post'),
requireGraphQLFile('./schema/business/comment'),
requireGraphQLFile('./schema/std/Query'),
requireGraphQLFile('./schema/std/Mutation')
]
...
// 合并 schema
const schema = makeExecutableSchema({
typeDefs,
...
})
其实就是读取
文本文件，然后合并了传参给makeExecutableSchema
4. 编写 schema 定义
-
按
业务类型和组件类型切分因为
业务类型的文件名都是有意义的业务名称PostComment而
组件类型的名字可以很确定enuminterfaceunionscalar方便查找
目录文件
├── schema | 模型定义
│ ├── business | 业务定义
│ │ ├── comment.graphql | 评论
│ │ └── post.graphql | 文章
│ └── std | 类型定义
│ ├── Mutation.graphql | 更新
│ ├── Query.graphql | 查询
│ ├── enum.graphql | 枚举
│ ├── interface.graphql | 接口
│ ├── scalar.graphql | 自定义类型
│ └── union.graphql | 联合
-
代码参考
- modular/schema/std/
- modular/schema/business/
主程序调用
见上文
5. 编写 分解器 代码
-
我认为
分解器代码有两种- 1 实现
Query查询Mutations更新, 我都放在resolvers目录 - 2 定义各种类型
interfacescalartypeunion, 都放在typeResolvers目录
- 1 实现
目录文件
├── resolvers | 查询 更新 实现
│ ├── Mutations.js | 更新
│ ├── Querys.js | 查询
│ └── index.js | 入口
├── typeResolvers | 类型实现
│ ├── index.js | 入口
│ ├── interfaces.js | 接口
│ ├── scalars.js | 自定义类型
│ ├── types.js | 业务类型
│ └── unions.js | 联合
-
代码参考
- modular/resolvers/
- modular/typeResolvers/
主程序调用
import resolvers from './resolvers'
import typeResolvers from './typeResolvers'
...
// 合并 schema
const schema = makeExecutableSchema({
typeDefs,
resolvers,
typeResolvers,
resolverValidationOptions: {
requireResolversForResolveType: false
}
})
-
resolverstypeResolvers目录下写了index.js进行合并
6. 工具 mock
- 为了测试方便，我都用
mock数据
如何模拟请移步 06-graphql-采用-mockjs-mock数据
测试
# 请求
{
posts {
id
title
content
author
addtime
comments {
id
message
author
addtime
}
}
}
# 输出
{
"data": {
"posts": [
{
"id": 90932,
"title": "十分长现维整",
"content": "常气火热成或",
"author": "文霞",
"addtime": "10:21:14",
"comments": [
{
"id": 30874,
"message": "十称军题片格员主实",
"author": "局反重间半何",
"addtime": "22:05:28"
},
{
"id": 7088,
"message": "克此快候己林层省",
"author": "备从当提属",
"addtime": "15:45:27"
},
{
"id": 74989,
"message": "部织温制流统响教广",
"author": "领重你包计",
"addtime": "03:06:03"
},
{
"id": 24501,
"message": "识消己满军子酸",
"author": "调始相内向中取造还比",
"addtime": "05:15:38"
},
{
"id": 91765,
"message": "重开流报着色运党快但",
"author": "儿动内心放改声口立",
"addtime": "04:53:28"
},
{
"id": 48731,
"message": "气即感共就林始",
"author": "进在层只作",
"addtime": "10:29:44"
}
]
},
{
"id": 67359,
"title": "开被几此图位便目作",
"content": "应众级向由把",
"author": "孟杰",
"addtime": "16:49:30",
"comments": [
{
"id": 28432,
"message": "大命格我就战历",
"author": "亲但美在号场米商",
"addtime": "13:18:11"
},
{
"id": 36258,
"message": "红条由近的备级",
"author": "自团人老以音状装指号",
"addtime": "13:17:17"
},
{
"id": 90117,
"message": "么整片外习达离",
"author": "满步该律特",
"addtime": "16:10:35"
},
{
"id": 14731,
"message": "场等九百市很安",
"author": "白石价和林风农",
"addtime": "18:33:41"
},
{
"id": 23523,
"message": "二面化权文及照万",
"author": "运现里新政过铁",
"addtime": "17:51:59"
},
{
"id": 77423,
"message": "划群低矿流按看实养",
"author": "个为然工些效",
"addtime": "21:56:41"
}
]
}
]
}
}
参考
graphql-tools/generate-schema
require-graphql-file