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

九牧
115 阅读5分钟

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

1. 三件套简介

1.1 Gorm

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

1.2 Kitex

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

1.3 Hertz

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

2. 三件套的使用

2.1 Gorm 的基本使用

参考gorm.cn/zh_CN/docs/…

2.1.1 模型定义
type User struct {
    ID           uint
    Name         string
    Email        *string
    Age          uint8
    Birthday     *time.Time
    MemberNumber sql.NullString
    ActivedAt    sql.NullTime
    CreatedAt    time.Time
    UpdatedAt    time.Time
}
2.1.2 约定

Gorm 的默认约定：

  • Gorm使用名为ID的字段作为主键
  • 使用结构体的蛇形负数作为表名
  • 字段名的蛇形作为列名
  • 使用CreatedAt、 UpdatedAt字段作为创建、更新时间
2.1.3 gorm.Model

GORM 定义一个 gorm.Model 结构体，其包括字段 ID、CreatedAt、UpdatedAt、DeletedAt

// gorm.Model 的定义
type Model struct {
  ID        uint           `gorm:"primaryKey"`
  CreatedAt time.Time
  UpdatedAt time.Time
  DeletedAt gorm.DeletedAt `gorm:"index"`
}
2.1.4 连接数据库

GORM 官方支持的数据库类型有： MySQL, PostgreSQL, SQlite, SQL Server，我们这里就举例mysql，其他都差不多

import (
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

func main() {
    // 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
    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{})
}
2.1.5 创建

创建记录

user := User{Name: "giegie", Age: 18, Birthday: time.Now()}

result := db.Create(&user) // 通过数据的指针来创建

user.ID             // 返回插入数据的主键
result.Error        // 返回 error
result.RowsAffected // 返回插入记录的条数

插入数据库

// 相当于下面的SQL语句
// INSERT INTO `users` (`name`,`age`,`created_at`) VALUES ("giegie", 18, "你自己的当前时间")
db.Select("Name", "Age", "CreatedAt").Create(&user)
2.1.6 查询

查询单体数据

First的使用踩坑：使用First时，需要注意查询不到数据会返回ErrRecordNotFound，使用Find查询多条数据，查询不到数据不会返回错误。

// 获取第一条记录（主键升序）
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)
2.1.7 更新
  • 如果使用结构体来更新字段，只会更新其中的非零字段
  • 如果本身为零值，需要使用map来构建查询
  • 在获取表名后，可以使用Select()函数来指定字段更新

保存所有字段

db.First(&user)

user.Name = "giegie2"
user.Age = 100
// 保存 user 中的所有字段到数据库中
db.Save(&user)

更新单个列

// 条件更新
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;
2.1.8 删除

物理删除

Delete()需要传入待删除的结构体，用于确定修改的表，第二个参数用于确定删除的条件

image-20230206003830445

软删除

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

image-20230206004005659

2.1.9 事务

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

image-20230206004157330

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

image-20230206004227994

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

image-20230206004325800

2.1.11 性能提高

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

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

image-20230206004504698

2.2 Kitex 的基本使用

2.2.1 安装

参考www.cloudwego.iolzh/docs/kitex/…

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

// 安装代码生成工具
go install github.com/cloudwego/kitex/tool/cmd/kitex@latest
go install github.com/cloudwego/thriftgo@latest

检验是否安装成功

image-20230206125543876

2.2.2 定义IDL

使用IDL定义服务与接口

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

image-20230206125813155

其实如果熟悉Java或者其他编程语言，看这个应该还算眼熟，稍微熟悉一下还是很容易掌握的

2.2.3 自动生成代码

使用 kitex -module example -service example echo.thrift 命令根据echo.thrift文件中的内容生成相关代码

image-20230206130033612

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

2.3 Hertz 的基本使用

参考www.cloudwego.iolzh/docs/hertzl…

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

image-20230206130402576

2.3.1 路由

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

image-20230206130505114

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

image-20230206130531124

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

image-20230206130557975

2.3.2 参数绑定

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

image-20230206130646182

2.3.3 中间件

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

image-20230206130736828

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

  • c.Abort
  • c.AbortWithMsg
  • c.AbortWIthStats
2.3.4 Client

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

image-20230206130830267

2.3.5 代码生成工具

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

image-20230206130928665

目录结构和生成文件

image-20230206131038424 image-20230206131057899

暂时就是这些，如有问题，欢迎指正！

avatar
文章
阅读
粉丝