中间件使用

在上一节，我们演示了怎么使用jwt鉴权，相信你已经掌握了对jwt的基本使用，本节我们来看一下api服务中间件怎么使用。

中间件分类

在go-zero中，中间件可以分为路由中间件和全局中间件，路由中间件是指某一些特定路由需要实现中间件逻辑，其和jwt类似，没有放在jwt:xxx下的路由不会使用中间件功能， 而全局中间件的服务范围则是整个服务。

中间件使用

这里以search服务为例来演示中间件的使用

路由中间件

  • 重新编写search.api文件，添加middleware声明
    1.   $ cd service/search/cmd/api
    2.   $ vim search.api
    1.   @server(
    2.       jwt: Auth
    3.       middleware: Example // 路由中间件声明
    4.   )
    5.   service search-api {
    6.       @handler search
    7.       get /search/do (SearchReq) returns (SearchReply)
    8.   }
  • 重新生成api代码
    1.   $ goctl api go -api search.api -dir .
    1.   etc/search-api.yaml exists, ignored generation
    2.   internal/config/config.go exists, ignored generation
    3.   search.go exists, ignored generation
    4.   internal/svc/servicecontext.go exists, ignored generation
    5.   internal/handler/searchhandler.go exists, ignored generation
    6.   internal/handler/pinghandler.go exists, ignored generation
    7.   internal/logic/searchlogic.go exists, ignored generation
    8.   internal/logic/pinglogic.go exists, ignored generation
    9.   Done.
    生成完后会在internal目录下多一个middleware的目录，这里即中间件文件，后续中间件的实现逻辑也在这里编写。

  • 完善资源依赖ServiceContext

    1.  $ vim service/search/cmd/api/internal/svc/servicecontext.go
    1.  type ServiceContext struct {
    2.      Config config.Config
    3.      Example rest.Middleware
    4.  }
    6.  func NewServiceContext(c config.Config) *ServiceContext {
    7.      return &ServiceContext{
    8.          Config: c,
    9.          Example: middleware.NewExampleMiddleware().Handle,
    10.      }
    11.  }

  • 编写中间件逻辑 这里仅添加一行日志，内容example middle，如果服务运行输出example middle则代表中间件使用起来了。

    1.   $ vim service/search/cmd/api/internal/middleware/examplemiddleware.go
    1.   func (m *ExampleMiddleware) Handle(next http.HandlerFunc) http.HandlerFunc {
    2.       return func(w http.ResponseWriter, r *http.Request) {
    3.           logx.Info("example middle")
    4.           next(w, r)
    5.       }
    6.   }
  • 启动服务验证
    1.   {"@timestamp":"2021-02-09T11:32:57.931+08","level":"info","content":"example middle"}

全局中间件

通过rest.Server提供的Use方法即可

  1. func main() {
  2.     flag.Parse()
  4.     var c config.Config
  5.     conf.MustLoad(*configFile, &c)
  7.     ctx := svc.NewServiceContext(c)
  8.     server := rest.MustNewServer(c.RestConf)
  9.     defer server.Stop()
  11.     // 全局中间件
  12.     server.Use(func(next http.HandlerFunc) http.HandlerFunc {
  13.         return func(w http.ResponseWriter, r *http.Request) {
  14.             logx.Info("global middleware")
  15.             next(w, r)
  16.         }
  17.     })
  18.     handler.RegisterHandlers(server, ctx)
  20.     fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
  21.     server.Start()
  22. }
  1. {"@timestamp":"2021-02-09T11:50:15.388+08","level":"info","content":"global middleware"}