概览

Kratos 内置了一系列的 middleware（中间件）用于处理 logging、 metrics 等通用场景。您也可以通过实现 Middleware 接口，开发自定义 middleware，进行通用的业务处理，比如用户登录鉴权等。

内置中间件

相关代码均可以在 middleware 目录下找到。

  • logging: 用于请求日志的记录。
  • metrics: 用于启用 metric。
  • recovery: 用于 recovery panic。
  • tracing: 用于启用 trace。
  • validate: 用于处理参数校验。
  • metadata: 用于启用元信息传递。
  • auth: 用于提供基于 JWT 的认证请求。
  • ratelimit: 用于服务端流量限制。
  • circuitbreaker: 用于客户端熔断控制。

生效顺序

一个请求进入时的处理顺序为 Middleware 注册的顺序，而响应返回的处理顺序为注册顺序的倒序，即先进后出(FILO)。

  1.          ┌───────────────────┐
  2.          │MIDDLEWARE 1       │
  3.          │ ┌────────────────┐│
  4.          │ │MIDDLEWARE 2    ││
  5.          │ │ ┌─────────────┐││
  6.          │ │ │MIDDLEWARE 3 │││
  7.          │ │ │ ┌─────────┐ │││
  8. REQUEST  │ │ │ │  YOUR   │ │││  RESPONSE
  9.    ──────┼─┼─┼─▷ HANDLER ○─┼┼┼───▷
  10.          │ │ │ └─────────┘ │││
  11.          │ │ └─────────────┘││
  12.          │ └────────────────┘│
  13.          └───────────────────┘

使用中间件

在 NewGRPCServer 和 NewHTTPServer 中通过 ServerOption 进行注册。

例如：

  1. // http
  2. // 定义opts
  3. var opts = []http.ServerOption{
  4.     http.Middleware(
  5.         recovery.Recovery(), // 把middleware按照需要的顺序加入
  6.         tracing.Server(),
  7.         logging.Server(),
  8.     ),
  9. }
  11. // 创建server
  12. http.NewServer(opts...)
  14. //grpc
  15. var opts = []grpc.ServerOption{
  16.     grpc.Middleware(
  17.         recovery.Recovery(),  // 把middleware按照需要的顺序加入
  18.         tracing.Server(),
  19.         logging.Server(),
  20.     ),
  21. }
  23. // 创建server
  24. grpc.NewServer(opts...)

自定义中间件

需要实现 Middleware 接口。

中间件中您可以使用 tr, ok := transport.FromServerContext(ctx) 获得 Transporter 实例以便访问接口相关的元信息。

基本的代码模板：

  1. import (
  2.     "context"
  4.     "github.com/go-kratos/kratos/v2/middleware"
  5.     "github.com/go-kratos/kratos/v2/transport"
  6. )
  8. func Middleware1() middleware.Middleware {
  9.     return func(handler middleware.Handler) middleware.Handler {
  10.         return func(ctx context.Context, req interface{}) (reply interface{}, err error) {
  11.             if tr, ok := transport.FromServerContext(ctx); ok {
  12.                 // Do something on entering
  13.                 defer func() {
  14.                 // Do something on exiting
  15.                  }()
  16.             }
  17.             return handler(ctx, req)
  18.         }
  19.     }
  20. }

定制中间件

对特定路由定制中间件：

  • server: selector.Server(ms...)
  • client: selector.Client(ms...)

匹配规则(多参数)：

  • Path(path...): 路由匹配
  • Regex(regex...): 正则匹配
  • Prefix(prefix...): 前缀匹配
  • Match(fn): 函数匹配，函数格式为func(ctx context.Context,operation string) bool。 operation为 path，函数返回值为true，匹配成功，ctx可使用transport.FromServerContext(ctx) 或者 transport.FromClientContext(ctx获取 Transporter)。

http server

  1. import "github.com/go-kratos/kratos/v2/middleware/selector"
  3. http.Middleware(
  4.             selector.Server(recovery.Recovery(), tracing.Server(),testMiddleware).
  5.                 Path("/hello.Update/UpdateUser", "/hello.kratos/SayHello").
  6.                 Regex(`/test.hello/Get[0-9]+`).
  7.                 Prefix("/kratos.", "/go-kratos.", "/helloworld.Greeter/").
  8.                 Build(),
  9.         )

http client

  1. import "github.com/go-kratos/kratos/v2/middleware/selector"
  3. http.WithMiddleware(
  4.             selector.Client(recovery.Recovery(), tracing.Server(),testMiddleware).
  5.                 Path("/hello.Update/UpdateUser", "/hello.kratos/SayHello").
  6.                 Regex(`/test.hello/Get[0-9]+`).
  7.                 Prefix("/kratos.", "/go-kratos.", "/helloworld.Greeter/").
  8.                 Match(func(ctx context.Context,operation string) bool {
  9.                     if strings.HasPrefix(operation, "/go-kratos.dev") || strings.HasSuffix(operation, "world") {
  10.                         return true
  11.                     }
  12.                     tr, ok := transport.FromClientContext(ctx)
  13.                     if !ok {
  14.                         return false
  15.                     }
  16.                     if tr.RequestHeader().Get("go-kratos") == "kratos" {
  17.                         return true
  18.                     }
  19.                     return false
  20.                 }).Build(),
  21.         )

grpc server

  1. import "github.com/go-kratos/kratos/v2/middleware/selector"
  3. grpc.Middleware(
  4.             selector.Server(recovery.Recovery(), tracing.Server(),testMiddleware).
  5.                 Path("/hello.Update/UpdateUser", "/hello.kratos/SayHello").
  6.                 Regex(`/test.hello/Get[0-9]+`).
  7.                 Prefix("/kratos.", "/go-kratos.", "/helloworld.Greeter/").
  8.                 Build(),
  9.         )

grpc client

  1. import "github.com/go-kratos/kratos/v2/middleware/selector"
  3. grpc.Middleware(
  4.             selector.Client(recovery.Recovery(), tracing.Server(),testMiddleware).
  5.                 Path("/hello.Update/UpdateUser", "/hello.kratos/SayHello").
  6.                 Regex(`/test.hello/Get[0-9]+`).
  7.                 Prefix("/kratos.", "/go-kratos.", "/helloworld.Greeter/").
  8.                 Build(),
  9.         )

注意: 定制中间件是通过 operation 匹配，并不是 http 本身的路由！！！

operation 是 HTTP 及 gRPC 统一的 gRPC path。

operation 查找

gRPC path 的拼接规则为 /包名.服务名/方法名(/package.Service/Method)。

比如在如下 proto 文件中，我们要调用 SayHello 这个方法，那么 operation 就为 /helloworld.Greeter/SayHello。

  1. syntax = "proto3";
  3. package helloworld;
  5. import "google/api/annotations.proto";
  7. option go_package = "github.com/go-kratos/examples/helloworld/helloworld";
  9. // The greeting service definition.
  10. service Greeter {
  11.   // Sends a greeting
  12.   rpc SayHello (HelloRequest) returns (HelloReply)  {
  13.         option (google.api.http) = {
  14.             get: "/helloworld/{name}",
  15.         };
  16.   }
  17. }
  18. // The request message containing the user's name.
  19. message HelloRequest {
  20.   string name = 1;
  21. }
  23. // The response message containing the greetings
  24. message HelloReply {
  25.   string message = 1;
  26. }