rest 框架概览
咱们先通过 go-zero
自带的命令行工具 goctl
来生成一个 api service
,其 main
函数如下:
func main() {flag.Parse()
var c config.Config
conf.MustLoad(*configFile, &c)
ctx := svc.NewServiceContext(c)
server := rest.MustNewServer(c.RestConf)
defer server.Stop()
handler.RegisterHandlers(server, ctx)
fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
server.Start()}
- 解析配置文件
- 将配置文件传入,初始化
serviceContext
- 初始化
rest server
-
将
context
注入server
中:- 注册路由
- 将
context
中的启动的endpoint
同时注入到router
当中
- 启动
server
接下来咱们来一步步解说其设计原理!Let’s Go!
web 框架
从日常开发教训来说,一个好的 web 框架大抵须要满足以下个性:
- 路由匹配 / 多路由反对
- 反对自定义中间件
- 框架和业务开发齐全解耦,不便开发者疾速开发
- 参数校验 / 匹配
- 监控 / 日志 / 指标等服务自查性能
- 服务自爱护(熔断 / 限流)
go-zero rest 设计
https://github.com/zeromicro/go-zero/tree/master/rest
概览
- 借助 context (不同于 gin 的 context),将资源初始化好 → 保留在
serviveCtx
中,在 handler 中共享(至于资源池化,交给资源本人解决,serviveCtx
只是入口和共享点) - 独立 router 申明文件,同时退出 router group 的概念,不便开发者整顿代码构造
- 内置若干中间件:监控 / 熔断 / 鉴权等
- 利用 goctl codegen + option 设计模式,不便开发者本人管制局部中间件的接入
上图形容了 rest 解决申请的模式和大部分解决门路。
- 框架内置的中间件曾经帮开发者解决了大部分服务自解决的逻辑
- 同时 go-zero 在
business logic
处也给予开发者开箱即用的组件(dq、fx 等) - 从开发模式上帮忙开发者只须要关注本人的
business logic
以及所需资源筹备
上面咱们来细说一下整个 rest 是如何启动的?
启动流程
上图形容了整体 server 启动通过的模块和大抵流程。筹备依照如下流程剖析 rest 实现:
- 基于 http.server 封装以及革新:把 engine(web 框架外围) 和 option 隔离开
- 多路由匹配采取 radix-tree 结构
- 中间件采纳洋葱模型 →
[]Middleware
- http parse 解析以及匹配校验 →
httpx.Parse()
- 在申请过程会收集指标 (
createMetrics()
) 以及监控埋点 (prometheus)
server engine 封装
点开大图观看
engine 贯通整个 server 生命周期中:
- router 会携带开发者定义的 path/handler,会在最初的 router.handle() 执行
- 注册的自定义中间件 + 框架中间件,在 router handler logic 前执行
在这里:go-zero 解决的粒度在 route 上,封装和解决都在 route 一层层执行
路由匹配
那么当 request 到来,首先是如何到路由这一层的?
首先在开发最原始的 http server,都有这么一段代码:
type helloHandler struct{}
func (h *helloHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {w.Write([]byte("Hello, world!"))
}
func main() {http.Handle("/", &helloHandler{})
http.ListenAndServe(":12345", nil)
}
http.ListenAndServe()
外部会执行到:server.ListenAndServe()
咱们看看在 rest 外面是怎么使用的:
而传入的 handler 其实就是:router.NewRouter() 生成的 router。这个 router 承载了整个 server 的处理函数汇合。
同时 http.Server 构造在初始化时,是把 handler 注入到外面的:
type Server struct {
...
Handler Handler
}
func start(..., handler http.Handler, run func(srv *http.Server) error) (err error) {
server := &http.Server{Addr: fmt.Sprintf("%s:%d", host, port),
Handler: handler,
}
...
return run(server)
}
在 http.Server 接管 req 后,最终执行的也是:handler.ServeHTTP(rw, req)
所以内置的 router 也须要实现 ServeHTTP
。至于 router 本人是怎么实现 ServeHTTP
: 无外乎就是寻找匹配路由,而后执行路由对应的 handle logic。
解析参数
解析参数是 http 框架须要提供的根本能力。在 goctl code gen 生成的代码中,handler 层曾经集成了 req argument parse 函数:
// generate by goctl
func QueryAllTaskHandler(ctx *svc.ServiceContext) http.HandlerFunc {return func(w http.ResponseWriter, r *http.Request) {
// custom request in .api file
var req types.QueryAllTaskRequest
// parse http request
if err := httpx.Parse(r, &req); err != nil {httpx.Error(w, err)
return
}
l := logic.NewEventLogic(r.Context(), ctx)
resp, err := l.QueryAllTask(req)
baseresponse.FormatResponseWithRequest(resp, err, w, r)
}
}
进入到 httpx.Parse()
,次要解析以下几块:
https://github.com/zeromicro/go-zero/blob/master/rest/httpx/requests.go#L32:6
- 解析 path
- 解析 form 表单
- 解析 http header
- 解析 json
Parse() 中的 参数校验 的性能见:
https://go-zero.dev/cn/api-grammar.html 中的
tag 修饰符
Tips
学习源码举荐 fork 进去边看边写正文和心得,能够加深了解,当前用到这块性能的时候也能够回头翻阅。
我的项目地址
https://github.com/zeromicro/go-zero
欢送应用 go-zero
并 star 反对咱们!
微信交换群
关注『微服务实际 』公众号并点击 交换群 获取社区群二维码。