Gorm、Kitex、Hertz三大框架详解 | 青训营

256 阅读6分钟

Go框架三件套详解

三件套介绍

Gorm

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

Kitex

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

Hertz

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

三件套的使用

GORM

Gorm的基本使用

image.png

Gorm的约定(默认)

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

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

字段名的蛇形作为列名

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

说明文档地址:gorm.cn/zh_CN/docs/…

GORM支持的数据库

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

image.png

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

说明文档地址:gorm.cn/zh_CN/docs/…

什么是DSN:github.com/go-sql-driv…

GORM创建数据

image.png

如何使用Upsert?

使用clause.OnConflict处理数据冲突

image.png

如何使用默认值?

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

image.png

详细说明文档:gorm.cn/zh_CN/docs/…

GORM查询数据

image.png

First的使用踩坑

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

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

使用结构体作为查询条件

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

详细说明文档:gorm.cn/zh_CN/docs/…

GORM更新数据

image.png

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

详细说明文档:gorm.cn/zh_CN/docs/…

GORM删除数据

物理删除

image.png

软删除

image.png

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

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

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

详细说明文档:gorm.cn/zh_CN/docs/…

GORM事务

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

image.png

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

image.png

详细说明文档:gorm.cn/zh_CN/docs/…

GORM Hook

GORM在提供了CURD的Hook能力

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

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

image.png

详细说明文档:gorm.cn/zh_CN/docs/…

GORM性能提高

image.png

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

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

详细说明文档:gorm.cn/zh_CN/docs/…

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的文档(gorm.cn

Kitex

安装Kitex代码生成工具

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

安装代码生成工具

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

go install github.com/cloudwego/thriftgo@latest

查看kitex版本命令:kitex -version

详细说明文档:www.cloudwego.io/zh/docs/kit…

定义IDL

image.png

使用IDL定义服务与接口

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

Thrift:thrift.apache.org/docs/idl

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

详细说明文档:www.cloudwego.io/zh/docs/kit…

Kitex生成代码

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

image.png

build.sh:构建脚本,可以生成代码的可执行文件

kitex_gen:IDL内容相关的代码,主要是基础的Server/Client代码

main.go程序入口

handler.go用户在该文件里实现IDL service定义的方法

详细说明文档:www.cloudwego.io/zh/docs/kit…

Kitex基本使用

服务默认监听8888端口

image.png

详细说明文档:www.cloudwego.io/zh/docs/kit…

Kitex Client发起请求

创建Client

image.png

发起请求

image.png

详细说明文档:www.cloudwego.io/zh/docs/kit…

Kitex服务注册与发现

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

image.png

详细说明文档:www.cloudwego.io/zh/docs/kit…

image.png

详细说明文档:github.com/kitex-contr…

Kitex生态

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

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…

详细说明文档:www.cloudwego.io/zh/docs/kit…

Hertz

Hertz基本使用

image.png

使用Hertz实现,服务监听8080端口并注册了一个GET方法的路由函数

详细说明文档:www.cloudwego.io/zh/docs/her…

Hertz路由

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

image.png

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

image.png

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

image.png

详细说明文档:www.cloudwego.io/zh/docs/her…

Hertz参数绑定

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

image.png

详细说明文档:www.cloudwego.io/zh/docs/her…

Hertz中间件

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

image.png

如何终止中间件调用链的执行

c.Abort

c.AbortWithMsg

c.AbortWithStats

详细说明文档:www.cloudwego.io/zh/docs/her…

Hertz Client

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

image.png

详细说明文档:github.com/cloudwego/h…

Hertz代码生成工具

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

image.png

目录结构image.png

生成文件image.png

详细说明文档:www.cloudwego.io/zh/docs/her…

Hertz性能

网络库Netpoll

Json编解码Sonic

使用sync.Pool复用对象协议层数据解析优化

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…

详细说明文档:github.com/cloudwego/h…

实战案例介绍

项目介绍

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

服务名称服务介绍传输协议主要技术栈
demoapiAPI服务HTTPKitex/Hertz
demouser用户数据管理ProtobufGorm/Kitex
demonote笔记数据管理ThriftGorm/Kitex

详细说明文档:github.com/cloudwego/k…

项目功能介绍

image.png

项目调用关系

image.png

IDL介绍

image.png

项目技术栈介绍

image.png

Hertz关键代码讲解

image.png

详细代码:github.com/cloudwego/k…

Kitex Client关键代码讲解

image.png

详细代码:github.com/cloudwego/k…

Kitex Server关键代码讲解

image.png

详细代码:github.com/cloudwego/k…

Gorm关键代码讲解

image.png

详细代码:github.com/cloudwego/k…