三件套介绍

01.Gorm

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

02.Kitex

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

03.Hertz

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

三件套的使用

Gorm

Gorm 的基本使用

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

Gorm 支持的数据库

Gorm 创建数据

如何使用 Upsert

使用  clause.OnConflict  处理数据冲突

如何使用默认值

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

Gorm 查询数据

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

Gorm 更新数据

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

Gorm 删除数据

物理删除

软删除

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

Gorm 事务

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

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

Gorm Hook

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

Gorm 性能提高

  • 对于写操作（创建、更新、删除），为了确保数据的完整性，Gorm  会将它们封装在事务内运行。但这会降低性能，你可以使用  SkipDefaultTransaction  关闭默认事务
  • 使用  PrepareStmt  缓存预编译语句可以提高后续调用的速度，本机测试提高大约**35%**左右

Gorm 生态

Gorm  拥有非常丰富的扩展生态，以下列举一部分常用扩展
Gorm 代码生成工具 https://github.com/go-gorm/gen
Gorm 分片库方案 https://github.com/go-gorm/sharding
Gorm 手动索引 https://github.com/go-gorm/hints
Gorm 乐观锁 https://github.com/go-gorm/optimisticlock
Gorm 读写分离 https://github.com/go-gorm/dbresolver
Gorm Open Telemetry 扩展 https://github.com/go-gorm/opentelemetry

Kitex

安装 Kitex 代码生成工具

  • Kitex  目前对  Windows  的支持不完善，如果本地开发环境是  Windows  建议使用虚拟机或  WSL2
  • 安装代码生成工具
    • go install github.com/cloudwego/kitex/tool/cmd/kitex@latest
    • go install github.com/cloudwego/thriftgo@latest

定义 IDL

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

Kitex 生成代码

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

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

Kitex 基本使用

服务默认监听  8888  端口

Kitex Client 发起请求

创建 Client

发起请求

kitex 服务注册与发现

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

Kitex 生态

Kitex 拥有非常丰富的扩展生态，以下列举一部分常用扩展
XDS 扩展 https://github.com/kitex-contrib/xds
opentelemetry 扩展 https://github.com/kitex-contrib/obs-opentelemetry
ETCD 服务注册与发现扩展 https://github.com/kitex-contrib/registry-etcd
Nacos 服务注册与发现扩展 https://github.com/kitex-contrib/registry-nacos
Zookeeper 服务注册与发现扩展 https://github.com/kitex-contrib/registry-zookeeper
polaris 扩展 https://github.com/kitex-contrib/polaris
丰富的示例代码与业务 Demo https://github.com/cloudwego/kitex-examples/

Hertz

Hertz 基本使用

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

Hertz 路由

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

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

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

Hertz 参数绑定

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

Hertz 中间件

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

  • 如何终止中间件调用链的执行
    • c.Abort
    • c.AbortWithMsg
    • c.AbortWithStats

Hertz Client

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

Hertz 代码生成工具

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

目录结构

生成文件

Hertz 性能

  • 网络库  Netpoll
  • Json  编解码  Sonic
  • 使用  sync.Pool  复用对象协议层数据解析优化

Hertz 生态

Hertz  拥有非常丰富的扩展生态，以下列举一部分常用扩展
HTTP2 扩展 https://github.com/hertz-contrib/http2
opentelemetry 扩展 https://github.com/hertz-contrib/obs-opentelemetry
国际化扩展 https://github.com/hertz-contrib/i18n
反向代理扩展 https://github.com/hertz-contrib/reverseproxy
JWT 鉴权扩展 https://github.com/hertz-contrib/jwt
Websocket 扩展 https://github.com/hertz-contrib/websocket
丰富的示例代码与业务 Demo https://github.com/cloudwego/hertz-examples/

实战案例

笔记服务项目地址

项目介绍

笔记项目是一个使用  Hertz、Kitex、Gorm  搭建出来的具备一定业务逻辑的后端  API  项目
服务名称 服务介绍 传输协议 主要技术栈
demoapi API 服务 HTTP Gorm/Kitex/Hertz
demouser 用户数据管理 Protobuf Gorm/Kitex
demonote 笔记数据管理 Thrift Gorm/Kitex

项目功能介绍

项目调用关系

IDL 介绍

项目技术栈介绍

Hertz 关键代码

Kitex Client 关键代码

Kitex Server 关键代码

Gorm 关键代码

许可协议

本文采用 署名-非商业性使用-相同方式共享 4.0 国际 许可协议，转载请注明出处。

分享文章