GraphQL语法用于模式验证和代码生成的新方法

2024-01-22 00:04

本文主要是介绍GraphQL语法用于模式验证和代码生成的新方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

GraphQl学习文档

Nav Inc.已经创建了一个开源模式定义和代码生成器,它使用GraphQL语法来定义事件和消息格式。选择GraphQL是因为它的表达能力和对开发人员的熟悉程度;Nav模式体系结构(NSA)不使用GraphQL runtime。

GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 API 更容易地随着时间推移而演进,还能用于构建强大的开发者工具。

使用GraphQL可以同时表达数据模型Schema和携带该数据模型实体的消息格式,不需要分别定义。

NSA的主要目的是生成多种语言的代码和模式,都是基于使用GraphQL的根定义。输出可以是其他模式语言,比如protobuf或JSON schema,也可以是当前支持Go、Ruby和Python的代码。

公共数据模型的好处在于能够轻松地在多个团队和服务之间传播其实现。构建管道将监视特性分支上的模式更改,并启动第二个管道来生成所有目标语言的输出。将输出提交回特性分支,开发人员可以在合并到主分支之前检查更改。

InfoQ和Nav的谈话

InfoQ会见了Nav项目的一些开发人员,以便更好地理解他们试图解决的问题以及他们从这种方法中看到的好处。

InfoQ:契约优先的开发并不是一个新想法,但是我们会更经常地看到OpenAPI和JSON Schema被用来定义契约。是什么促使您决定使用GraphQL语法作为契约的主要真实性来源,然后从中派生契约?

Nav开发团队:我们决定使用GraphQL有几个原因。GraphQL与OpenAPI和JSONSchema等其他系统的区别在于,GraphQL包含了定义公共数据模型和消息模式的方法,这是同一个问题。一个有效的系统必须允许一种简单的方法来定义两者。GraphQL是一种有效负载描述语言,它解决了在单一领域特定语言中使用验证规则和消息模式定义有效负载的问题。该语言包括一个基于graphql的类型系统,就像任何接口定义语言一样。这个类型系统支持标量、对象、枚举以及这些类型值的基本验证。我们使用这个类型系统来定义有效载荷和自定义验证规则(例如数据格式、允许值范围、正则表达式匹配和必需属性)。消息契约只是基于有效负载类型的消息模式定义。定义消息契约时,可以根据有效负载类型选择在消息契约中包含哪些字段。

另一个原因是,GraphQL语法是人类可读的,与JSON Schema相比,使用起来更简单。这促进了团队之间的沟通。

我们使用NSA从单个GraphQL公共信息模型中生成特定于语言的消息结构,以及JSON和Protobuf模式。因此,除了代码生成之外,NSA还被用于将GraphQL转换为JSON/Protobuf模式。

InfoQ:你的系统架构主要使用异步消息传递还是请求-响应?NSA适用于这两种方法吗?

Nav开发团队:NSA也可以很容易地在请求/响应系统中使用。与AWS Eventbridge和SQS一样,NSA输出结构可以与JSON或任何其他结构化数据格式序列化。实际上,NSA的一个输出目标是谷歌的Protocol Buffers。

NSA将重点放在验证上,与端点管理分离。在NSA中没有对端点、订阅者或发布者的引用。来自NSA的输出代码可以被任何自己管理传输方法的适配器使用。

InfoQ:你还考虑过其他什么设计,你怎么认为这是最好的方法?具体来说,你是否考虑过使用OpenAPI/AsyncAPI或protobuf作为代码生成的语法?

Nav开发团队:在我们当前的体系结构中,不需要使用冗余的异步工具,如AsyncAPI。

AsyncAPI可以有任何消息有效负载,因此NSA生成的输出可以用作AsyncAPI消息模式。我们间接使用Protobuf消息定义作为NSA的输出目标。

AsyncAPI尝试与AWS EventBridge一起处理不必要的传输。此外,将验证与传输逻辑耦合在一起将使我们的系统更加复杂,保持关注点的分离使开发更加容易。

