go-zero 是一个集成了各种工程实际的 web 和 rpc 框架，其中rest是web框架模块，基于Go语言原生的http包进行构建，是一个轻量的，高性能的，性能残缺的，简略易用的web框架
服务创立
go-zero中创立http服务非常简单，官网举荐应用goctl工具来生成。为了不便演示，这里通过手动创立服务，代码如下
package mainimport ( "log" "net/http" "github.com/tal-tech/go-zero/core/logx" "github.com/tal-tech/go-zero/core/service" "github.com/tal-tech/go-zero/rest" "github.com/tal-tech/go-zero/rest/httpx")func main() { srv, err := rest.NewServer(rest.RestConf{ Port: 9090, // 侦听端口 ServiceConf: service.ServiceConf{ Log: logx.LogConf{Path: "./logs"}, // 日志门路 }, }) if err != nil { log.Fatal(err) } defer srv.Stop() // 注册路由 srv.AddRoutes([]rest.Route{ { Method: http.MethodGet, Path: "/user/info", Handler: userInfo, }, }) srv.Start() // 启动服务}type User struct { Name string `json:"name"` Addr string `json:"addr"` Level int `json:"level"`}func userInfo(w http.ResponseWriter, r *http.Request) { var req struct { UserId int64 `form:"user_id"` // 定义参数 } if err := httpx.Parse(r, &req); err != nil { // 解析参数 httpx.Error(w, err) return } users := map[int64]*User{ 1: &User{"go-zero", "shanghai", 1}, 2: &User{"go-queue", "beijing", 2}, } httpx.WriteJson(w, http.StatusOK, users[req.UserId]) // 返回后果}通过rest.NewServer创立服务，示例配置了端口号和日志门路，服务启动后侦听在9090端口，并在当前目录下创立logs目录同时创立各等级日志文件
而后通过srv.AddRoutes注册路由，每个路由须要定义该路由的办法、Path和Handler，其中Handler类型为http.HandlerFunc
最初通过srv.Start启动服务，启动服务后通过拜访http://localhost:9090/user/info?user_id=1能够看到返回后果
{ name: "go-zero", addr: "shanghai", level: 1}到此一个简略的http服务就创立实现了，可见应用rest创立http服务非常简单，次要分为三个步骤：创立Server、注册路由、启动服务
JWT鉴权
鉴权简直是每个利用必备的能力，鉴权的形式很多，而jwt是其中比较简单和牢靠的一种形式，在rest框架中内置了jwt鉴权性能，jwt的原理流程如下图
<img src="https://oscimg.oschina.net/oscnet/up-cd9dc0dbd93e7be4b46a3e8cba1f3438ccd.png" alt="jwt" style="zoom:50%;">
rest框架中通过rest.WithJwt(secret)启用jwt鉴权，其中secret为服务器秘钥是不能泄露的，因为须要应用secret来算签名验证payload是否被篡改，如果secret泄露客户端就能够自行签发token，黑客就能肆意篡改token了。咱们基于下面的例子进行革新来验证在rest中如何应用jwt鉴权
获取jwt
第一步客户端须要先获取jwt，在登录接口中实现jwt生成逻辑
srv.AddRoute(rest.Route{ Method: http.MethodPost, Path: "/user/login", Handler: userLogin,})为了演示不便，userLogin的逻辑非常简单，次要是获取信息而后生成jwt，获取到的信息存入jwt payload中，而后返回jwt
func userLogin(w http.ResponseWriter, r *http.Request) { var req struct { UserName string `json:"user_name"` UserId int `json:"user_id"` } if err := httpx.Parse(r, &req); err != nil { httpx.Error(w, err) return } token, _ := genToken(accessSecret, map[string]interface{}{ "user_id": req.UserId, "user_name": req.UserName, }, accessExpire) httpx.WriteJson(w, http.StatusOK, struct { UserId int `json:"user_id"` UserName string `json:"user_name"` Token string `json:"token"` }{ UserId: req.UserId, UserName: req.UserName, Token: token, })}生成jwt的办法如下
func genToken(secret string, payload map[string]interface{}, expire int64) (string, error) { now := time.Now().Unix() claims := make(jwt.MapClaims) claims["exp"] = now + expire claims["iat"] = now for k, v := range payload { claims[k] = v } token := jwt.New(jwt.SigningMethodHS256) token.Claims = claims return token.SignedString([]byte(secret))}启动服务后通过cURL拜访
curl -X "POST" "http://localhost:9090/user/login" \ -H 'Content-Type: application/json; charset=utf-8' \ -d $'{ "user_name": "gozero", "user_id": 666}'会失去如下返回后果
{ "user_id": 666, "user_name": "gozero", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDYxMDgwNDcsImlhdCI6MTYwNTUwMzI0NywidXNlcl9pZCI6NjY2LCJ1c2VyX25hbWUiOiJnb3plcm8ifQ.hhMd5gc3F9xZwCUoiuFqAWH48xptqnNGph0AKVkTmqM"}增加Header
通过rest.WithJwt(accessSecret)启用jwt鉴权
srv.AddRoute(rest.Route{ Method: http.MethodGet, Path: "/user/data", Handler: userData,}, rest.WithJwt(accessSecret))拜访/user/data接口返回 401 Unauthorized 鉴权不通过，增加Authorization Header，即能失常拜访
curl "http://localhost:9090/user/data?user_id=1" \ -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDYxMDgwNDcsImlhdCI6MTYwNTUwMzI0NywidXNlcl9pZCI6NjY2LCJ1c2VyX25hbWUiOiJnb3plcm8ifQ.hhMd5gc3F9xZwCUoiuFqAWH48xptqnNGph0AKVkTmqM'获取信息
个别会将用户的信息比方用户id或者用户名存入jwt的payload中，而后从jwt的payload中解析出咱们预存的信息，即可晓得本次申请时哪个用户发动的
func userData(w http.ResponseWriter, r *http.Request) { var jwt struct { UserId int `ctx:"user_id"` UserName string `ctx:"user_name"` } err := contextx.For(r.Context(), &jwt) if err != nil { httpx.Error(w, err) } httpx.WriteJson(w, http.StatusOK, struct { UserId int `json:"user_id"` UserName string `json:"user_name"` }{ UserId: jwt.UserId, UserName: jwt.UserName, })}实现原理
jwt鉴权的实现在authhandler.go中，实现原理也比较简单，先依据secret解析jwt token，验证token是否无效，有效或者验证出错则返回401 Unauthorized
func unauthorized(w http.ResponseWriter, r *http.Request, err error, callback UnauthorizedCallback) { writer := newGuardedResponseWriter(w) if err != nil { detailAuthLog(r, err.Error()) } else { detailAuthLog(r, noDetailReason) } if callback != nil { callback(writer, r, err) } writer.WriteHeader(http.StatusUnauthorized)}验证通过后把payload中的信息存入http request的context中
ctx := r.Context()for k, v := range claims { switch k { case jwtAudience, jwtExpire, jwtId, jwtIssueAt, jwtIssuer, jwtNotBefore, jwtSubject: // ignore the standard claims default: ctx = context.WithValue(ctx, k, v) }}next.ServeHTTP(w, r.WithContext(ctx))中间件
web框架中的中间件是实现业务和非业务性能解耦的一种形式，在web框架中咱们能够通过中间件来实现诸如鉴权、限流、熔断等等性能，中间件的原理流程如下图
rest框架中内置了十分丰盛的中间件，在rest/handler门路下，通过alice工具把所有中间件链接起来，当发动申请时会顺次通过每一个中间件，当满足所有条件后最终申请才会达到真正的业务Handler执行业务逻辑，下面介绍的jwt鉴权就是通过authHandler来实现的。因为内置中间件比拟多篇幅无限不能一一介绍，感兴趣的搭档能够自行学习，这里咱们介绍一下prometheus指标收集的中间件PromethousHandler，代码如下
func PromethousHandler(path string) func(http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { startTime := timex.Now() // 起始工夫 cw := &security.WithCodeResponseWriter{Writer: w} defer func() { // 耗时 metricServerReqDur.Observe(int64(timex.Since(startTime)/time.Millisecond), path) // code码 metricServerReqCodeTotal.Inc(path, strconv.Itoa(cw.Code)) }() next.ServeHTTP(cw, r) }) }}在该中间件中，在申请开始时记录了起始工夫，在申请完结后在defer中通过prometheus的Histogram和Counter数据类型别离记录了以后申请path的耗时和返回的code码，此时咱们通过拜访http://127.0.0.1:9101/metrics即可查看相干的指标信息
路由原理
rest框架中通过AddRoutes办法来注册路由，每一个Route有Method、Path和Handler三个属性，Handler类型为http.HandlerFunc，增加的路由会被换成featuredRoutes定义如下
featuredRoutes struct { priority bool // 是否优先级 jwt jwtSetting // jwt配置 signature signatureSetting // 验签配置 routes []Route // 通过AddRoutes增加的路由 }featuredRoutes通过engine的AddRoutes增加到engine的routes属性中
func (s *engine) AddRoutes(r featuredRoutes) { s.routes = append(s.routes, r)}调用Start办法启动服务后会调用engine的Start办法，而后会调用StartWithRouter办法，该办法内通过bindRoutes绑定路由
func (s *engine) bindRoutes(router httpx.Router) error { metrics := s.createMetrics() for _, fr := range s.routes { if err := s.bindFeaturedRoutes(router, fr, metrics); err != nil { // 绑定路由 return err } } return nil}最终会调用patRouter的Handle办法进行绑定，patRouter实现了Router接口
type Router interface { http.Handler Handle(method string, path string, handler http.Handler) error SetNotFoundHandler(handler http.Handler) SetNotAllowedHandler(handler http.Handler)}patRouter中每一种申请办法都对应一个树形构造，每个树节点有两个属性item为path对应的handler，而children为带门路参数和不带门路参数对应的树节点, 定义如下：
node struct { item interface{} children [2]map[string]*node}Tree struct { root *node}通过Tree的Add办法把不同path与对应的handler注册到该树上咱们通过一个图来展现下该树的存储构造，比方咱们定义路由如下
{ Method: http.MethodGet, Path: "/user", Handler: userHander,},{ Method: http.MethodGet, Path: "/user/infos", Handler: infosHandler,},{ Method: http.MethodGet, Path: "/user/info/:id", Handler: infoHandler,},路由存储的树形构造如下图
<img src="https://oscimg.oschina.net/oscnet/up-fc2d96766688c6ce4f652588786cd46021d.png" style="zoom:40%;">
当申请来的时候会调用patRouter的ServeHTTP办法，在该办法中通过tree.Search办法找到对应的handler进行执行，否则会执行notFound或者notAllow的逻辑
func (pr *patRouter) ServeHTTP(w http.ResponseWriter, r *http.Request) { reqPath := path.Clean(r.URL.Path) if tree, ok := pr.trees[r.Method]; ok { if result, ok := tree.Search(reqPath); ok { // 在树中搜寻对应的handler if len(result.Params) > 0 { r = context.WithPathVars(r, result.Params) } result.Item.(http.Handler).ServeHTTP(w, r) return } } allow, ok := pr.methodNotAllowed(r.Method, reqPath) if !ok { pr.handleNotFound(w, r) return } if pr.notAllowed != nil { pr.notAllowed.ServeHTTP(w, r) } else { w.Header().Set(allowHeader, allow) w.WriteHeader(http.StatusMethodNotAllowed) }}总结
本文从整体上介绍了rest，通过该篇文章可能根本理解rest的设计和次要性能，其中中间件局部是重点，外面集成了各种服务治理相干的性能，并且是主动集成的不须要咱们做任何配置，其余性能比方参数主动效验等性能因为篇幅无限在这里就不做介绍了，感兴趣的敌人能够自行查看官网文档进行学习。go-zero中不光有http协定还提供了rpc协定和各种进步性能和开发效率的工具，是一款值得咱们深刻学习和钻研的框架。
我的项目地址
https://github.com/tal-tech/go-zero
如果感觉文章不错，欢送 github 点个 star ????
我的项目地址：
https://github.com/tal-tech/go-zero