Go框架三件套详解(Web、RPC、ORM)| 青训营笔记

314 阅读4分钟

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

一、三件套介绍

1. Gorm(类似于 mybatis)

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

2. Kitex

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

3. Hertz

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

二、三件套的使用

1. Gorm 的基本使用

👨‍🏫 官方文档

image.png

👨‍🏫 蛇形负数:this_is_snake_name

(1)支持的数据库

🐷 参考地址

🐷 MySQL、SQLServer、PostgreSQL、SQLLite

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

🐷 DSN:data source name

image.png

(2)创建数据

🐷 参考地址

image.png

(3)查询数据

🐷 参考地址

image.png

👨‍🏫 First 使用踩坑

😴 使用First时,需要注意查询不到数据会返回 ErrRecordNotFound.
😴 使用Find查询多条数据,查询不到数据不会返回错误

👨‍🏫 使用结构体作为查询条件

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

(4)更新数据

🐷参考地址

image.png

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

(5)删除数据

🐷 参考地址

image.png

image.png

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

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

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

(6)事务

🐷 参考地址

🐷 Begin 、 Commit 、 Rollback 方法

image.png

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

image.png

(7)Hook

🐷 参考地址

image.png

🐷 GORM 在 提供了 CURD 的 Hook 能力

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

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

(8)性能提高

🐷参考地址

image.png

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

🐷 使用 PrepareStmt 缓存预编译语句可以提高后续调用的速度

(9)生态

👨‍🏫 常用扩展

官方文档

image.png

2. Kitex

(1)安装Kitex代码生成工具

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

🐷 安装代码生成工具

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

🐷 Quick Start

(2)定义IDL (interface description language)

🐷 使用 IDL 定义服务与接口

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

🐷 Thrift: thrift.apache.org/docs/idl

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

(3)生成代码

🐷 命令: kitex -module example -service example echo.thrift

🐷 build.sh:构建脚本

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

🐷 main.go 程序入口

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

(4)基本使用

🐷 服务默认监听 8888 端口

image.png

(5)Client 发起请求

🐷 创建 Client

image.png

🐷 发起请求

image.png

(6)服务注册与发现

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

🐷 参考地址

image.png

image.png

(7) 生态

🐷 常用扩展

🐷 参考地址

image.png

3. Hertz

(1)基本使用

🐷 Quick Start

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

(2)路由

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

🐷 参考地址

image.png

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

image.png

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

image.png

(3)参数绑定

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

🐷 参考地址

(4)中间件

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

🐷 参考地址

image.png image.png

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

😴 c.Abort
😴 c.AbortWithMsg
😴 c.AbortWithStats

(5)client

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

🐷 参考地址 image.png

(6)Hertz 代码生成工具

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

🐷 参考地址

image.png

image.png

(7)性能

image.png

(8)生态

🐷 扩展地址

image.png

三、实战项目

1. 功能简介

image.png

2. 项目调用关系

image.png

3. 参考地址

🐷 优化版: github.com/cloudwego/b…

🐷 普通版: github.com/cloudwego/k…