你還在手撕微服務(wù)辨液？快試試 go-zero 的微服務(wù)自動生成

0. 為什么說做好微服務(wù)很難？

要想做好微服務(wù)舶吗，我們需要理解和掌握的知識點(diǎn)非常多征冷，從幾個維度上來說：

基本功能層面
1. 并發(fā)控制&限流，避免服務(wù)被突發(fā)流量擊垮
2. 服務(wù)注冊與服務(wù)發(fā)現(xiàn)誓琼，確保能夠動態(tài)偵測增減的節(jié)點(diǎn)
3. 負(fù)載均衡检激，需要根據(jù)節(jié)點(diǎn)承受能力分發(fā)流量
4. 超時(shí)控制，避免對已超時(shí)請求做無用功
5. 熔斷設(shè)計(jì)腹侣，快速失敗叔收，保障故障節(jié)點(diǎn)的恢復(fù)能力
高階功能層面
1. 請求認(rèn)證，確保每個用戶只能訪問自己的數(shù)據(jù)
2. 鏈路追蹤傲隶，用于理解整個系統(tǒng)和快速定位特定請求的問題
3. 日志饺律，用于數(shù)據(jù)收集和問題定位
4. 可觀測性，沒有度量就沒有優(yōu)化

對于其中每一點(diǎn)跺株，我們都需要用很長的篇幅來講述其原理和實(shí)現(xiàn)复濒，那么對我們后端開發(fā)者來說，要想把這些知識點(diǎn)都掌握并落實(shí)到業(yè)務(wù)系統(tǒng)里乒省，難度是非常大的巧颈，不過我們可以依賴已經(jīng)被大流量驗(yàn)證過的框架體系。go-zero微服務(wù)框架就是為此而生袖扛。

另外砸泛，我們始終秉承工具大于約定和文檔的理念。我們希望盡可能減少開發(fā)人員的心智負(fù)擔(dān)蛆封，把精力都投入到產(chǎn)生業(yè)務(wù)價(jià)值的代碼上唇礁，減少重復(fù)代碼的編寫，所以我們開發(fā)了goctl工具娶吞。

下面我通過書店服務(wù)來演示通過go-zero快速的創(chuàng)建微服務(wù)的流程，走完一遍械姻，你就會發(fā)現(xiàn)：原來編寫微服務(wù)如此簡單妒蛇！

1. 書店服務(wù)示例簡介

為了教程簡單，我們用書店服務(wù)做示例楷拳，并且只實(shí)現(xiàn)其中的增加書目和檢查價(jià)格功能绣夺。

寫此書店服務(wù)是為了從整體上演示go-zero構(gòu)建完整微服務(wù)的過程，實(shí)現(xiàn)細(xì)節(jié)盡可能簡化了欢揖。

2. 書店微服務(wù)架構(gòu)圖

architecture

3. goctl各層代碼生成一覽

所有綠色背景的功能模塊是自動生成的陶耍，按需激活，紅色模塊是需要自己寫的她混，也就是增加下依賴烈钞，編寫業(yè)務(wù)特有邏輯泊碑，各層示意圖分別如下：

API Gateway

api

rpc

model

model

下面我們來一起完整走一遍快速構(gòu)建微服務(wù)的流程，Let’s Go!???♂?

4. 準(zhǔn)備工作

安裝etcd, mysql, redis

安裝goctl工具

GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl

創(chuàng)建工作目錄bookstore
在bookstore目錄下執(zhí)行go mod init bookstore初始化go.mod

5. 編寫API Gateway代碼

在bookstore/api目錄下通過goctl生成api/bookstore.api：

goctl api -o bookstore.api

編輯bookstore.api毯欣，為了簡潔馒过，去除了文件開頭的info，代碼如下：

type (
    addReq struct {
        book  string `form:"book"`
        price int64  `form:"price"`
    }

    addResp struct {
        ok bool `json:"ok"`
    }
)

type (
    checkReq struct {
        book string `form:"book"`
    }

    checkResp struct {
        found bool  `json:"found"`
        price int64 `json:"price"`
    }
)

service bookstore-api {
    @server(
        handler: AddHandler
    )
    get /add(addReq) returns(addResp)

    @server(
        handler: CheckHandler
    )
    get /check(checkReq) returns(checkResp)
}

type用法和go一致酗钞，service用來定義get/post/head/delete等api請求腹忽，解釋如下：

