曉黑板 go-zero 微服務框架介紹

1. go-zero 框架背景

18 年初，曉黑板後端在經過頻繁的當機後，決定從Java+MongoDB的單體架構遷移到微服務架構，經過仔細思考和對比，我們決定：

• 基於 Go 語言
  • 高效的效能
  • 簡潔的語法
  • 廣泛驗證的工程效率
  • 極致的部署體驗
  • 極低的服務端資源成本
• 自研微服務框架
  • 個人有過很多微服務框架自研經驗
  • 需要有更快速的問題定位能力
  • 更便捷的增加新特性

2. go-zero 框架設計思考

對於微服務框架的設計，我們期望保障微服務穩定性的同時，也要特別注重研發效率。所以設計之初，我們就有如下一些準則：

• 保持簡單
• 高可用
• 高併發
• 易擴充套件
• 彈性設計，面向故障程式設計
• 儘可能對業務開發友好，封裝複雜度
• 儘可能約束做一件事只有一種方式

我們經歷不到半年時間，徹底完成了從Java+MongoDB到Golang+MySQL為主的微服務體系遷移，並於 18 年 8 月底完全上線，穩定保障了曉黑板後續增長，確保了整個服務的高可用。

3. go-zero 專案實現和特點

go-zero 是一個整合了各種工程實踐的包含 web 和 rpc 框架，有如下主要特點：

• 強大的工具支援，儘可能少的程式碼編寫
• 極簡的介面
• 完全相容 net/http
• 支援中介軟體，方便擴充套件
• 高效能
• 面向故障程式設計，彈性設計
• 內建服務發現、負載均衡
• 內建限流、熔斷、降載，且自動觸發，自動恢復
• API 引數自動校驗
• 超時級聯控制
• 自動快取控制
• 鏈路跟蹤、統計報警等
• 高併發支撐，穩定保障了曉黑板疫情期間每天的流量洪峰

如下圖，我們從多個層面保障了整體服務的高可用：

4. go-zero 框架收益

• 保障大併發服務端的穩定性，經受了充分的實戰檢驗
• 極簡的 API 定義
• 一鍵生成 Go, iOS, Android, Dart, TypeScript, JavaScript 程式碼，並可直接執行
• 服務端自動校驗引數合法性

5. go-zero 近期開發計劃

• 自動生成 API mock server，便於客戶端開發
• 自動生成服務端功能測試

6. Installation

在專案目錄下通過如下命令安裝：

go get -u github.com/tal-tech/go-zero

7. Quick Start

1. 編譯 goctl 工具

go build tools/goctl/goctl.go

把 goctl 放到 $PATH 的目錄下，確保 goctl 可執行

1. 定義 API 檔案，比如 greet.api，可以在 vs code 裡安裝goctl外掛，支援 api 語法

type Request struct {
  Name string `path:"name,options=you|me"` // 框架自動驗證請求引數是否合法
}

type Response struct {
  Message string `json:"message"`
}

service greet-api {
  @server(
    handler: GreetHandler
  )
  get /greet/from/:name(Request) returns (Response);
}

也可以通過 goctl 生成 api 模本檔案，命令如下：

goctl api -o greet.api

1. 生成 go 服務端程式碼

goctl api go -api greet.api -dir greet

生成的檔案結構如下：

├── greet
│   ├── etc
│   │   └── greet-api.json        // 配置檔案
│   ├── greet.go                  // main檔案
│   └── internal
│       ├── config
│       │   └── config.go         // 配置定義
│       ├── handler
│       │   ├── greethandler.go   // get/put/post/delete等路由定義檔案
│       │   └── routes.go         // 路由列表
│       ├── logic
│       │   └── greetlogic.go     // 請求邏輯處理檔案
│       ├── svc
│       │   └── servicecontext.go // 請求上下文，可以傳入mysql, redis等依賴
│       └── types
│           └── types.go          // 請求、返回等型別定義
└── greet.api                     // api描述檔案

生成的程式碼可以直接執行：

cd greet
go run greet.go -f etc/greet-api.json

預設偵聽在 8888 埠（可以在配置檔案裡修改），可以通過 curl 請求：

➜  go-zero git:(master) curl -w "\ncode: %{http_code}\n" http://localhost:8888/greet/from/kevin
{"code":0}
code: 200

編寫業務程式碼：

• 可以在 servicecontext.go 裡面傳遞依賴給 logic，比如 mysql, redis 等
  • 在 api 定義的 get/post/put/delete 等請求對應的 logic 裡增加業務處理邏輯

1. 可以根據 api 檔案生成前端需要的 Java, TypeScript, Dart, JavaScript 程式碼

goctl api java -api greet.api -dir greet
goctl api dart -api greet.api -dir greet
...

8. Benchmark

測試程式碼見這裡