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

掘金课程录播：ppt-Go框架三件套详解.pptx

一、本堂课重点内容：

• github.com/cloudwego/h…
• github.com/cloudwego/k…
• github.com/go-gorm/gor…

二、详细知识点介绍：

1. 课程介绍

• Gorm：ORM框架
• Kitex：字节内部Golang微服务RPC框架，高性能、强可扩展
• Hertx：字节内部HTTP框架

2. 三件套的使用

2.1 GORM

2.1.1 Gorm的基本使用：

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

2.1.2 GORM 支持的数据库

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

PS：什么是DSN: go-sql-driver/mysql#dsn-data-source-name

2.1.3 GORM 创建数据

使用clause.OnConflict处理数据冲突

p := &Product{Code : "D42", ID: 1}
db.Clauses(clause.OnConflict{DoNothing: true}).Create(&p)

注意动词函数名表示sql已经执行，在此之后继续罗列条件不会生效

2.1.4 GORM 查询数据

• First的使用踩坑：使用First时，需要注意查询不到数据会返回ErrRecordNotFound。使用Find查询多条数据，查询不到数据不会返回错误。
• 使用结构体作为查询条件：当使用结构作为条件查询时，GORM只会查询非零值字段。这意味着如果您的字段值为0、"、false 或其他零值，该字段不会被用于构建查询条件，使用Map来构建查询条件。

2.1.5 Gorm 更新数据

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

2.1.6 GORM 删除数据（物理删除/软删除）

• GORM提供了gorm.DeletedAt盱帮助用户实现软删
• 拥有软删除能力的Model调用Delete时，记录不会被从数据库中真正删除。但GORM会将DeletedAt置为当前时间，并且你不能再通过正常的查询方法找到该记录。
• 使用Unscoped可以查询到被软删的数据

2.1.7 GORM 事务

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

tx := db.Begin()  // 开始事务
// 返回一个新的db对象，此时链接已经固化，不会再使用链接池里的链接了

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

2.1.8 GORM Hook

• GORM在提供了CURD的Hook能力。
• Hook是在创建、查询、更新、删除等操作之前、之后自动调用的函数。
• 如果任何Hook返回错误，GORM将停止后续的操作并回滚事务。

2.1.9 Gorm 性能提高

• 对于写操作（创建、更新、删除）没有关联创建和Hook的时候没有必要去使用默认事务。使用SkipDefaultTransaction关闭默认事务。
• 使用PrepareStmt缓存预编译语句可以提高后续调用的速度，本机测试提高大约35 %左右。

2.2 Kitex

Kitex目前对Windows的支持不完善,如果本地开发环境是Windows的同学建议使用虚拟机或WSL2。 安装代码生成工具：

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

推荐使用官方程序生成代码。查看文档kitex/getting-started

2.2.1 定义IDL

• 使用IDL定义服务与接口
• 如果我们要进行RPC,就需要知道对方的接口是什么，需要传什么参数，同时也需要知道返回值是什么样的。这时候，就需要通过IDL来约定双方的协议，就像在写代码的时候需要调用某个函数，我们需要知道函数签名一样。
• Thrift: thrift.apache.org/docs/idl
• Proto3 :developers.google.com/protocol-bu…

2.2.2 Kitex生成代码

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

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

2.2.3 Kitex 基本使用

服务默认监听8888端口

2.2.4 Kitex Client 发起请求

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

2.2.5 Kitex 服务注册与发现

2.2.6 Kitex生态：Kitex的XDS扩展适用于多套测试环境的情况。

2.3 Hertz

2.3.1 Hertz 基本使用

• Hertz支持多种Hook
• Hertz分为两个上下文（元信息 与 请求处理）

2.3.2 Hertz路由

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

2.3.3 Hertz参数绑定

• Hertz提供了Bind、Validate、BindAndValidate函数用于进行参数绑定和校验
• 把Http的请求转到结构体中（通过结构体的tag来确定）

2.3.4 Hertz中间件

• Hertz的中间件主要分为客户端中间件与服务端中间件，如下示个服务端中间件。
• 如何终止中间件调用链的执行
  • c.Abort
  • c.AbortWithMsg
  • c.AbortWlthStats
• 注册在全局中间件和路由组中间件是有区别的。如果访问路由404（404请求），全局中间件和路由组中间件的区别可以思考一下。

2.3.5 Hertz Client

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

2.3.6 Hertz代码生成工具

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

2.3.7 Hertz性能

• 默认使用Netpoll（性能较高，但不支持TRS），可切换。
• Json编解码默认使用Sonic（性能较高）
• 使用sync.Pool复用对象，协议层数据解析优化。目前也支持H2和H3。

3. 实战案例介绍

项目：kitex-examples/easy_note

• Kitex Client 关键代码讲解

func initNoteRpc() {
        // 初始化Etcd的Resolver对象
	r, err := etcd.NewEtcdResolver([]string{constants.EtcdAddress})
	if err != nil {
		panic(err)
	}
        
	c, err := noteservice.NewClient(
                // 定义服务名
		constants.NoteServiceName,
                // 注入中间件
		client.WithMiddleware(middleware.CommonMiddleware),
                // 比Middleware提前，在获取Instance之间做的
		client.WithInstanceMW(middleware.ClientMiddleware),
		client.WithMuxConnection(1),                       // mux 设置io多路复用Mutex
		client.WithRPCTimeout(3*time.Second),              // rpc timeout
		client.WithConnectTimeout(50*time.Millisecond),    // conn timeout 链接超时
		client.WithFailureRetry(retry.NewFailurePolicy()), // retry
		client.WithSuite(trace.NewDefaultClientSuite()),   // tracer
		client.WithResolver(r),                            // resolver
	)
	if err != nil {
		panic(err)
	}
	noteClient = c
}

// CreateNote create note info
func CreateNote(ctx context.Context, req *notedemo.CreateNoteRequest) error {
	resp, err := noteClient.CreateNote(ctx, req)
        // 网络超时等错误
	if err != nil {
		return err
	}
        // 判断是不是业务错误， 0 是成功
	if resp.BaseResp.StatusCode != 0 {
                // 最近也有一些其他的错误传递方式
		return errno.NewErrNo(resp.BaseResp.StatusCode, resp.BaseResp.StatusMessage)
	}
	return nil
}

4. 课程总结

• 了解 Gorm/Kitex（RPC框架）/Hertz（对外提供api服务，做数据聚合）是什么：并不是所有服务都要写成大单体服务。随着微服务普及，可以将一些基础服务抽象出来，使得其他api可以复用。
• 熟悉Gorm/Kitex/Hertz的基础用法
• 通过实战案例分析将三个框架的使用串联了起来