service bookstore-api {這一行定義了service名字
@server部分用來定義server端用到的屬性
handler定義了服務(wù)端handler名字
get /add(addReq) returns(addResp)定義了get方法的路由、請求參數(shù)砚作、返回參數(shù)等

使用goctl生成API Gateway代碼

goctl api go -api bookstore.api -dir .

生成的文件結(jié)構(gòu)如下：

api
├── bookstore.api                  // api定義
├── bookstore.go                   // main入口定義
├── etc
│   └── bookstore-api.yaml         // 配置文件
└── internal
    ├── config
    │   └── config.go              // 定義配置
    ├── handler
    │   ├── addhandler.go          // 實(shí)現(xiàn)addHandler
    │   ├── checkhandler.go        // 實(shí)現(xiàn)checkHandler
    │   └── routes.go              // 定義路由處理
    ├── logic
    │   ├── addlogic.go            // 實(shí)現(xiàn)AddLogic
    │   └── checklogic.go          // 實(shí)現(xiàn)CheckLogic
    ├── svc
    │   └── servicecontext.go      // 定義ServiceContext
    └── types
        └── types.go               // 定義請求窘奏、返回結(jié)構(gòu)體

啟動API Gateway服務(wù)，默認(rèn)偵聽在8888端口
```
go run bookstore.go -f etc/bookstore-api.yaml
```
測試API Gateway服務(wù)
```
curl -i "http://localhost:8888/check?book=go-zero"
```
返回如下：
```
HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 03 Sep 2020 06:46:18 GMT
Content-Length: 25

{"found":false,"price":0}
```
可以看到我們API Gateway其實(shí)啥也沒干葫录，就返回了個空值着裹，接下來我們會在rpc服務(wù)里實(shí)現(xiàn)業(yè)務(wù)邏輯
可以修改internal/svc/servicecontext.go來傳遞服務(wù)依賴（如果需要）
實(shí)現(xiàn)邏輯可以修改internal/logic下的對應(yīng)文件
可以通過goctl生成各種客戶端語言的api調(diào)用代碼
到這里，你已經(jīng)可以通過goctl生成客戶端代碼給客戶端同學(xué)并行開發(fā)了压昼，支持多種語言求冷，詳見文檔

6. 編寫add rpc服務(wù)

在rpc/add目錄下編寫add.proto文件

可以通過命令生成proto文件模板

goctl rpc template -o add.proto

修改后文件內(nèi)容如下：

syntax = "proto3";

package add;

message addReq {
    string book = 1;
    int64 price = 2;
}

message addResp {
    bool ok = 1;
}

service adder {
    rpc add(addReq) returns(addResp);
}

用goctl生成rpc代碼，在rpc/add目錄下執(zhí)行命令

goctl rpc proto -src add.proto

文件結(jié)構(gòu)如下：

rpc/add
├── add.go                      // rpc服務(wù)main函數(shù)
├── add.proto                   // rpc接口定義
├── adder
│   ├── adder.go                // 提供了外部調(diào)用方法窍霞，無需修改
│   ├── adder_mock.go           // mock方法匠题，測試用
│   └── types.go                // request/response結(jié)構(gòu)體定義
├── etc
│   └── add.yaml                // 配置文件
├── internal
│   ├── config
│   │   └── config.go           // 配置定義
│   ├── logic
│   │   └── addlogic.go         // add業(yè)務(wù)邏輯在這里實(shí)現(xiàn)
│   ├── server
│   │   └── adderserver.go      // 調(diào)用入口, 不需要修改
│   └── svc
│       └── servicecontext.go   // 定義ServiceContext，傳遞依賴
└── pb
    └── add.pb.go

直接可以運(yùn)行但金，如下：

  $ go run add.go -f etc/add.yaml
  Starting rpc server at 127.0.0.1:8080...

etc/add.yaml文件里可以修改偵聽端口等配置

7. 編寫check rpc服務(wù)

在rpc/check目錄下編寫check.proto文件

可以通過命令生成proto文件模板

goctl rpc template -o check.proto

修改后文件內(nèi)容如下：

syntax = "proto3";

package check;

message checkReq {
    string book = 1;
}

message checkResp {
    bool found = 1;
    int64 price = 2;
}

service checker {
    rpc check(checkReq) returns(checkResp);
}

用goctl生成rpc代碼韭山，在rpc/check目錄下執(zhí)行命令

goctl rpc proto -src check.proto

文件結(jié)構(gòu)如下：

rpc/check
├── check.go                    // rpc服務(wù)main函數(shù)
├── check.proto                 // rpc接口定義
├── checker
│   ├── checker.go              // 提供了外部調(diào)用方法，無需修改
│   ├── checker_mock.go         // mock方法冷溃，測試用
│   └── types.go                // request/response結(jié)構(gòu)體定義
├── etc
│   └── check.yaml              // 配置文件
├── internal
│   ├── config
│   │   └── config.go           // 配置定義
│   ├── logic
│   │   └── checklogic.go       // check業(yè)務(wù)邏輯在這里實(shí)現(xiàn)
│   ├── server
│   │   └── checkerserver.go    // 調(diào)用入口, 不需要修改
│   └── svc
│       └── servicecontext.go   // 定義ServiceContext钱磅，傳遞依賴
└── pb
    └── check.pb.go

etc/check.yaml文件里可以修改偵聽端口等配置

需要修改etc/check.yaml的端口為8081，因?yàn)?code>8080已經(jīng)被add服務(wù)使用了似枕，直接可以運(yùn)行盖淡，如下：

