这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天
Go框架三件套详解 | 青训营笔记
1. 三件套介绍
- Gorm：一个已经迭代了10+年的功能强大的
ORM框架，拥有非常丰富的开源扩展 - Kitex：字节内部的
Golang微服务RPC框架，具有高性能、强可扩展性的主要特点，支持多协议并拥有丰富的开源扩展 - Hertz：字节内部的
HTTP框架，参考了其他开源框架的优势，结合字节跳动内部的需求，具有高易用性、高性能、高扩展性特点
2. Gorm
2.1 Gorm的基础使用
Gorm有几条默认的约定：
- Gorm使用名为
ID的字段作为主键 - 使用结构体的蛇形负数作为表名
- 字段名的蛇形作为列名
- 使用
CreatedAt、UpdatedAt字段作为创建、更新时间
图示为Gorm的基本使用案例：
2.2 Gorm支持的数据库
Gorm目前支持MySQL、SQLServer、PostgreSQL、SQLite等。Gorm通过驱动来连接数据库，如果需要连接其他类型的数据库，可以复用/自行开发驱动。 图示为连接SQLServer数据库的例子：
2.3 Gorm创建数据
使用clause.OnConflict处理数据冲突，使用default标签为字段定义默认值
2.4 Gorm查询数据
First避坑：使用First时，查询不到数据会返回ErrRecordNotFound错误；使用Find查询多条数据，查询不到数据不会返回错误。- 使用结构体作为查询条件：Gorm只会查询非零值字段，这意味着如果字段值为
0、''、false或其他零值，该字段不会被用于构建查询条件，可使用Map来构建查询条件。
2.5 Gorm更新数据
使用Struct更新时，只会更新非零值，如果需要更新零值可以使用Map更新或使用Select选择字段。
2.6 Gorm删除数据
有两种删除方式：物理删除和软删除。Gorm提供了gorm.DeletedAt用于帮助用户实现软删，拥有软删能力的Model调用Delete时，记录不会被从数据库中真正删除。但Gorm会将DeletedAt置为当前时间，并且不能再通过正常的查询方法找到该记录。使用Unscoped可以查询到被软删的数据。
2.7 Gorm事务
Gorm提供了Begin、Commit、Rollback方法用于使用事务，提供了Transaction方法用于自动提交事务，避免用户漏写Commit、Rollback。
Begin——开始事务Rollback——遇到错误时回滚事务Commit——提交事务
2.8 Gorm Hook
Gorm在提供了CURD的Hook能力，Hook是在创建、查询、更新、删除等操作之前、之后自动执行的函数。如果任何Hook返回错误，Gorm将停止后续的操作并回滚事务。
2.9 Gorm性能提高
对于写操作（创建、更新、删除），为了确保数据的完整性，Gorm会将它们封装在事务内运行。但这会降低性能，可以使用SkipDefaultTransaction关闭默认事务。使用PrepareStmt缓存预编译语句可以提高后续调用的速度。
2.10 Gorm生态
Gorm拥有非常丰富的扩展生态，列举一部分常用的扩展：
| 扩展生态 | 链接 |
|---|---|
| Gorm代码生成工具 | github.com/go-gorm/gen |
| Gorm分片库方案 | github.com/go-gorm/sha… |
| Gorm手动索引 | github.com/go-gorm/hin… |
| Gorm乐观锁 | github.com/go-gorm/opt… |
| Gorm读写分离 | github.com/go-gorm/dbr… |
| Gorm OpenTelemetry扩展 | github.com/go-gorm/ope… |
关于更多的Gorm用法可以查看Gorm文档
3. Kitex
3.1 安装Kitex代码生成工具
Kitex目前对Windows的支持不完善，如果本地开发环境为Windows，建议使用虚拟机或WSL2 安装代码生成工具的命令：
go install github.com/cloudwego/kitex/tool/cmd/kitex@latest
go install github.com/cloudwego/thriftgo@latest
kitex -version // 查看安装的kitex版本
3.2 定义IDL
使用IDL定义服务与接口。如果要进行RPC，需要知道对方的接口是什么，需要传什么参数，需要知道返回的值是什么样的。这时候，就需要通过IDL来约定双方的协议，就像在写代码的时候需要调用某个函数，需要知道函数签名一样。
3.3 Kitex生成代码
使用kitex -module example -service example echo.thrift命令生成代码
- build.sh: 构建脚本
- kitex_gen: IDL内容相关的生成代码，主要是基础的Server/Client代码
- main.go: 程序入口
- handler.go: 用户在该文件里实现IDL Service定义的方法
3.4 Kitex的服务发现与注册
目前Kitex的服务注册于发现已经对接了主流的服务注册于发现中心，如ETCD、Nacos等。
3.5 Kitex生态
参考www.cloudwego.io/zh/docs/kit…
| 扩展 | 链接 |
|---|---|
| XDS扩展 | github.com/kitex-contr… |
| opentelemetry扩展 | github.com/kitex-contr… |
| ETCD服务注册于发现扩展 | github.com/kitex-contr… |
| Nacos服务注册与发现扩展 | github.com/kitex-contr… |
| Zookeeper服务注册与发现扩展 | github.com/kitex-contr… |
| polaris扩展 | github.com/kitex-contr… |
| 丰富的实例代码与业务Demo | github.com/cloudwego/k… |
4. Hertz
4.1 Hertz路由
- Hertz提供了
GET、POST、PUT、DELETE、ANY等方法用于注册路由 - Hertz提供了路由组的功能，用于支持路由分组
- Hertz提供了参数路由和统配路由，路由的优先级为：静态路由 > 命名路由 > 通配路由
4.2 Hertz参数绑定
提供了Bind、Validate、BindAndValidate函数用于进行参数绑定和校验。
4.3 Hertz中间件
- Hertz的中间件主要分为客户端中间件与服务端中间件
- 提供了HTTP Client用于帮助用户发送HTTP请求
4.4 Hertz生成工具
提供了代码生成工具Hz，通过定义IDL（interface description Language）文件即可生成对应的基础服务代码。
4.5 Hertz生态
| 扩展生态 | 链接 |
|---|---|
| HTTP2扩展 | github.com/hertz-contr… |
| opentelemetry扩展 | github.com/hertz-contr… |
| 国际化扩展 | github.com/hertz-contr… |
| 反向代理扩展 | github.com/hertz-contr… |
| JWT鉴权扩展 | github.com/hertz-contr… |
| Websocket扩展 | github.com/hertz-contr… |
| 丰富的实例代码与业务Demo | github.com/hertz-contr… |
