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}%