go zero入门

一、goctl安装

goctl 是 go-zero 的内置脚手架，可以一键生成代码、文档、部署 k8s yaml、dockerfile 等。

# Go 1.16 及以后版本
go install github.com/zeromicro/go-zero/tools/goctl@latest

检查是否安装成功

$ goctl -v
goctl version 1.6.6 darwin/amd64

vscode安装插件goctl

二、简单的http服务请求

2.1 通过goctl生成api项目

下面利用goctl实现一个单体服务，通过订单id获取订单信息（id、名称、价格）
在order目录下

go mod init order
touch order.api

结构如下

    go-zero└── order├── go.mod└── order.api

order.api的代码

syntax = "v2"type (// 定义请求体OrderInfoReq {OrderId int64 'json:"order_id"' // 订单ID  }// 定义响应体OrderInfoResp {OrderId int64 'json:"order_id"' // 订单IDGoodsName string 'json:"goods_name"' // 商品名称Price int64 'json:"price"' // 商品价格}
)// 定义 HTTP 服务
// 微服务名称为 order-api
service order-api {// 标记了订单信息查询接口的文档注释。@doc(summary: "获取订单信息")// 指定处理该请求的处理器为orderInfo。@handler orderInfo// 定义接口// 请求方法是post，路径是/order/info，参数是OrderInfoReq，返回值是OrderInfoResppost /oder/info (OrderInfoReq) returns (OrderInfoResp)
}

在当前目录下执行

$ goctl api go -api *.api -dir ./  --style=goZero    
Done.// 下载所需要的依赖
$ go mod tidy

该指令的作用是使用 goctl 工具生成 Go 语言的 API 代码项目

api go: 指定生成 Go 语言的 API 代码。
-api *.api: 指定输入的 API 描述文件，*.api 表示所有的 .api 文件，可以生成多个 API。
-dir ./: 指定输出目录为当前目录 (./)，生成的代码将会放置在当前目录中。
--style=goZero: 指定生成代码的风格为 goZero

当前目录生成的api项目结构如下

.
├── etc							// 配置文件
│   └── order-api.yaml
├── go.mod
├── internal
│   ├── config					// 配置对应的数据结构
│   │   └── config.go
│   ├── handler					// http部分的代码
│   │   ├── orderInfoHandler.go
│   │   └── routes.go
│   ├── logic					// 需要自己写的代码逻辑
│   │   └── orderInfoLogic.go
│   ├── svc						// 上下文相关依赖
│   │   └── serviceContext.go
│   └── types
│       └── types.go
├── order.api
└── order.go					// 启动代码

2.2 实现业务逻辑

根据路由追踪到OrderInfo方法，实现业务逻辑
在这里插入图片描述

func (l *OrderInfoLogic) OrderInfo(req *types.OrderInfoReq) (resp *types.OrderInfoResp, err error) {// todo: add your logic here and delete this lineresp  = &types.OrderInfoResp{OrderId: req.OrderId,GoodsName: "车",Price: 100000,}return resp, nil
}

2.3 执行

// 启动服务
$ go run order.go -f etc/order-api.yaml

etc/order-api.yaml文件定义了启动的端口号和ip

$ curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/info -d '{"order_id":34}'{"order_id":34,"goods_name":"车","price":100000}%

三、集成Gorm

基于上面的基础，再增加一个功能：记录订单信息（id、名称、价格）到数据库

3.1 配置Gorm

在etc/order-api.yaml文件中配置参数DataSourceName

Name: order-api
Host: 0.0.0.0
Port: 8888
DataSourceName: root:zxm123578@(127.0.0.1:3306)/MING_DB?charset=utf8

在这里插入图片描述
在internal/config/config.go中添加DataSourceName

type Config struct {rest.RestConfDataSourceName string
}

3.2 启动Gorm支持

在internal目录下新建模型文件models\models.go

package modelsimport ("gorm.io/gorm"
)type Order struct {gorm.ModelOrderId   int64   `gorm:"index:order_id"`GoodsName string  `gorm:"type:varchar(64)"`Price     float64 `gorm:"type:decimal(10,2);default:0"`
}

修改svc/servicecontext.go代码如下

package svcimport ("order/internal/config""order/internal/models""gorm.io/driver/mysql""gorm.io/gorm""gorm.io/gorm/schema"
)type ServiceContext struct {Config config.Config// DbEngin 数据库引擎DbEngin *gorm.DB
}func NewServiceContext(c config.Config) *ServiceContext {// 启动Gorm支持db, err := gorm.Open(mysql.Open(c.DataSourceName), &gorm.Config{NamingStrategy: schema.NamingStrategy{TablePrefix:   "o_", // 表名前缀SingularTable: true, // 使用单数表名},})if err != nil {panic(err)}//自动同步更新表结构db.AutoMigrate(&models.Order{})return &ServiceContext{Config:  c,DbEngin: db,}
}

3.3 实现业务逻辑

在logic/orderRecordLogic.go文件实现业务逻辑

