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

183 阅读5分钟

这是我参与「第五届青训营」笔记创作活动的第5天。笔记旨在记录自己的学习过程以及跟更多人分享交流,重点讲干货,不扣细节,从整体认知。废话不多说,上内容!!!

本堂课重点内容

  1. 三件套(Gorm/Kitex/Hertz)的介绍
  2. 三件套的使用
  3. 实战案例

详细知识点介绍

三件套的介绍

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

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

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

三件套的使用

Gorm

基本使用

Gorm的约定(默认)

Gorm使用名为ID的字段作为主键

使用结构体的蛇形负数作为表名

字段名的蛇形作为列名

使用CreatedAt、UpdatedAt字段作为创建、更新时间

gorm.cn/zh_CN/docs/…

支持的数据库

GORM 目前支持 MySQL、SQLServer、PostgreSQL、SQLite.

GORM 通过驱动来连接数据库,如果需要连接其它类型的数据库,可以复用/自行开发驱动。

gorm.cn/zh_CN/docs/…

什么是 DSN

github.com/go-sql-driv…

创建数据
  • 如何使用 Upsert ?

使用 clause.OnConflict 处理数据冲突

  • 如何使用默认值?

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

gorm.cn/zh_CN/docs/…

查询数据
  • First 的使用踩坑

使用 First 时,需要注意查询不到数据会返回 ErrRecordNotFound。

使用 Find 查询多条数据,查询不到数据不会返回错误。

  • 使用结构体作为查询条件

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

更新数据

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

gorm.cn/zh_CN/docs/…

删除数据
  • 物理删除

  • 软删除

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

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

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

gorm.cn/zh_CN/docs/…

事务

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

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

gorm.cn/zh_CN/docs/…

Hook

GORM在提供了CURD的Hook能力。

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

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

gorm.cn/zh_CN/docs/…

性能提高

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

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

gorm.cn/zh_CN/docs/…

生态

1.png

Kitex

安装 Kitex 代码生成工具

Kitex 目前对 Windows 的支持不完善,如果本地开发环境是 Windows 的同学建议使用虚拟机或 WSL2

  • 安装代码生成工具

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

go install github.com/cloudwego/thriftgo@latest

www.cloudwego.io/zh/docs/kit…

定义 IDL

使用 IDL 定义服务与接口

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

Thrift : thrift.apache.org/docs/idl

Proto3 : developers.google.com/protocoi-bu…

www.cloudwego.io/zh/docs/kit…

生成代码

2.png

基本使用

服务默认监听 8888 端口

www.cloudwego.io/zh/docs/kit…

Kitex Client 发起请求

3.png

服务注册与发现

目前 Kitex 的服务注册与发现已经对接了主流了服务注册与发现中心,如 ETCD,Nacos 等。

www.cloudwego.io/zh/docs/kit…

github.com/kitex-contr…

生态

4.png

Hertz

基本使用

5.png

路由

Hertz 提供了 GET、POST、PUT、DELETE、ANY 等方法用于注册路由。

Hertz 提供了路由组 (Group) 的能力,用于支持路由分组的功能

Hertz 提供了参数路由和通配路由,路由的优先级为:静态路由 > 命名路由 > 通配路由

www.cloudwego.io/zh/docs/her…

参数绑定

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

www.cloudwego.io/zh/docs/her…

中间件

Hertz 的中间件主要分为客户端中间件与服务端中间件,如下展示一个服务端中间件。

www.cloudwego.io/zh/docs/her…

Client

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

github.com/cloudwego/h…

代码生成工具

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

www.cloudwego.io/zh/docs/her…

1.png

性能

2.png

生态

3.png

实践练习例子

项目介绍

1.png

2.png

3.png

4.png

5.png

6.png

关键代码

7.png

8.png

9.png

10.png

课后个人总结

  1. 了解了三件套的作用,也熟悉了学一个框架的步骤;
  2. 对一个项目的技术栈应用有了更具体的了解;

关于文中代码项目下载

  1. 安装 Git,参考 链接
  2. 登录 Github clone 链接
  3. 从 Github 上克隆项目,参考 链接

引用参考

  1. 字节直播课
  2. Go 框架三件套详解
  3. 后端专场 学习资料一 第五届字节跳动青训营
  4. Kitex 等的官方文档