什么是 Schema-First
优先设计 Schema,又称 SDL-First (Schema Definition Language)。
优势
-
大多数情况下,该方式能够产生设计良好的API
-
遵循依赖倒置原则(DIP),更加抽象,更少的依赖项
-
减少开发时间,允许前端和后端开发团队同时进行开发(因为 Schema 数据可以更容易地模拟,示例 Mock: https://github.com/graphql-editor/graphql-editor)
劣势
-
Schema 与 解析器(Resolver)必须同步更新、完全匹配,否则可能会导致严重的问题
-
SDL 定义重用性不佳(不包含解析器),可能会导致代码的冗余
-
难以将分布式架构合并成单个(需要借助第三方工具,如
graphql-editor
或graphql-tools
等)
什么是 Code-First
不是先写代码后设计!!!
又可以叫做(Resolver-First),优先写好解析器代码,然后生成 Schema(脚本创建,而不是手动创建)。
优势
-
同时涵盖了 Schema 的定义以及解析器(Resolvers),可以作为单一的事实来源
-
代码优先的方式可以无需使用大量的工具,轻松克服 Schema 优先中出现的困难
-
如果期望 Schema 在复杂度或大小上不断增加,代码优先的方式更易于管理
劣势
-
定义和解释器在一起降低了代码的可读性
-
API 设计更容易被实现影响,而不是业务需求
-
向后不兼容的更改更容易发生
进化
当 GraphQL 在 2015 年发布时,很生态圈尚未形成。那个时代,我们只能通过官方的定义和graphql-js
(官方的 JavaScript 实现)来创建 GraphQL 项目。
到了 2016 年,graphql-tools
项目发布了,并且首次推广 Schema 优先的方式,分离出了两个层面来:
- Schema 定义(Definition):使用 SDL(Schema Definition Language) 编写 GraphQL Schema定义
- Schema 实现(Implementation):编写所需的解释器(Resolvers)代码
在这之后,很长一段时间里 Schema-First 成为了 GraphQL 项目默认方案。由于该方式的局限性,人们开始寻找一些新的解决方案,第一个 Code-First 的框架应运而生。
后来, Code-First 方案流行了起来,以至于现在几乎每一个框架都有其 Code-First 方案,甚至只关注 Code-First 解决途径。
框架推荐
-
Prisma: https://www.prisma.io/graphql
-
DataLoader: http://dataloader.js.cool/
-
Nexus: https://nexusjs.org/