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

方云123
100 阅读7分钟

前言

本文简单介绍了Go框架三件套(GORM、Kitex和Hertz)概念，带领大家进行简单了解，后续会补充实战情况。

0.基础概念讲解

  • DB：数据库，即Database，是将大量数据储存起来，通过计算机加工可进行高效访问地数据集合。
  • SQL：是一种数据库查询和程序设计语言，用于存取数据以及查询、更新和管理关系数据库系统。
  • DSN:数据源名称，即Data Source Name，指当我们的数据库建立好之后，系统需要知道数据的来源，所以就需要设定系统的 DSN（数据来源名称）。
  • ORM:对象关系映射，即Object-Relationl Mapping，是在关系型数据库和对象之间作一个映射。
  • GORM：是Golang语言中一款性能极好的ORM库，数据表对应结构体，数据行对应结构体实例，数据库字段对应结构体字段。
  • IDL:接口描述语言,即Interface description language，是跨平台开发的基础。
  • PRC：远程过程调用，即Remote Procedure Call。它是利用网络从远程计算机上请求服务，可以理解为把程序的一部分放在其他远程计算机上执行。
  • Kitex：字节内部的Golang微服务PRC框架,具有高性能、强可扩展性的特点。
  • HTTP：超文本传输协议，即Hyper Text Transfer Protocol，是互联网上应用最为广泛的—种网络协议。
  • Hertz：字节内部的HTTP框架，具有高易用性、高性能、高扩展性的特点。

1.GORM

1.GORM特性

  • 全功能 ORM
  • 关联 (Has One，Has Many，Belongs To，Many To Many，多态，单表继承)
  • Create，Save，Update，Delete，Find 中钩子方法
  • 支持 Preload、Joins 的预加载
  • 事务，嵌套事务，Save Point，Rollback To Saved Point
  • Context、预编译模式、DryRun 模式
  • 批量插入，FindInBatches，Find/Create with Map，使用 SQL 表达式、Context Valuer 进行 CRUD
  • SQL 构建器，Upsert，数据库锁，Optimizer/Index/Comment Hint，命名参数，子查询
  • 复合主键，索引，约束
  • Auto Migration
  • 自定义 Logger
  • 灵活的可扩展插件 API：Database Resolver（多数据库，读写分离）、Prometheus
  • 每个特性都经过了测试的重重考验
  • 开发者友好

2.GORM安装

go get -u gorm.io/gorm
go get -u gorm.io/driver/sqlite

3.GORM的使用

GORM基本使用

package main

import (
 "gorm.io/gorm"
 "gorm.io/driver/sqlite"
)
//定义gorm model
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")
 }

 // 迁移 schema
 db.AutoMigrate(&Product{})

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

 // Read 读写
 var product Product
 db.First(&product, 1) // 根据整型主键查找
 db.First(&product, "code = ?", "D42") // 查找 code 字段值为 D42 的记录

 // Update - 将 product 的 price 更新为 200
 db.Model(&product).Update("Price", 200)
 // Update - 更新多个字段
 db.Model(&product).Updates(Product{Price: 200, Code: "F42"}) // 仅更新非零值字段
 db.Model(&product).Updates(map[string]interface{}{"Price": 200, "Code": "F42"})

 // Delete - 删除 product
 db.Delete(&product, 1)
}
  • gorm.Model可以嵌入在已有的结构体中，还可以进行权限控制。
  • Gorm使用名为ID的字段作为主键,使用结构体的蛇形负数作为表名,字段名的蛇形作为列名。
  • 使用CreatedAt、 UpdatedAt字段作为创建、更新时间。

GORM支持的数据库

  • GORM 目前支持 MySQL, SQLServer, PostgreSQL, SQLite。
  • GORM 通过驱动来连接数据库,如果需要连接其它类型的数据库,可以复用/自行开发驱动。

GORM基本操作

  • 创建数据

  • 查询数据

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

  • 更新数据

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

  • 删除数据

    • 分为物理删除和软删除(grom.DeletedAt用于软删，Unscoped可查询被软删的数据)

  • 使用事务

    • Gorm 提供了 Begin、Commit、Rollback 方法用于使用事务 image.png
    • Gorm 提供了 Tansaction 方法用于自动提交事务，避免用户漏写 Commit、Rollbcak。

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

// 开始事务 
BeforeSave 
BeforeCreate 
// 关联前的 save 
// 插入记录至 db 
// 关联后的 save 
AfterCreate 
AfterSave 
// 提交或回滚事务

func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
  u.UUID = uuid.New()

  if! u.IsValid() {
    err = errors.New("can't save invalid data")
  }
  return
}

func (u *User) AfterCreate(tx *gorm.DB) (err error) {
  if u.ID == 1 {
    tx.Model(u).Update("role", "admin")
  }
  return
}
  • 性能提高
    • 可使用 SkipDefaultTransaction 关闭默认事务。
    • 使用 PrepareStmt 缓存预编译语句可以提高后续调用的速度。

GORM常用扩展

image.png

2.Kitex

1.安装

本地开发环境是Windows建议使用虚拟机orWSL2

安装代码生成工具：

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

定义IDL

namespace go api

struct Request {
    1: string message
}

struct Response {
    1: string message
}

