0. go-zero 介紹
go-zero 是一個集成了各種工程實踐的 web 和 rpc 框架。通過彈性設計保障了大併發服務端的穩定性，經受了充分的實戰檢驗。
go-zero 包含極簡的 API 定義和生成工具 goctl，可以根據定義的 api 文件一鍵生成 Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript 代碼，並可直接運行。
使用 go-zero 的好處：
- 輕鬆獲得支撐千萬日活服務的穩定性
- 內建級聯超時控制、限流、自適應熔斷、自適應降載等微服務治理能力，無需配置和額外代碼
- 微服務治理中間件可無縫集成到其它現有框架使用
- 極簡的 API 描述，一鍵生成各端代碼
- 自動校驗客戶端請求參數合法性
- 大量微服務治理和併發工具包
架構圖
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 mock server，便於客戶端開發
- 自動生成服務端功能測試
5. Installation
在項目目錄下通過如下命令安裝：
<code>go
get -u github.com/tal-tech/go
-zero /<code>
6. Quick Start
- 編譯 goctl 工具
<code>go
build tools/goctl/goctl.go
/<code>
把 goctl 放到$PATH 的目錄下，確保 goctl 可執行
- 定義 API 文件，比如 greet.api，可以在 vs code 裡安裝goctl插件，支持 api 語法
<code>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); } /<code>
也可以通過 goctl 生成 api 模本文件，命令如下：
<code>goctl
api
-o
greet
.api
/<code>
- 生成 go 服務端代碼
<code>goctl
api
go
-api
greet
.api
-dir
greet
/<code>
生成的文件結構如下：
<code>├── greet │ ├── etc │ │ └── greet-api.json │ ├── greet.go
│ └── internal │ ├── config │ │ └── config.go
│ ├── handler │ │ ├── greethandler.go
│ │ └── routes.go
│ ├── logic │ │ └── greetlogic.go
│ ├── svc │ │ └── servicecontext.go
│ └── types │ └── types.go
└── greet.api /<code>
生成的代碼可以直接運行：
<code>cd greetgo
run greet.go
-f etc/greet-api.json /<code>
默認偵聽在 8888 端口（可以在配置文件裡修改），可以通過 curl 請求：
<code>➜go
-zero git:(master) curl -w"\ncode: %{http_code}\n"
http: {"code"
:0
} code:200
/<code>
編寫業務代碼：
- 可以在 servicecontext.go 裡面傳遞依賴給 logic，比如 mysql, redis 等
- 在 api 定義的 get/post/put/delete 等請求對應的 logic 裡增加業務處理邏輯
- 可以根據 api 文件生成前端需要的 Java, TypeScript, Dart, JavaScript 代碼
<code>goctl
api
java
-api
greet
.api
-dir
greet
goctl
api
dart
-api
greet
.api
-dir
greet
... /<code>
7. Benchmark
benchmark
測試代碼見這裡：
https://github.com/smallnest/go-web-framework-benchmark
8. 項目地址
https://github.com/tal-tech/go-zero
