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

乌云暮年
170 阅读6分钟

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

前言

这是我将参加青训营期间的收获进行整理和总结，同时便于日后复习和查阅。如果能给各位小伙伴提供些帮助，也是我的荣幸，希望大家可以多多赐教，一起学习和交流。

本篇文章内容：

  • 三件套（Web/RPC/ORM）介绍
  • 学习 Hertz/Kitex/Gorm 的基本用法
  • 实战案例练习

一、三件套（Web/RPC/ORM）介绍

01.Gorm

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

02.Kitex

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

03.Hertz

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

二、三件套的使用

01.Gorm的基本使用

GORM 支持的数据库

GROM 目前支持 MySQL、SQLServer、PostgreSQL、SQLite。

  • 以连接 SQLServer 数据库为例
import {
    "gorm.io/driver/sqlserver"
    "gorm.io/gorm"
}
//// github.com/denisenkom/go-mssqldb
dsn := "sqlserver://gorm:LoremIpsum86@localhost:9930?database=gorm"
db, err := gorm.Open(sqlserver.Open(dsn), &gorm.Config{})

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

GORM 创建数据

  • 如何使用 Upsert

使用 clause.OnConflict 处理数据冲突

// 以不处理冲突为例，创建一条数据
p := &Product{Code: "D42", ID: 1}
db.Clauses(clause.OnConflict{DoNothing: true}).Create(&p)
  • 如何使用默认值

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

type User struct {
    ID    int64
    Name  string  `gorm:"default:galeone"`
    Age   int64   `gorm:"default:18"`
}

GROM 查询数据

First 的使用踩坑

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

使用结构体作为查询条件

  • 当使用结构作为条件查询时，GORM 只会查询非零值字段。这意味着如果您的字段值为 0、”、false 或其他 零值，该字段不会被用于构建查询条件，使用 Map 来构建查询条件。

GORM 更新数据

//条件更新单个列
// UPDATE users SET nome='hello，updoted_at='2013-11-17 21:34:10 WHERE oge>18;
db.Model(&User{ID: 111}).Where( "age > ?", 18).Update("name", "hello")
​
// 更新多个列
// 根据"struct"更新属性，只会更新非零值的字段
// UPDATE users SET name='hello'，age=18,updated at = '2013-11-17 21:34:16' WHERE id = 111
db.Model(&User{ID: 111}).Updates(User{Name:"hello"，Age: 18})
​
//根据 'mop' 更新属性
// UPDATE USors SET name='hello'，aqe=18, gctived=false, updated-at='2013-11-17 21:34:10' WHERE id=111;
db,Model(&User{ID: 111}).Updates(map[string]interface{}{"name": "hello", "age": 18, "actived": false})
​
// 更新选定字段
// UPDATE users SET nome="hello' WHERE id=111;
db.Model(&User{ID:111}).Select("name").Uodates(map[string]interface{}("name": "hello", "age": 18, "actived": false})
​
// SQL 表达式更新
// UPDATE "products" SET "price" = pice * 2 + 100,"updatedat" = '2013-11-17 21:34:10' WHERE "d"=3;
db.Model(&User{ID: 111}).Update("age",gorm,Expr("aqe * ? + ?", 2, 100))

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

GORM 删除数据

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

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

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

GORM 事务

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

db, err := gorm.Open(mysql.Open("数据库路径")
    &gorm.Config{})
if err != nil {
    panic( v:"failed to connect database")
}
if err = db.Transaction(func(tx *gorm.DB) error {
    if err = tx.Create(&User(Name: "name"}).Error; err != nil {
        return err
    }
    if err = tx.Create(&User(Name:"name1"}).Error; err != nil {
        tx.Rollback()
        return err
    }
    return nil
}); err != nil {
    return
}

GROM Hook

GORM 在提供了 CURD 的 Hook 能力。

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

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

type User struct {
    ID      int64
    Name    stringgorm:"default:galeone"    
    Age     gorm:"default:18"int64
}
type Email struct {
    ID      int64
    Name    string
    Email   string
}
func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
    if u.Age < 0{
        return errors.New( text: "can't save invalid data")
    }
    return
func (u *User) AfterCreate(tx *gorm.DB) (err error) {
    return tx.Create(&Email{ID: U.ID，Email: u.Name + "@***,com"}).Error   
}

GORM 性能提高