InfoQ:GraphQL模式是存储在单独的repos中,还是存储在生产者或消费者中?

Nav开发团队:GraphQL模式当前存储在与处理器和随后生成的代码相同的存储库中。因为生成的代码本身只涉及到消息验证,所以它被Nav中的许多库和应用程序用作依赖项(无论是生产者、消费者还是一个简单的文档工具)

虽然我们的项目以monorepo形式存在,但情况不一定如此。可以根据职责将项目划分为多个repos,一个或多个repos可以包含GraphQL及其类型扩展,这些类型扩展最终合并为一个模式,作为解析器输入。另一个repo可以容纳解析器本身,它可以作为子模块连接一个或多个代码生成repo。repos的第四层可以包含生成的代码,每种语言一个repos,以及所有必要的验证、测试和打包逻辑。最后,这些不包含传输机制逻辑的包可以被客户端库使用。

更多内容请查看该链接:www.infoq.com/news/2022/0…

原文链接:GraphQL语法用于模式验证和代码生成的新方法 - 掘金 (juejin.cn)

这篇关于GraphQL语法用于模式验证和代码生成的新方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/631252

相关文章

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

SpringBoot实现数据库读写分离的3种方法小结

《SpringBoot实现数据库读写分离的3种方法小结》为了提高系统的读写性能和可用性,读写分离是一种经典的数据库架构模式,在SpringBoot应用中,有多种方式可以实现数据库读写分离,本文将介绍三... 目录一、数据库读写分离概述二、方案一:基于AbstractRoutingDataSource实现动态

Linux系统配置NAT网络模式的详细步骤(附图文)

《Linux系统配置NAT网络模式的详细步骤(附图文)》本文详细指导如何在VMware环境下配置NAT网络模式,包括设置主机和虚拟机的IP地址、网关,以及针对Linux和Windows系统的具体步骤,... 目录一、配置NAT网络模式二、设置虚拟机交换机网关2.1 打开虚拟机2.2 管理员授权2.3 设置子

Java中的String.valueOf()和toString()方法区别小结

《Java中的String.valueOf()和toString()方法区别小结》字符串操作是开发者日常编程任务中不可或缺的一部分,转换为字符串是一种常见需求,其中最常见的就是String.value... 目录String.valueOf()方法方法定义方法实现使用示例使用场景toString()方法方法

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

macOS无效Launchpad图标轻松删除的4 种实用方法

《macOS无效Launchpad图标轻松删除的4种实用方法》mac中不在appstore上下载的应用经常在删除后它的图标还残留在launchpad中,并且长按图标也不会出现删除符号,下面解决这个问... 在 MACOS 上,Launchpad(也就是「启动台」)是一个便捷的 App 启动工具。但有时候,应

opencv图像处理之指纹验证的实现

《opencv图像处理之指纹验证的实现》本文主要介绍了opencv图像处理之指纹验证的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录一、简介二、具体案例实现1. 图像显示函数2. 指纹验证函数3. 主函数4、运行结果三、总结一、

SpringBoot日志配置SLF4J和Logback的方法实现

《SpringBoot日志配置SLF4J和Logback的方法实现》日志记录是不可或缺的一部分,本文主要介绍了SpringBoot日志配置SLF4J和Logback的方法实现,文中通过示例代码介绍的非... 目录一、前言二、案例一:初识日志三、案例二:使用Lombok输出日志四、案例三:配置Logback一

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

mysql出现ERROR 2003 (HY000): Can‘t connect to MySQL server on ‘localhost‘ (10061)的解决方法

《mysql出现ERROR2003(HY000):Can‘tconnecttoMySQLserveron‘localhost‘(10061)的解决方法》本文主要介绍了mysql出现... 目录前言:第一步:第二步:第三步:总结:前言:当你想通过命令窗口想打开mysql时候发现提http://www.cpp