自 2009 年开源以来,Go 作为一种强大、高效、简洁、易上手的编程语言,在帮助阅读、调试和维护大型软件系统上发挥着越来越重要的作用。而依托其健康生态,Golang 社区也相继涌现出诸如 beego、gin、chi、go-restful 等知名框架,为 Go 提供额外功能支持。
但选择过多,反受其乱。面对层出不穷的优秀框架,不同团队、不同开发者在框架选择上往往会出现分歧,不同框架之间也彼此壁垒高筑,导致业务与框架耦合,开发效率大大降低。
为了解决这类问题,才云 Caicloud 实现了 Golang API 框架 Nirvana,把 API 从对框架的依赖中彻底解放出来。它专为提高生产力和可用性设计,可扩展、性能高,旨在成为才云 Caicloud 所有 Golang 服务的基石,助力业务的高速开发。
接轨 Kubernetes 这些痛点不可忽视
近年来,为了满足业务发展需要,应对日益激烈的市场竞争,大量企业开始使用容器部署云工作负载。而随着容器使用量的增长、Kubernetes 成为容器编排的事实标准,在 Kubernetes 上打造新一代容器云平台成了企业谋求发展的必由之路。
为了顺应时局,技术团队除了进行思维上的转变,还要应对团队和业务方向的调整,对团队项目和产品完成切割分化。这之中就涉及对 Go 框架变更的抉择。
两年前,才云 Caicloud 团队在构建基于 Kubernetes 的云平台时,在框架上遇到了不少麻烦:当时 Kubernetes 正值发展期,为了快速开发,工程师们往往倾向于选择自己熟悉的框架。因此,虽然大多数项目用的是 go-restful(Kubernetes 的选型),但用 beego、gin、chi 等框架的工程师也不在少数,这就给业务整合带来了很多问题:
- 不同框架对 API 的描述形式不一致,这增加了不同团队间的沟通成本;
- 不同框架 API 风格差距较大,文档自动化困难;
- 错误定义和处理方式在不同项目之间存在差别,会导致客户端处理困难。
曾经开放的工程师文化成了变革的最大阻力。
Nirvana 的缘起
Nirvana 就是在这个背景下诞生的。
它借鉴了 Kubernetes 声明式 API 的设计,巧妙规避了框架对 API 的侵入。同时,为了实现业务和框架的隔离,它定义一个规范,让 API 按照规范书写,完全屏蔽了框架对 API 的影响。
一言以蔽之,Nirvana 框架的设计思路始终围绕工程师们亲历的种种痛点:
- 构建风格一致的 API 项目;
- 使用统一的 RESTful 路由与声明式 API 定义,避免业务对框架产生依赖;
- 使用统一的错误生成和处理方式;
- 提供开箱即用的基础功能,包括 Prometheus metrics、tracing、profiling 等;
- 自动生成 API 文档和客户端代码。
在 Nirvana 中,我们用一套 API Definition 来声明式地描述业务 API。下面是一个列出消息列表 API 的例子:
Definition{ // 这个 API 返回的是资源数组,所以使用 List 方法。 Method: def.List, // Summary 是一个短语,用于描述这个 API 的用途。这个短语在生成文档和客户端的时候用于区分 API。 // 这个字符串去掉空格后会作为生成客户端时的函数名,