0. go-zero 介紹
go-zero 是一個集成了各類工程實踐的 web 和 rpc 框架。經過彈性設計保障了大併發服務端的穩定性,經受了充分的實戰檢驗。前端
go-zero 包含極簡的 API 定義和生成工具 goctl,能夠根據定義的 api 文件一鍵生成 Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript 代碼,並可直接運行。java
使用 go-zero 的好處:mysql
- 輕鬆得到支撐千萬日活服務的穩定性
- 內建級聯超時控制、限流、自適應熔斷、自適應降載等微服務治理能力,無需配置和額外代碼
- 微服務治理中間件可無縫集成到其它現有框架使用
- 極簡的 API 描述,一鍵生成各端代碼
- 自動校驗客戶端請求參數合法性
- 大量微服務治理和併發工具包
1. go-zero 框架背景
18 年初,曉黑板後端在通過頻繁的宕機後,決定從Java+MongoDB
的單體架構遷移到微服務架構,通過仔細思考和對比,咱們決定:git
- 基於 Go 語言
- 高效的性能
- 簡潔的語法
- 普遍驗證的工程效率
- 極致的部署體驗
- 極低的服務端資源成本
- 自研微服務框架
- 我的有過不少微服務框架自研經驗
- 須要有更快速的問題定位能力
- 更便捷的增長新特性
2. go-zero 框架設計思考
對於微服務框架的設計,咱們指望保障微服務穩定性的同時,也要特別注重研發效率。因此設計之初,咱們就有以下一些準則:github
- 保持簡單
- 高可用
- 高併發
- 易擴展
- 彈性設計,面向故障編程
- 儘量對業務開發友好,封裝複雜度
- 儘量約束作一件事只有一種方式
咱們經歷不到半年時間,完全完成了從Java+MongoDB
到Golang+MySQL
爲主的微服務體系遷移,並於 18 年 8 月底徹底上線,穩定保障了曉黑板後續增加,確保了整個服務的高可用。web
3. go-zero 項目實現和特色
go-zero 是一個集成了各類工程實踐的包含 web 和 rpc 框架,有以下主要特色:redis
- 強大的工具支持,儘量少的代碼編寫
- 極簡的接口
- 徹底兼容 net/http
- 支持中間件,方便擴展
- 高性能
- 面向故障編程,彈性設計
- 內建服務發現、負載均衡
- 內建限流、熔斷、降載,且自動觸發,自動恢復
- API 參數自動校驗
- 超時級聯控制
- 自動緩存控制
- 鏈路跟蹤、統計報警等
- 高併發支撐,穩定保障了曉黑板疫情期間天天的流量洪峯
以下圖,咱們從多個層面保障了總體服務的高可用:sql
4. go-zero 近期開發計劃
- 自動生成 API mock server,便於客戶端開發
- 自動生成服務端功能測試
5. Installation
在項目目錄下經過以下命令安裝:編程
go get -u github.com/tal-tech/go-zero
6. Quick Start
- 編譯 goctl 工具
go build tools/goctl/goctl.go
把 goctl 放到 $PATH 的目錄下,確保 goctl 可執行json
- 定義 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
- 生成 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 裏增長業務處理邏輯
- 能夠根據 api 文件生成前端須要的 Java, TypeScript, Dart, JavaScript 代碼
goctl api java -api greet.api -dir greet goctl api dart -api greet.api -dir greet ...
7. Benchmark
8. 項目地址
https://github.com/tal-tech/go-zero
9. 微信交流羣
掃碼加入微信交流羣