原文地址:带入gRPC:Unary and Stream interceptor
项目地址:https://github.com/EDDYCJY/go...html
我想在每一个 RPC 方法的前或后作某些事情,怎么作?git
本章节将要介绍的拦截器(interceptor),就能帮你在合适的地方实现这些功能 🤫github
在 gRPC 中,大类可分为两种 RPC 方法,与拦截器的对应关系是:golang
func UnaryInterceptor(i UnaryServerInterceptor) ServerOption { return func(o *options) { if o.unaryInt != nil { panic("The unary server interceptor was already set and may not be reset.") } o.unaryInt = i } }
type UnaryServerInterceptor func(ctx context.Context, req interface{}, info *UnaryServerInfo, handler UnaryHandler) (resp interface{}, err error)
经过查看源码可得知,要完成一个拦截器须要实现 UnaryServerInterceptor
方法。形参以下:segmentfault
func StreamInterceptor(i StreamServerInterceptor) ServerOption
type StreamServerInterceptor func(srv interface{}, ss ServerStream, info *StreamServerInfo, handler StreamHandler) error
StreamServerInterceptor 与 UnaryServerInterceptor 形参的意义是同样,再也不赘述tcp
另外,能够发现 gRPC 自己竟然只能设置一个拦截器,难道全部的逻辑都只能写在一块儿?google
关于这一点,你能够放心。采用开源项目 go-grpc-middleware 就能够解决这个问题,本章也会使用它 😄debug
import "github.com/grpc-ecosystem/go-grpc-middleware" myServer := grpc.NewServer( grpc.StreamInterceptor(grpc_middleware.ChainStreamServer( ... )), grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer( ... )), )
从本节开始编写 gRPC interceptor 的代码,咱们会将实现如下拦截器:3d
func LoggingInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) { log.Printf("gRPC method: %s, %v", info.FullMethod, req) resp, err := handler(ctx, req) log.Printf("gRPC method: %s, %v", info.FullMethod, resp) return resp, err }
func RecoveryInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) { defer func() { if e := recover(); e != nil { debug.PrintStack() err = status.Errorf(codes.Internal, "Panic err: %v", e) } }() return handler(ctx, req) }
import ( "context" "crypto/tls" "crypto/x509" "errors" "io/ioutil" "log" "net" "runtime/debug" "google.golang.org/grpc" "google.golang.org/grpc/credentials" "google.golang.org/grpc/status" "google.golang.org/grpc/codes" "github.com/grpc-ecosystem/go-grpc-middleware" pb "github.com/EDDYCJY/go-grpc-example/proto" ) ... func main() { c, err := GetTLSCredentialsByCA() if err != nil { log.Fatalf("GetTLSCredentialsByCA err: %v", err) } opts := []grpc.ServerOption{ grpc.Creds(c), grpc_middleware.WithUnaryServerChain( RecoveryInterceptor, LoggingInterceptor, ), } server := grpc.NewServer(opts...) pb.RegisterSearchServiceServer(server, &SearchService{}) lis, err := net.Listen("tcp", ":"+PORT) if err != nil { log.Fatalf("net.Listen err: %v", err) } server.Serve(lis) }
启动 simple_server/server.go,执行 simple_client/client.go 发起请求,获得结果:日志
$ go run server.go 2018/10/02 13:46:35 gRPC method: /proto.SearchService/Search, request:"gRPC" 2018/10/02 13:46:35 gRPC method: /proto.SearchService/Search, response:"gRPC Server"
在 RPC 方法中人为地制造运行时错误,再重复启动 server/client.go,获得结果:
$ go run client.go 2018/10/02 13:19:03 client.Search err: rpc error: code = Internal desc = Panic err: assignment to entry in nil map exit status 1
$ go run server.go goroutine 23 [running]: runtime/debug.Stack(0xc420223588, 0x1033da9, 0xc420001980) /usr/local/Cellar/go/1.10.1/libexec/src/runtime/debug/stack.go:24 +0xa7 runtime/debug.PrintStack() /usr/local/Cellar/go/1.10.1/libexec/src/runtime/debug/stack.go:16 +0x22 main.RecoveryInterceptor.func1(0xc420223a10) ...
检查服务是否仍然运行,便可知道 Recovery 是否成功生效
经过本章节,你能够学会最多见的拦截器使用方法。接下来其它“新”需求只要触类旁通便可 😈