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
在我的项目目录下通过如下命令装置:
go get -u github.com/tal-tech/go-zero
6. Quick Start
-
编译 goctl 工具
go build tools/goctl/goctl.go
把 goctl 放到 $PATH 的目录下,确保 goctl 可执行
-
定义 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
好将来技术