db, err := gorm.0pen(mysgl.Open("数据库路径"),
    &gorm.Config{
        SkipDefaultTransaction: true, // 关闭默认事务
        PrepareStmt:            true},// 缓存预编译语句
if err != nil {
    panic("failed to connect database")
}

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

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

GORM 生态

GORM 拥有非常丰富的扩展生态。 GROM生态.png

02.Kitex 的基本使用

安装 Kitex 代码生成工具

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

安装代码生成工具

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

输入 kitex -version 查看是否安装成功。

定义 IDL


namespace go api
​
struct Request {
    1: string message
}
​
struct Response {
    1: string message
}
​
service Echo {
    Response echo(1: Request req)
}

Kitex 生成代码

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

Kitex.png

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

Kitex 发起请求

创建 Client

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.PrintIn(resp)

Kitex 生态

Kitex 拥有非常丰富的扩展生态。 Kitex生态.png

Hertz 基本使用

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

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(server.WithHostPorts("127.0.0.1:8080"))
    h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
        ctx.JSON(consts.Status0K, utils.H{"ping":"pong"})
    })
    hSpin()
}

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

Hertz 路由

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

//参数路由
// This handler will match: "/hertz/version"，but will not match : "/hertz/" or "/hertz
h.GET("/hertz/:version", func(ctx context.Context, c *app.RequestContext) {
    version := c.Param("version")
    c.String(consts.StatusOK, "Hello %s", version)
})
​
//通配路由
// However，thisone will match "/hertz/v1/” and"/hertz/v2/send"
h.GET("/hertz/:version/*action", func(ctx context.Context, c *app.RequestContext) {
    version := c.Param("version")
    action := c.Param("action")
    message := version + " is " + action
    c.String(consts.Status0K, message)
})

Hertz 参数绑定

Hertz 提供了 Bing、Validate、BindAndValidate 函数绑定和效验

Hertz 中间件

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

func MyMiddleware() app.HandlerFunc {
    return func(ctx context.Context, c *app.RequestContext) {
        // pre-handle
        fmt.Printin("pre-handle")
        c.Next(ctx) // call the next middleware(handler)
        // post-handle
        fmt.PrintIn("post-handle")
    }
}
​
func main() {
    h := server.Default(server.WithHostPorts("127...1:8080"))
    h.Use(MyMiddleware())
    h.GET("/middleware", func(ctx context.Context, c *app.RequestContext) {
        c.String(consts.StatusOK, "Hello hertz!")
    })
    h.Spin()
}

Hertz Client

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

c，err := client.NewClient()
if err != nil {
    return
}
// send.http get request
status, body, _ := c.Get(context.Background(), nil, "http://www,example.com")
fmt.Printf("status=%v body=%v\n", status, string(body))
​
// send http post request
var postArgs protocol.Args
postArgs.Set("arg", "a") // Set post args
status, body, _ = c.Post(context,Background(),nil, "http://www,example,com", &postArgs)
fmt.Printf("status=%v body=%v\n", status, string(body))

Hertz 代码生成工具

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

namespace go hello.example
​
struct helloReq {
    1: string Name (api.query="name")
}
​
struct helloResp {
    1: string RespBody;
}
​
service helloService {
    helloResp helloMethod(1: helloReq request) (api.get="/hello");
}

Hertz 生态

Kitex 拥有非常丰富的扩展生态。

Hertx.png

三、实战案列介绍

项目介绍

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

服务名称服务介绍传输协议主要技术栈
demoapiAPI服务HTTPGorm/Kitex/Hertz
demouser用户数据管理ProtobufGorm/Kitex
demonote笔记数据管理ThriftGorm/Kitex

项目地址：github.com/cloudwego/k…

项目功能

项目模块

  • 用户登录

    • 用户注册
    • 用户创建笔记
    • 用户更新笔记
    • 用户删除笔记
    • 用户查询笔记

  • demouser

    • 创建用户
    • 查询用户
    • 效验用户

  • demonote

    • 创建笔记
    • 更新笔记
    • 删除笔记
    • 查询笔记

项目技术栈介绍

技术框架

  • 语言

    • GO

  • 底层存储

    • MySQL

  • 服务注册

    • Etcd

  • RPC 框架

    • Kitex

      • registry-etcd
      • tracer-opentracing

    • Kitex扩展

  • ORM 框架

    • GORM

    • GORM扩展

      • gorm-mysql
      • gorm-opentracing

  • HTTP 框架

    • Hertz

    • Hertz扩展

      • Hertz-Jwt

  • 链路追踪

    • Jeager
    • opentracing

引用

  • 字节录播课 - Go 框架三件套详解（Web/RPC/ORM）

希望学到知识的小伙伴可以给我点个赞~😶‍🌫️😶‍🌫️😶‍🌫️

avatar
文章
阅读
粉丝