func (l *OrderRecordLogic) OrderRecord(req *types.OrderRecordReq) (resp *types.OrderRecordResp, err error) {// todo: add your logic here and delete this lineorder := models.Order{GoodsName: req.GoodsName,Price:     float64(req.Price),OrderId:   req.OrderId,}result := l.svcCtx.DbEngin.Create(&order)return &types.OrderRecordResp{OrderId: order.OrderId,}, result.Error
}

3.4 执行

先启动mysql，再启动服务

// 启动服务
$ go run order.go -f etc/order-api.yaml

$ curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/record -d '{"order_id":34,"goods_name":"手机","price":5000}'{"order_id":34}%

四、通过api调用rpc服务

上面例子的商品名称是写死的，下面通过调用商品的rpc服务来获取商品信息。

安装protoc
安装etcd

4.1 通过goctl生成rpc服务

在go-zero下新建目录goods

go mod init goods
touch goods.proto

    go-zero└── goods├── go.mod└── goods.proto└── order

goods.proto代码如下

syntax = "proto3";
package goods;
option go_package = "./goods";// 定义请求体
message GoodsRequest {int64 goods_id = 1;
}// 定义响应体
message GoodsResponse {int64 goods_id = 1;string goods_name = 2;double price = 3;
}service Goods {rpc GetGoods(GoodsRequest) returns (GoodsResponse);
}

在当前目录下使用goctl生成一个rpc项目

goctl rpc protoc *.proto --go_out=./types --go-grpc_out=./types --zrpc_out=.

.
├── etc
│   └── goods.yaml
├── go.mod
├── goods.go
├── goods.proto
├── goodsclient
│   └── goods.go
├── internal
│   ├── config
│   │   └── config.go
│   ├── logic
│   │   └── getgoodslogic.go
│   ├── server
│   │   └── goodsserver.go
│   └── svc
│       └── servicecontext.go
└── types└── goods├── goods.pb.go└── goods_grpc.pb.go

4.2 实现业务逻辑

在logic/getgoodslogic.go中实现业务逻辑

func (l *GetGoodsLogic) GetGoods(in *goods.GoodsRequest) (*goods.GoodsResponse, error) {// todo: add your logic here and delete this lineresp := &goods.GoodsResponse{GoodsId: in.GoodsId,GoodsName: "乐高",Price: 500,}return resp, nil
}

4.3 api调用rpc服务

不管是rpc之间的互相调用，还是api调用rpc，我们都需要知道rpc的proto文件。本文通过go work来实现

$ go work init order
$ go work use goods

接下来需要对order的api项目进行修改

1. 修改配置文件order/etc/order-api.yaml

Name: order-api
Host: 0.0.0.0
Port: 8888DataSourceName: root:zxm123578@(127.0.0.1:3306)/MING_DB?charset=utf8Etcd:Hosts:- 127.0.0.1:2379Key: goods.rpc

2. 修改order/internal/config/config.go文件

package configimport ("github.com/zeromicro/go-zero/rest""github.com/zeromicro/go-zero/zrpc"
)type Config struct {rest.RestConfDataSourceName string//定义rpc服务GoodsRpc zrpc.RpcClientConf
}

3. 修改order/internal/svc/serviceContext.go

package svcimport ("goods/goodsclient""order/internal/config""order/internal/models""github.com/zeromicro/go-zero/zrpc""gorm.io/driver/mysql""gorm.io/gorm""gorm.io/gorm/schema"
)type ServiceContext struct {Config config.Config// DbEngin 数据库引擎DbEngin *gorm.DB//定义rpc类型Goods goodsclient.Goods
}func NewServiceContext(c config.Config) *ServiceContext {// 启动Gorm支持db, err := gorm.Open(mysql.Open(c.DataSourceName), &gorm.Config{NamingStrategy: schema.NamingStrategy{TablePrefix:   "o_", // 表名前缀SingularTable: true, // 使用单数表名},})if err != nil {panic(err)}//自动同步更新表结构db.AutoMigrate(&models.Order{})return &ServiceContext{Config:  c,DbEngin: db,//引入gprc服务Goods: goodsclient.NewGoods(zrpc.MustNewClient(c.GoodsRpc)),}
}

4. 修改order/internal/logic/orderInfoLogic.go

func (l *OrderInfoLogic) OrderInfo(req *types.OrderInfoReq) (resp *types.OrderInfoResp, err error) {// todo: add your logic here and delete this linegoodRequest := new(goods.GoodsRequest)goodRequest.GoodsId = req.OrderIdgoodsInfo, err := l.svcCtx.Goods.GetGoods(l.ctx, goodRequest)if err != nil {return nil, err}resp = &types.OrderInfoResp{OrderId:   req.OrderId,GoodsName: goodsInfo.GoodsName,Price:     goodsInfo.Price,}return resp, nil
}

4.4 执行

依次启动mysqll、etcd 、rpc和api

$ mysql -u root -p

# goods目录下
$ etcd

# goods目录下
$ go run goods.go -f etc/goods.yaml

# order目录下
$ go run order.go -f etc/order.yaml

通过curl进行post请求，查看结果

$  curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/info -d '{"order_id":34}' {"order_id":34,"goods_name":"乐高","price":500}%