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

84 阅读5分钟

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

课程介绍

这节课主要学习Go框架的三件套(Web/PRC/ORM),介绍Gorm、Kitex和Hertz三件套的基本用法和常见API的讲解,并通过实战案例进行演示。

三件套具体使用-

Gorm

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

连接数据库

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

import (   
    "gorm.io/driver/mysql"   
    "gorm.io/gorm"
)  
func main() {      
dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"   
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{}) 
}

创建

user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}  
result := db.Create(&user) // 通过数据的指针来创建 
user.ID             // 返回插入数据的主键 
result.Error        // 返回 error 
result.RowsAffected // 返回插入记录的条数

查询

GORM 提供了 FirstTakeLast 方法,以便从数据库中检索单个对象。当查询数据库时它添加了 LIMIT 1 条件,且没有找到记录时,它会返回 ErrRecordNotFound 错误

// 获取第一条记录(主键升序) 
db.First(&user) 
// SELECT * FROM users ORDER BY id LIMIT 1;  

// 获取一条记录,没有指定排序字段 
db.Take(&user) 
// SELECT * FROM users LIMIT 1;  

// 获取最后一条记录(主键降序) 
db.Last(&user) 
// SELECT * FROM users ORDER BY id DESC LIMIT 1;  

result := db.First(&user) 
result.RowsAffected // 返回找到的记录数 
result.Error        // returns error  

// 检查 ErrRecordNotFound 错误 
errors.Is(result.Error, gorm.ErrRecordNotFound)

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

更新

当使用 Update 更新单个列时,你需要指定条件,否则会返回 ErrMissingWhereClause 错误。当使用了 Model 方法,且该对象主键有值,该值会被用于构建条件

// 条件更新  
db.Model(&User{}).Where("active = ?", true).Update("name", "hello")  
// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE active=true;  
  
// User 的 ID 是 `111`  
db.Model(&user).Update("name", "hello")  
// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111;  
  
// 根据条件和 model 的值进行更新  
db.Model(&user).Where("active = ?", true).Update("name", "hello")  
// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111 AND active=true;

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

删除

物理删除:

db.Delete(&User{}, 10)
// DELETE FROM users WHERE id = 10;

db.Delete(&User{}, "10")
// DELETE FROM users WHERE id = 10;

db.Delete(&users, []int{1,2,3})
// DELETE FROM users WHERE id IN (1,2,3);

软删除: 如果您的模型包含了一个 gorm.deletedat 字段(gorm.Model 已经包含了该字段),它将自动获得软删除的能力!

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

事务

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

HOOK

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

Kitex

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

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

定义IDL:使用IDL定义服务与接口

Kitex生成代码

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

Kitex 基本使用

服务默认监听8888端口

Kitex Client 发起请求

  • 创建Client
  • 发起请求

Kitex 服务注册与发现

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

Hertz

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

基本使用

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

Hertz路由

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

参数绑定

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

中间件

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

性能分析

Hertz性能主要为自研网络库Netpoll以及Json编解码Sonic,使用sync.Poll复用对象协议层数据解析优化

具体性能分析见cloudwego/hertz-benchmark: Tracking performance changes for Hertz (github.com)

实战案例

项目介绍

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

image.png

项目模块部分:

  • demoapi:主要完成用户登录注册,笔记的创建、更新、删除和查询
  • demouser:用户的创建、查询和校验
  • demonote:笔记的创建、更新、删除和查询

调用关系

通过对demoapi的调用来对demouser、demonote和ETCD进行操作,完成服务的注册和发现 image.png

具体代码实现参考kitex-examples/bizdemo/easy_note at main · cloudwego/kitex-examples (github.com)

参考资料

‌‍⁢⁣‌Go 框架三件套详解

gorm.cn/zh_CN/docs

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

github.com/cloudwego/h…

总结

  • 对Gorm、Kitex和Hertz三大框架有了基本的认识,熟悉了其基础用法
  • 具体详细的用法要学会参考官方文档
  • 通过一个笔记实战案例分析将三个框架的使用串联了起来
  • 在后续的大作业的开发中也可以参考