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

180 阅读4分钟

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

1 课程介绍

课程目标:1.将前面几节课所学到的知识应用到项目中。2.掌握Hertz/Kitex/Gorm的基本用法。3.通过学习实战案例,可以使用Hertz/Kitex/Gorm完成日常后端开发任务。

1.1 Gorm

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

1.2 Kitex

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

1.3 Hertz

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

2 三件套的使用

2.1.1 Gorm的基本使用

Gorm的约定(默认):Gorm使用名为ID的字段作为主键,使用结构体的蛇形负数作为表名,字段名的蛇形作为列名

image.png

2.1.2 GORM支持的数据库

GORM目前支持MySQL、SQLServer、PostgreSQL、SQLite

image.png

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

2.1.3 GORM创建数据

image.png

如何使用Upset:使用clause.OnConflict处理数据冲突

image.png

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

image.png

2.1.4 GORM查询数据

First的使用踩坑:使用First时,需要注意查询不到数据会返回ErrRecordNoFound;使用Find查询多条数据,查询不到数据不会返回错误。

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

2.1.5 GORM更新数据

image.png

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

2.1.6 删除数据

物理删除

image.png

软删除

image.png

GORM提供了gorm.DeletedAt用于帮助用户实现软删,使用Unsooped可以查询到被软删的数据。

2.1.7 GORM事务

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

image.png

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

image.png

2.1.8 GORM Hook

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

image.png

2.1.9 GORM生态

GORM拥有非常丰富的扩展生态,以下列举一部分常用扩展。

image.png

关于更多的GORM用法可以查看Gorm的文档(gorm.cn)。

2.2.1 安装Kitex代码生成工具

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

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

go install github.com/cloudwego/thriftgo@latest

image.png

2.2.2 定义IDL

image.png

使用IDL定义服务与接口。

2.2.3 Kitex生成代码

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

image.png

build.sh:构建脚本

2.2.4 Kitex基本使用

服务默认监听8888端口

image.png

2.2.5 Kitex Client发起请求

创建Client:

image.png

发起请求:

image.png

2.2.6 Kitex服务注册与发现

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

image.png

image.png

2.2.7 Kitex生态

Kitex拥有非常丰富的扩展生态,以下列举一部分常用扩展。

image.png

2.3.1 Hertz基本使用

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

image.png

2.3.2 Hertz路由

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

image.png

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

image.png

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

image.png

2.3.3 Hertz参数绑定

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

image.png

2.3.4 Hertz中间件

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

image.png

2.3.5 Hertz Client

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

image.png

2.3.6 Hertz代码生成工具

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

image.png

生成文件

image.png

2.3.7 Hertz性能

优点:网络库Netpoli、Json编解码Sonic、使用sync Pool复用对象协议层数据解析优化。

2.3.8 Hertz生态

image.png

3 实战案例介绍

3.1 实战项目介绍

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

image.png

项目功能介绍:

image.png

项目调用关系:

image.png

项目技术栈介绍:

image.png

3.2 关键代码讲解

3.2.1 Hertz关键代码讲解

image.png

3.2.2 Kitex Client 关键代码讲解

image.png 3.2.3 Kitex Server关键代码讲解

image.png 3.2.4 Gorm关键代码讲解

image.png

4 课程总结

了解Gorm/Kitex/Hertz是什么。

熟悉Gorm/Kitex/Hertz的基础用法。

通过实战案例分析将三个框架的使用串联了起来。