Go框架三件套 | 青训营笔记

118 阅读5分钟

这是我参与「第五届青训营」笔记创作活动的第3天。

一、本堂课重点知识

今天课程的主要内容是对Go框架三件套Gorm、Kitex、Hertz的介绍和详细讲解。

二、详细知识点介绍

1. Gorm

Gorm是一个已经迭代了10年+的功能强大的ORM框架,在字节内部被广泛使用并且拥有非常丰富的开源扩展。

1.1 Gorm的约定(默认)

文档

  • Gorm使用名为ID的字段作为主键
  • 使用结构体的蛇形负数作为表名
  • 字段名的蛇形作为列名
  • 使用CreatedAt、UpdatedAt字段作为创建、更新时间

1.2 Gorm支持的数据库

文档

GORM目前支持MySQL、SQLServer、PostgreSQL、SQLite。 GORM通过驱动来连接数据库,如果需要连接其他类型的数据库,可以复用/自行开发驱动。

1.3 Gorm创建数据

文档

  • 如何使用Upsert

    • 使用clause.OnConflict处理数据冲突
  • 如何使用默认值

    • 通过使用default标签为字段定义默认值

1.4 Gorm查询数据

文档

  • First的使用踩坑

    • 使用First时,需要注意查询不到数据会返回ErrRecordNotFound。
    • 使用Find查询多条数据,查询不到数据不会返回错误。
  • 使用结构体作为查询条件

    • 当使用结构作为条件查询时,GORM只会查询非零值字段。这意味着如果您的字段值为0、“”、false或其他零值,该字段不会被用于构建查询条件,使用Map来构建查询条件。

1.5 Gorm更新数据

文档

使用Struct更新时,只会更新非零值,如果需要更新零值可以使用Map更新或使用Select选择字段。

1.6 Grom删除数据

文档

  • 物理删除
  • 软删除

Gorm提供了gorm.DeletedAt用于帮助用户实现软删

拥有软删除能力的Model调用Delete时,记录不会被从数据库中真正删除。但Gorm会将DeletedAt置为当前时间,并且你不能再通过正常的查询方法找到该记录。

使用Unscoped可以查询到被软删的数据

1.7 Gorm事务

文档

Gorm提供了Begin、Commit、Rollback方法用于使用事务

Gorm提供了Transaction方法用于自动提交事务,避免用户漏写Commit、Rollback。

1.8 Gorm Hook

文档

Gorm提供了CURD的Hook能力。

Hook是在创建、查询、更新、删除等操作之前、之后自动调用的函数。

如果任何Hook返回错误,Gorm将停止后续的操作并回滚事务。

1.9 Gorm性能提高

文档

对于写操作(创建、更新、删除),为了确保数据的完整性,Gorm会将它们封装在事务内运行。但这会降低性能,你可以使用SkipDefaultTransaction关闭默认事务。

使用PrepareStmt缓存预编译语句可以提高后续调用的速度,本机测试提高大约35%左右。

1.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文档

2. Kitex

Kitex是字节内部的Golang微服务RPC框架,具有高性能、强可扩展的主要特点,支持多协议并且拥有丰富的开源扩展。

2.1 安装Kitex代码生成工具

文档

Kitex目前对Windows的支持不完善,Windows建议使用虚拟机或者WSL2。

go install github.com/cloudwego/kitex/tool/cmd/kitex@latest
go install github.com/cloudwego/thriftgo@latest

2.2 定义IDL

  • 使用IDL定义服务与接口
    • 如果我们要进行RPC,就需要知道对方的接口是什么,需要传什么参数,同时也需要知道返回值是什么样的。这时候,就需要通过IDL来约定双方的协议,就像在写代码的时候需要调用某个函数,我们需要知道函数签名一样。

Thrift

Proto3

2.3 Kitex生成代码

使用kitex-module example-service example echo.thrift命令生成代码

  • build.sh:构建脚本
  • kitex_gen:lDL内容相关的生成代码,主要是基础Server/Clien代码。
  • main.go:程序入口
  • handler.go:用户在该文件里实现IDL service定义的方法

2.4 Kitex生态

Kitex拥有1非常丰富的扩展生态,以下列举一部分常用扩展。

扩展地址
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…
丰富的示例代码与业务Demogithub.com/cloudwego/k…

3. Hertz

Hertz是字节内部的HTTP框架,参考了其他开源框架的优势,结合字节跳动内部的需求,具有高易用性、高性能、高扩展性的特点。

3.1 Hertz路由

  • Hertz提供了GET、POST、PUT、DELETE、ANY等方法用于注册路由。
  • Hertz提供了路由组(Group)的能力,用于支持路由分组的功能
  • Hertz提供了参数路由和通配路由,路由的优先级为:静态路由>命名路由>通配路由

3.2 Hertz参数绑定

Hertz提供了Bind、Validate、BindAndValidate函数用于进行参数绑定和校验

3.3 Hertz中间件

Hertz的中间件主要分为客户端中间件与服务端中间件。

  • 如何终止中间件调用链的执行
    • c.Abort
    • c.AbortWithMsg
    • c.AboutWithStats

3.4 Hertz Client

Hertz提供了HTTP Client用于帮助用户发送HTTP请求

3.5 Hertz代码生成工具

Hertz提供了代码生成工具Hz,通过定义IDL(inteface deseription language)文件即可生成对应的基础服务代码。

3.6 Hertz性能

  1. 网络库Netpoll
  2. Json编解码Sonic
  3. 使用sync.Pool复用对象协议层数据解析优化

3.7 Hertz生态

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…
丰富的示例代码与业务Demogithub.com/cloudwego/h…

三、实践练习例子

  • 笔记项目
    • 一个使用Hertz、Kitex、Gorm搭建出来的具备一定业务逻辑的后端API项目。

四、课后个人总结

前两天学习了语言相关的知识,今天的内容则是Go语言框架的知识。通过今天的学习,只是对框架三件套有了基础的一个理解,还要在后面的学习中不断巩固,学习更深层次的知识。

五、引用参考

Gorm文档

Kitex文档

Hertz文档