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

项目地址：https://github.com/EDDYCJY/go-grpc-example

前言#

接口需要提供给其他业务组访问，但是 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
}

流程#

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

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

3
import (
4
  "context"
5
  "log"
6
  "net/http"
7
  "strings"
8

9
  "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
10
  pb "github.com/EDDYCJY/go-grpc-example/proto"
11

12
  "google.golang.org/grpc"
13
)
14

15
type SearchService struct{}
16

17
func (s *SearchService) Search(ctx context.Context, r *pb.SearchRequest) (*pb.SearchResponse, error) {
18
  return &pb.SearchResponse{Response: r.GetRequest() + " HTTP Server"}, nil
19
}
20

21
const PORT = "9003"
22

23
func main() {
24
  certFile := "../../conf/server/server.pem"
25
  keyFile := "../../conf/server/server.key"
26
  tlsServer := gtls.Server{
27
    CertFile: certFile,
28
    KeyFile:  keyFile,
29
  }
30

31
  c, err := tlsServer.GetTLSCredentials()
32
  if err != nil {
33
    log.Fatalf("tlsServer.GetTLSCredentials err: %v", err)
34
  }
35

36
  mux := GetHTTPServeMux()
37

38
  server := grpc.NewServer(grpc.Creds(c))
39
  pb.RegisterSearchServiceServer(server, &SearchService{})
40

41
  http.ListenAndServeTLS(":"+PORT,
42
    certFile,
43
    keyFile,
44
    http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
45
      if r.ProtoMajor == 2 && strings.Contains(r.Header.Get("Content-Type"), "application/grpc") {
46
        server.ServeHTTP(w, r)
47
      } else {
48
        mux.ServeHTTP(w, r)
49
      }
50

51
      return
52
    }),
53
  )
54
}
55

56
func GetHTTPServeMux() *http.ServeMux {
57
  mux := http.NewServeMux()
58
  mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
59
    w.Write([]byte("eddycjy: go-grpc-example"))
60
  })
61

62
  return mux
63
}

http.NewServeMux：创建一个新的 ServeMux，ServeMux 本质上是一个路由表。它默认实现了 ServeHTTP，因此返回 Handler 后可直接通过 HandleFunc 注册 pattern 和处理逻辑的方法
http.ListenAndServeTLS：可简单的理解为提供监听 HTTPS 服务的方法，重点的协议判断转发，也在这里面

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

Client#

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

1
package main
2

3
import (
4
  "context"
5
  "log"
6

7
  "google.golang.org/grpc"
8

9
  "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
10
  pb "github.com/EDDYCJY/go-grpc-example/proto"
11
)
12

13
const PORT = "9003"
14

15
func main() {
16
  tlsClient := gtls.Client{
17
    ServerName: "go-grpc-example",
18
    CertFile:   "../../conf/server/server.pem",
19
  }
20
  c, err := tlsClient.GetTLSCredentials()
21
  if err != nil {
22
    log.Fatalf("tlsClient.GetTLSCredentials err: %v", err)
23
  }
24

25
  conn, err := grpc.Dial(":"+PORT, grpc.WithTransportCredentials(c))
26
  if err != nil {
27
    log.Fatalf("grpc.Dial err: %v", err)
28
  }
29
  defer conn.Close()
30

31
  client := pb.NewSearchServiceClient(conn)
32
  resp, err := client.Search(context.Background(), &pb.SearchRequest{
33
    Request: "gRPC",
34
  })
35
  if err != nil {
36
    log.Fatalf("client.Search err: %v", err)
37
  }
38

39
  log.Printf("resp: %s", resp.GetResponse())
40
}

验证#

gRPC Client#

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

HTTP/1.1 访问#

总结#

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

拓展#

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

问题#

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

参考#

本系列示例代码#

go-grpc-example