让你的服务同时提供 HTTP 接口

前言

  • 接口需要提供给其他业务组访问,但是 RPC 协议不同无法内调,对方问能否走 HTTP 接口,怎么办?

  • 微信(公众号、小程序)等第三方回调接口只支持 HTTP 接口,怎么办

我相信你在实际工作中都会遇到如上问题,在 gRPC 中都是有解决方案的,本章节将会进行介绍 🤔

为什么可以同时提供 HTTP 接口

关键一点,gRPC 的协议是基于 HTTP/2 的,因此应用程序能够在单个 TCP 端口上提供 HTTP/1.1 和 gRPC 接口服务(两种不同的流量)

怎么同时提供 HTTP 接口

检测协议

  1. if r.ProtoMajor == 2 && strings.Contains(r.Header.Get("Content-Type"), "application/grpc") {
  2. server.ServeHTTP(w, r)
  3. } else {
  4. mux.ServeHTTP(w, r)
  5. }

流程

  1. 检测请求协议是否为 HTTP/2
  2. 判断 Content-Type 是否为 application/grpc(gRPC 的默认标识位)
  3. 根据协议的不同转发到不同的服务处理

gRPC

TLS

在前面的章节,为了便于展示因此没有简单封装

在本节需复用代码,重新封装了,可详见:go-grpc-example

目录结构

新建 simple_http_client、simple_http_server 目录,目录结构如下:

  1. go-grpc-example
  2. ├── client
  3. │ ├── simple_client
  4. │ ├── simple_http_client
  5. │ └── stream_client
  6. ├── conf
  7. ├── pkg
  8. │ └── gtls
  9. ├── proto
  10. ├── server
  11. │ ├── simple_http_server
  12. │ ├── simple_server
  13. │ └── stream_server

Server

在 simple_http_server 目录下新建 server.go,写入文件内容:

  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "net/http"
  6. "strings"
  7. "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
  8. pb "github.com/EDDYCJY/go-grpc-example/proto"
  9. "google.golang.org/grpc"
  10. )
  11. type SearchService struct{}
  12. func (s *SearchService) Search(ctx context.Context, r *pb.SearchRequest) (*pb.SearchResponse, error) {
  13. return &pb.SearchResponse{Response: r.GetRequest() + " HTTP Server"}, nil
  14. }
  15. const PORT = "9003"
  16. func main() {
  17. certFile := "../../conf/server/server.pem"
  18. keyFile := "../../conf/server/server.key"
  19. tlsServer := gtls.Server{
  20. CertFile: certFile,
  21. KeyFile: keyFile,
  22. }
  23. c, err := tlsServer.GetTLSCredentials()
  24. if err != nil {
  25. log.Fatalf("tlsServer.GetTLSCredentials err: %v", err)
  26. }
  27. mux := GetHTTPServeMux()
  28. server := grpc.NewServer(grpc.Creds(c))
  29. pb.RegisterSearchServiceServer(server, &SearchService{})
  30. http.ListenAndServeTLS(":"+PORT,
  31. certFile,
  32. keyFile,
  33. http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  34. if r.ProtoMajor == 2 && strings.Contains(r.Header.Get("Content-Type"), "application/grpc") {
  35. server.ServeHTTP(w, r)
  36. } else {
  37. mux.ServeHTTP(w, r)
  38. }
  39. return
  40. }),
  41. )
  42. }
  43. func GetHTTPServeMux() *http.ServeMux {
  44. mux := http.NewServeMux()
  45. mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
  46. w.Write([]byte("eddycjy: go-grpc-example"))
  47. })
  48. return mux
  49. }
  • http.NewServeMux:创建一个新的 ServeMux,ServeMux 本质上是一个路由表。它默认实现了 ServeHTTP,因此返回 Handler 后可直接通过 HandleFunc 注册 pattern 和处理逻辑的方法
  • http.ListenAndServeTLS:可简单的理解为提供监听 HTTPS 服务的方法,重点的协议判断转发,也在这里面

其实,你理解后就会觉得很简单,核心步骤:判断 -> 转发 -> 响应。我们改变了前两步的默认逻辑,仅此而已

Client

在 simple_http_server 目录下新建 client.go,写入文件内容:

  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "google.golang.org/grpc"
  6. "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
  7. pb "github.com/EDDYCJY/go-grpc-example/proto"
  8. )
  9. const PORT = "9003"
  10. func main() {
  11. tlsClient := gtls.Client{
  12. ServerName: "go-grpc-example",
  13. CertFile: "../../conf/server/server.pem",
  14. }
  15. c, err := tlsClient.GetTLSCredentials()
  16. if err != nil {
  17. log.Fatalf("tlsClient.GetTLSCredentials err: %v", err)
  18. }
  19. conn, err := grpc.Dial(":"+PORT, grpc.WithTransportCredentials(c))
  20. if err != nil {
  21. log.Fatalf("grpc.Dial err: %v", err)
  22. }
  23. defer conn.Close()
  24. client := pb.NewSearchServiceClient(conn)
  25. resp, err := client.Search(context.Background(), &pb.SearchRequest{
  26. Request: "gRPC",
  27. })
  28. if err != nil {
  29. log.Fatalf("client.Search err: %v", err)
  30. }
  31. log.Printf("resp: %s", resp.GetResponse())
  32. }

验证

gRPC Client

  1. $ go run client.go
  2. 2018/10/04 14:56:56 resp: gRPC HTTP Server

HTTP/1.1 访问

image

总结

通过本章节,表面上完成了同端口提供双服务的功能,但实际上,应该是加深了 HTTP/2 的理解和使用,这才是本质

拓展

如果你有一个需求,是要同时提供 RPC 和 RESTful JSON API 两种接口的,不要犹豫,点进去:gRPC + gRPC Gateway 实践

问题

你以为这个方案就万能了吗,不。Envoy Proxy 的支持就不完美,无法同时监听一个端口的两种流量 😤

参考

本系列示例代码