$ go run check.go -f etc/check.yaml
Starting rpc server at 127.0.0.1:8081...

8. 修改API Gateway代碼調(diào)用add/check rpc服務(wù)

修改配置文件bookstore-api.yaml，增加如下內(nèi)容

Add:
  Etcd:
    Hosts:
      - localhost:2379
    Key: add.rpc
Check:
  Etcd:
    Hosts:
      - localhost:2379
    Key: check.rpc

通過etcd自動去發(fā)現(xiàn)可用的add/check服務(wù)

修改internal/config/config.go如下凿歼，增加add/check服務(wù)依賴

type Config struct {
    rest.RestConf
    Add   rpcx.RpcClientConf     // 手動代碼
    Check rpcx.RpcClientConf     // 手動代碼
}

修改internal/svc/servicecontext.go褪迟，如下：

type ServiceContext struct {
    Config  config.Config
    Adder   adder.Adder          // 手動代碼
    Checker checker.Checker      // 手動代碼
}

func NewServiceContext(c config.Config) *ServiceContext {
    return &ServiceContext{
        Config:  c,
        Adder:   adder.NewAdder(rpcx.MustNewClient(c.Add)),         // 手動代碼
        Checker: checker.NewChecker(rpcx.MustNewClient(c.Check)),   // 手動代碼
    }
}

通過ServiceContext在不同業(yè)務(wù)邏輯之間傳遞依賴

修改internal/logic/addlogic.go里的Add方法，如下：

func (l *AddLogic) Add(req types.AddReq) (*types.AddResp, error) {
    // 手動代碼開始
    resp, err := l.svcCtx.Adder.Add(l.ctx, &adder.AddReq{
        Book:  req.Book,
        Price: req.Price,
    })
    if err != nil {
        return nil, err
    }

    return &types.AddResp{
        Ok: resp.Ok,
    }, nil
    // 手動代碼結(jié)束
}

通過調(diào)用adder的Add方法實(shí)現(xiàn)添加圖書到bookstore系統(tǒng)

修改internal/logic/checklogic.go里的Check方法答憔，如下：

func (l *CheckLogic) Check(req types.CheckReq) (*types.CheckResp, error) {
    // 手動代碼開始
    resp, err := l.svcCtx.Checker.Check(l.ctx, &checker.CheckReq{
        Book:  req.Book,
    })
    if err != nil {
        return nil, err
    }

    return &types.CheckResp{
        Found: resp.Found,
        Price: resp.Price,
    }, nil
    // 手動代碼結(jié)束
}

通過調(diào)用checker的Check方法實(shí)現(xiàn)從bookstore系統(tǒng)中查詢圖書的價(jià)格

9. 定義數(shù)據(jù)庫表結(jié)構(gòu)味赃，并生成CRUD+cache代碼

bookstore下創(chuàng)建rpc/model目錄：mkdir -p rpc/model

在rpc/model目錄下編寫創(chuàng)建book表的sql文件book.sql，如下：

