高效的后端API开发模板-illuminant

概要

采用前后端分离的开发方式之后, 确实减轻了后端的开发负担, 但同时, 也加大了前后端开发之间沟通的负担.

最近, 我根据之前很长一段时间的项目实践, 总结了一套后端的开发框架, 主要是基于 golang 和 prisma. 它的主要功能在于:

1. 本身很简单, 更多的在于组合各种技术
2. 充分利用 prisma 服务生成的 graphql 接口, 几乎所有的 curd 操作都自动化
3. 除了通过 prisma 连接数据库, 也可以使用 golang 直接连接数据库, 使用了 这个 orm
4. 提供基本的 jwt 认证功能, 权限和业务关联比较紧, 目前从框架中去掉了
5. 各类型接口提供的示例 api(graphql/rest), 增加 restful 接口只要参照现有的接口就行
6. 上传/下载 提供接口示例, 也可以用来对接其他存储服务
7. 提供了 websocket 接口的示例
8. 整个 golang 工程其实就是个模板, git clone 之后改改名字, 通过配置好自己的 prisma schema, 就能直接使用

用好这个工程, 需要对 有一定的了解 项目名称 illuminant, 开源在 gitee.com: 欢迎试用!

整体介绍

1. 核心是 illuminant 工程
2. 其中 download/upload api 可以直接对接磁盘, 也可以对接存储服务
3. 通过反向代理连接 prisma 自动生成的的 graphql 接口
4. 通过 gorose orm 直接连接 mysql 数据库
5. 对外可以提供 3 种类型的接口
   • graphql: prisma 自动生成
   • rest: 作为自动生成接口的补充, 一般项目都不需要此类接口
   • websocket: 如有实时推送或类似这方面的需求, 可以实现相关接口

补充说明

q. 有了 prisma 自动生成的 graphql 接口, 为什么还要 rest 接口和 websocket 接口?

其实 prisma 自动生成的接口, 已经能够满足各类 curd 需求. 但是对于一些统计分析的需求, 或者需要后端进行分析和计算的需求, 可以自定义 rest api, 作为 graphql api 的扩展

q. 为什么要通过 illuminant 加一层反向代理, 而不是直接暴露 prisma 的 graphql 接口?

看过代码就知道, 其实 illuminant 中的反向代理就是直接将客户端的请求转发到 prisma, 没有任何特殊的操作. 但是直接暴露 prisma 生成的接口, 对于后续的管理不利, 至少想对接口做个简单的用户名/密码认证都很困难, 因为你不可能去改 prisma 的源码来支持你的认证机制.

加了一层之后, 可以在 illuminant 中更灵活的对来自客户端的请求进行控制, 后续就算想加权限也不是不可能, 而 prisma 的 graphql 服务, 可以把它看作是一个提供丰富的 graphql 接口的 orm

q. 既然 prisma 生成的 graphql 接口已经很强大, 为什么还需要 gorose orm 来连接数据库

prisma 的 graphql 确实很强大, 也能完成几乎所有的需求. 但是它还是有一些缺陷, 比如对事务的支持不是很好, 而且也不支持直接运行 sql 等等. 所以, illuminant 中留下这个口子, 也是为了更灵活的应对未知的需求.

illuminant 代码结构介绍

1. 紫色虚线部分: 是后端的入口
   • main.go: 主要是初始化配置文件, logger 等等
   • route.go: 基于 框架, 包含一些 api 示例(login, upload/download, graphql, todo 的 curd 等)
   • middleware: 暂时只有一个 jwt 认证的 middleware
2. 红色虚线部分: prisma 相关的部分, 其实整个 illuminant 框架主要就是想利用 prisma 来减轻 api 的开发
   • prisma: prisma 配置, 包括 prisma 服务定义(prisma.yml), 数据库模型定义(datamodel.prisma), 以及启动服务的 docker-compose.yml
   • prisma-client: 根据数据库自动生成的 prisma golang client, 除了反向代理, 也可以通过这个 client 来访问 prisma
3. 蓝色虚线部分: 和 prisma 并行的, 另一套自定义 api 的方式
   • controller: 处理请求和返回值
   • service: 处理实际业务, 连接 controller 和 model
   • model: 定义数据库的 orm
4. 黄色虚线部分: 共通的模块

解决的问题

illuminant 本意是要做个后端开发的模板, 目的是用来做项目前期的快速的尝试, 着重在提高后端的 开发的效率 上, 利用 prisma, 尽量减少后端的负担, 使得项目能够尽快使用起来, 尽快的验证需求.

如果要用来做为生产环境的系统, 其实也未尝不可. 权限部分的实现我在另外一个项目中也有尝试, 只是还没有集成到 illuminant 中.