如果一个应用需要同时对外提供 HTTP 和 gRPC 服务,通常情况下我们会为两个服务绑定不同的监听端口,而本文要介绍的 cmux 为我们提供了一种连接多路复用的新选择,使用 cmux 可以将不同服务绑定在同一个网络端口上!

简介

多路复用是个很常见的概念,我们在编写 HTTP 服务时通常会用 http.ServeMux 或类似的三方工具实现请求与 handler 的匹配和绑定,这类多路复用一般作用在某个服务内部。而 cmux(github.com/soheilhy/cmux) 则提供了基于请求内容对连接进行多路复用的能力,使用 cmux 我们可以在同一个 TCP 监听(端口)上提供包括 gRPC、SSH、HTTPS、HTTP、Go RPC 在内的几乎任何协议。

cmux 通过扩展 net.Listener 的方式实现了连接多路复用能力,在接收到客户端请求后,cmux 会根据注册的规则对客户端请求进行鉴别和匹配,并根据匹配结果将请求转发给相应的服务。

使用举例

cmux 的使用特别简单,我们只需要为每个服务指定相应的匹配规则即可:

  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "net"
  6. "net/http"
  7. "google.golang.org/grpc"
  8. pb "google.golang.org/grpc/examples/helloworld/helloworld"
  9. "github.com/soheilhy/cmux"
  10. )
  11. func main() {
  12. lis, err := net.Listen("tcp", "localhost:50051")
  13. if err != nil {
  14. log.Fatalf("failed to listen: %v", err)
  15. }
  16. mux := cmux.New(lis)
  17. // gRPC 匹配规则
  18. grpcL := mux.MatchWithWriters(
  19. cmux.HTTP2MatchHeaderFieldSendSettings("content-type", "application/grpc"),
  20. )
  21. // otherwise serve http
  22. httpL := mux.Match(cmux.Any())
  23. // gRPC server
  24. grpcS := grpc.NewServer()
  25. pb.RegisterGreeterServer(grpcS, &server{})
  26. // HTTP server
  27. httpS := &http.Server{
  28. Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  29. w.Write([]byte("greet from HTTP\n"))
  30. }),
  31. }
  32. // start serving!
  33. go grpcS.Serve(grpcL)
  34. go httpS.Serve(httpL)
  35. log.Printf("serve both grpc and http at %v", lis.Addr())
  36. if err := mux.Serve(); err != nil {
  37. log.Fatalf("failed to serve: %v", err)
  38. }
  39. }
  40. type server struct {
  41. pb.UnimplementedGreeterServer
  42. }
  43. func (server) SayHello(ctx context.Context, in pb.HelloRequest) (*pb.HelloReply, error) {
  44. return &pb.HelloReply{Message: "greet from gRPC"}, nil
  45. }

先来试试 http 访问是否正常

  1. $ curl -D - http://localhost:50051
  2. HTTP/1.1 200 OK
  3. Date: Mon, 21 Mar 2022 08:20:15 GMT
  4. Content-Length: 16
  5. Content-Type: text/plain; charset=utf-8
  6. greet from HTTP

再来试试 gRPC 访问:
image.png

  1. $ ${GOPATH}/bin/greeter_client -addr localhost:50051
  2. 2022/03/21 16:12:11 Greeting: greet from gRPC

测试客户端安装:go install google.golang.org/grpc/examples/helloworld/greeter_client

如上,我们通过 50051 这个端口同时承载了 HTTP 和 gRPC 两个服务,是不是特别神奇!

总结

使用 cmux 我们可以轻松实现对服务端连接的多路复用,cmux 仅会在连接建立之初读取少量请求样本进行路由匹配,因此在客户端长连接场景下的性能损失几乎可以忽略不计。大家来试试吧!

参考资料