CREATE TABLE `book`
(
  `book` varchar(255) NOT NULL COMMENT 'book name',
  `price` int NOT NULL COMMENT 'book price',
  PRIMARY KEY(`book`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

創(chuàng)建DB和table

create database gozero;

source book.sql;

在rpc/model目錄下執(zhí)行如下命令生成CRUD+cache代碼虐拓，-c表示使用redis cache
```
goctl model mysql ddl -c -src book.sql -dir .
```
也可以用datasource命令代替ddl來指定數(shù)據(jù)庫鏈接直接從schema生成

生成后的文件結(jié)構(gòu)如下：
```
rpc/model
├── bookstore.sql
├── bookstoremodel.go     // CRUD+cache代碼
└── vars.go               // 定義常量和變量
```

10. 修改add/check rpc代碼調(diào)用crud+cache代碼

修改rpc/add/etc/add.yaml和rpc/check/etc/check.yaml心俗，增加如下內(nèi)容：
```
DataSource: root:@tcp(localhost:3306)/gozero
Table: book
Cache:
  - Host: localhost:6379
```
可以使用多個redis作為cache，支持redis單點(diǎn)或者redis集群

修改rpc/add/internal/config.go和rpc/check/internal/config.go，如下：

type Config struct {
    rpcx.RpcServerConf
    DataSource string             // 手動代碼
    Table      string             // 手動代碼
    Cache      cache.CacheConf    // 手動代碼
}

增加了mysql和redis cache配置

修改rpc/add/internal/svc/servicecontext.go和rpc/check/internal/svc/servicecontext.go城榛，如下：

type ServiceContext struct {
    c     config.Config
    Model *model.BookModel   // 手動代碼
}

func NewServiceContext(c config.Config) *ServiceContext {
    return &ServiceContext{
        c:             c,
        Model: model.NewBookModel(sqlx.NewMysql(c.DataSource), c.Cache, c.Table), // 手動代碼
    }
}

修改rpc/add/internal/logic/addlogic.go揪利，如下：

func (l *AddLogic) Add(in *add.AddReq) (*add.AddResp, error) {
    // 手動代碼開始
    _, err := l.svcCtx.Model.Insert(model.Book{
        Book:  in.Book,
        Price: in.Price,
    })
    if err != nil {
        return nil, err
    }

    return &add.AddResp{
        Ok: true,
    }, nil
    // 手動代碼結(jié)束
}

修改rpc/check/internal/logic/checklogic.go，如下：

func (l *CheckLogic) Check(in *check.CheckReq) (*check.CheckResp, error) {
    // 手動代碼開始
    resp, err := l.svcCtx.Model.FindOne(in.Book)
    if err != nil {
        return nil, err
    }

    return &check.CheckResp{
        Found: true,
        Price: resp.Price,
    }, nil
    // 手動代碼結(jié)束
}

至此代碼修改完成吠谢，凡事手動修改的代碼我加了標(biāo)注

11. 完整調(diào)用演示

add api調(diào)用

curl -i "http://localhost:8888/add?book=go-zero&price=10"

返回如下：

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 03 Sep 2020 09:42:13 GMT
Content-Length: 11

{"ok":true}

check api調(diào)用

curl -i "http://localhost:8888/check?book=go-zero"

返回如下：

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 03 Sep 2020 09:47:34 GMT
Content-Length: 25

{"found":true,"price":10}

12. Benchmark

因?yàn)閷懭胍蕾囉趍ysql的寫入速度土童，就相當(dāng)于壓mysql了，所以壓測只測試了check接口工坊，相當(dāng)于從mysql里讀取并利用緩存献汗，為了方便，直接壓這一本書王污，因?yàn)橛芯彺姘粘裕啾緯彩且粯拥模瑢簻y結(jié)果沒有影響昭齐。

壓測之前尿招，讓我們先把打開文件句柄數(shù)調(diào)大：

ulimit -n 20000

并日志的等級改為error，防止過多的info影響壓測結(jié)果阱驾，在每個yaml配置文件里加上如下：

Log:
    Level: error

benchmark

可以看出在我的MacBook Pro上能達(dá)到3萬+的qps就谜。

13. 完整代碼

https://github.com/tal-tech/go-zero/tree/master/example/bookstore

14. 總結(jié)

我們一直強(qiáng)調(diào)工具大于約定和文檔。

go-zero不只是一個框架里覆，更是一個建立在框架+工具基礎(chǔ)上的丧荐，簡化和規(guī)范了整個微服務(wù)構(gòu)建的技術(shù)體系。

我們在保持簡單的同時(shí)也盡可能把微服務(wù)治理的復(fù)雜度封裝到了框架內(nèi)部喧枷，極大的降低了開發(fā)人員的心智負(fù)擔(dān)虹统，使得業(yè)務(wù)開發(fā)得以快速推進(jìn)。

通過go-zero+goctl生成的代碼隧甚，包含了微服務(wù)治理的各種組件车荔，包括：并發(fā)控制、自適應(yīng)熔斷戚扳、自適應(yīng)降載忧便、自動緩存控制等，可以輕松部署以承載巨大訪問量帽借。

有任何好的提升工程效率的想法珠增，隨時(shí)歡迎交流！??

15. 項(xiàng)目地址

https://github.com/tal-tech/go-zero

16. 微信交流群

添加我的微信：kevwan宜雀，請注明go-zero切平，我拉進(jìn)go-zero社區(qū)群??

好未來技術(shù)

你還在手撕微服務(wù)碾牌？快試試 go-zero 的微服務(wù)自動生成

你還在手撕微服務(wù)康愤？快試試 go-zero 的微服務(wù)自動生成