service Echo {
    Response echo(1: Request req)
}
  • 如果我们要进行PRC，就需要知道对方的接口是什么，需要传什么参数，同时也需要知道返回值时什么样的，这个时候，就需要通过IDL来约定双方的协议，就像在写代码的时候需要调用某个函数，我们需要知道函数签名一样。

Kitex生成代码

kitex -module example -service example echo.thrift

文件目录如下：

image.png

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

2.使用

  • 服务默认监听8888端口
  • 创建Client
    • echo.NewClient 用于创建 client，其第一个参数为调用的 服务名，第二个参数为options，用于传入参数， 此处的 client.WithHostPorts 用于指定服务端的地址
import "example/kitex_gen/api/echo"
import "github.com/cloudwego/kitex/client"
...
c, err := echo.NewClient("example", client.WithHostPorts("0.0.0.0:8888"))
if err != nil {
  log.Fatal(err)
}
  • 发起请求
import "example/kitex_gen/api"
...
req := &api.Request{Message: "my request"}
resp, err := c.Echo(context.Background(), req, callopt.WithRPCTimeout(3*time.Second))
if err != nil {
  log.Fatal(err)
}
log.Println(resp)
  • 服务注册与发现
    • Kitex 的服务注册与发现已经对接了主流了服务注册与发现中心，如 ETCD，Nacos 等。
func main() {
   r, err := etcd.NewEtcdResolver([]string{"127.0.0.1:2379"})
   if err != nil {
   	log.Fatal(err)
   }
   client := hello.MustNewClient("Hello", client.WithResolver(r))
   for {
   	ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
   	resp, err := client.Echo(ctx, &api.Request{Message: "Hello"})
   	cancel()
   	if err != nil {
   		log.Fatal(err)
   	}
   	log.Println(resp)
   	time.Sleep(time.Second)
   }
}

3.常用拓展

image.png

3.Hertz

1.使用

基本使用

package main

import (
    "context"

    "github.com/cloudwego/hertz/pkg/app"
    "github.com/cloudwego/hertz/pkg/app/server"
    "github.com/cloudwego/hertz/pkg/common/utils"
    "github.com/cloudwego/hertz/pkg/protocol/consts"
)

func main() {
    h := server.Default()

    h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
            ctx.JSON(consts.StatusOK, utils.H{"message": "pong"})
    })

    h.Spin()
}
  • 使用 Hertz实现，服务监听8080端口并注册了一个GET方法的路由函数。

路由

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

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

func main(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))

	h.StaticFS("/", &app.FS{Root: "./", GenerateIndexPages: true})

	h.GET("/get", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "get")
	})
	h.POST("/post", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "post")
	})
	h.PUT("/put", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "put")
	})
	h.DELETE("/delete", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "delete")
	})
	h.PATCH("/patch", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "patch")
	})
	h.HEAD("/head", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "head")
	})
	h.OPTIONS("/options", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "options")
	})
	h.Any("/ping_any", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "any")
	})
	h.Handle("LOAD","/load", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "load")
	})
	h.Spin()
}
  • Hertz 提供了路由组的能力，用于支持路由分组的功能
package main

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

func main(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))
	v1 := h.Group("/v1")
	v1.GET("/get", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "get")
	})
	v1.POST("/post", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "post")
	})
	v2 := h.Group("/v2")
	v2.PUT("/put", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "put")
	})
	v2.DELETE("/delete", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "delete")
	})
	h.Spin()
}
  • Hertz 提供了参数路由和通配路由，路由的优先级为：静态路由 > 命名路由 > 通配路由

参数绑定和校验

  • Hertz 提供了 Bind、Validate、 BindAndValidate 函数用于进行参数绑定和校验。
func main() {
	r := server.New()

    r.GET("/hello", func(c context.Context, ctx *app.RequestContext) {
        // 参数绑定需要配合特定的go tag使用
		type Test struct {
            A string `query:"a" vd:"$!='Hertz'"`
        }

        // BindAndValidate
        var req Test
        err := ctx.BindAndValidate(&req)

        ...

	    // Bind
        req = Test{}
        err = ctx.Bind(&req)

        ...

        // Validate，需要使用 "vd" tag
        err = ctx.Validate(&req)

        ...
    })
...
}

中间件

  • 分为两大类：服务端中间件和客户端中间件，下面是一个服务端中间件的实现：
func MyMiddleware() app.HandlerFunc {
  return func(ctx context.Context, c *app.RequestContext) {
    // pre-handle
    // ...
    c.Next(ctx)
  }
}

Client

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

代码生成工具

  • Hertz提供了代码生成工具Hz，通过定义IDL文件即可生成对应的基础服务代码。
  • 安装hz：
go install github.com/cloudwego/hertz/cmd/hz@latest
  • 用thrift IDL创建新项目，下面是thrift IDL文件：
// idl/hello.thrift
namespace go hello.example

struct HelloReq {
    1: string Name (api.query="name"); // 添加 api 注解为方便进行参数绑定
}

struct HelloResp {
    1: string RespBody;
}


service HelloService {
    HelloResp HelloMethod(1: HelloReq request) (api.get="/hello");
}
  • 生成代码的目录结构如下：

image.png

2.常用扩展

image.png

4.项目实战

1.介绍

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

image.png

2.功能介绍

image.png

3.调用关系

image.png

4.技术框架

image.png

avatar
文章
阅读
粉丝