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

112 阅读4分钟

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

三件套介绍

Gorm是一个已经迭代十多年的功能强大的ORM框架,在字节内部广泛使用并且拥有很丰富的开源扩展。

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

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

三件套的基本使用

Gorm的基础使用

下述代码为Gorm的使用框架:

type Product struct {
  gorm.Model
  Code  string
  Price uint
}

func main() {
  db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})//连接数据库
  if err != nil {
    panic("failed to connect database")
  }

  // Migrate the schema
  db.AutoMigrate(&Product{})

  // Create
  db.Create(&Product{Code: "D42", Price: 100})      //创建数据

  // Read
  var product Product				//查询数据
  db.First(&product, 1) // find product with integer primary key
  db.First(&product, "code = ?", "D42") // find product with code D42

  // Update - update product's price to 200
  db.Model(&product).Update("Price", 200)
  // Update - update multiple fields			//更新数据
  db.Model(&product).Updates(Product{Price: 200, Code: "F42"}) // non-zero fields
  db.Model(&product).Updates(map[string]interface{}{"Price": 200, "Code": "F42"})
                                           //删除数据
  // Delete - delete product
  db.Delete(&product, 1)
}`

Gorm的约定:

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

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

字段名的蛇形作为列名

使用CreateAt、UpdateAt字段作为创建、更新时间

Gorm支持的数据库:

Mysql、SQLServer、PostgreSQL、SQLite

GORM通过驱动来连接数据库,如果需要连接其他数据库需要复用或者自行开发驱动。

如何使用Upsert:

使用clause.OnConflict处理数据冲突

如何使用默认值:

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

First查询不到会返回error

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

GORM只会查询非零值字段,如果字段值为0,false或者其他零值,则该字段不会被用于构建查询条件,需要使用Map来构建查询条件

在使用Struct更新时,只会更新非零值,如果需要更新零值则需要使用map或者select

Gorm提供了DeletedAt来实现软删。

Gorm事务

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

GORM提供了Transaction方法用于自动提交事务,避免用户漏写Commit和Rollback

db.Transaction(func(tx *gorm.DB) error {
  // do some database operations in the transaction (use 'tx' from this point, not 'db')
  if err := tx.Create(&Animal{Name: "Giraffe"}).Error; err != nil {
    // return any error will rollback
    return err
  }

  if err := tx.Create(&Animal{Name: "Lion"}).Error; err != nil {
    return err
  }

  // return nil will commit the whole transaction
  return nil
})

GORM Hook

GORM提供了CURD的Hook能力

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

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

Gorm 性能提高

对于写操作,为保证数据完整性,GORM会将其封装在事务内运行,但是这种操作会降低性能,可以使用skipDefaultTransaction关闭默认事务。

kitex

定义IDL

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

Kitex生成代码

build.sh:为构建脚本

Kitex_gen:为IDL内容相关的生成代码,主要是基础的Server/Client代码 main.go为程序入口

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

Kitex服务注册与发现

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

Hertz基本使用

Hertz是字节内部的一个HTTP框架

Hertz路由

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

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

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

Hertz中间件主要分为客户端中间件与服务端中间件。

Hertz Client

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

Hertz 代码生成工具

Hertz提供了代码生成工具Hz通过定义IDL即可生成对应的基础服务代码

HertZ性能好的原因:

使用了网络库Netpoll,在小包场景下优于标准库

采用JSON编解码Sonic

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

总结

在本节课中我主要学习了Go框架三件套,其中包括Gorm、Kitex、HertZ。Gorm是一个ORM框架,Kitex是一个GolangRPC框架,HertZ是字节内部的HTTP框架。熟练使用Go框架三件套可以使系统开发更加简便快捷。