GRPC 网关

本篇主要帮助大家在go-micro服务中使用grpc网关。

GRPC网关grpc-gateway是protoc的一个插件。它遵循gRPC中的服务定义，生成反向代理服务，这个代理就会把RESTful风格的JSON API转成gRPC请求。

我们使用go-grpc写后台服务。Go-GRPC是客户端与服务端的go-micro、grpc插件包装器。当调用grpc.NewService时，它会返回micro.Service服务。

代码

可以在examples/grpc中查找相关代码。

预置条件

我们需要下面准备工作：

安装protobuf

  1. mkdir tmp
  2. cd tmp
  3. git clone https://github.com/google/protobuf
  4. cd protobuf
  5. ./autogen.sh
  6. ./configure
  7. make
  8. make check
  9. sudo make install

安装插件

  1. go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
  2. go get -u github.com/micro/protobuf/protoc-gen-go

Greeter Service

例子中我们使用go-grpc创建了简单的greeter微服务。

下面的proto文件的代码：

  1. syntax = "proto3";
  3. package go.micro.srv.greeter;
  5. service Say {
  6.     rpc Hello(Request) returns (Response) {}
  7. }
  9. message Request {
  10.     string name = 1;
  11. }
  13. message Response {
  14.     string msg = 1;
  15. }

服务的Go代码：

  1. package main
  3. import (
  4.     "log"
  5.     "time"
  7.     hello "github.com/micro/examples/greeter/srv/proto/hello"
  8.     "github.com/micro/go-grpc"
  9.     "github.com/micro/go-micro"
  11.     "golang.org/x/net/context"
  12. )
  14. type Say struct{}
  16. func (s *Say) Hello(ctx context.Context, req *hello.Request, rsp *hello.Response) error {
  17.     log.Print("Received Say.Hello request")
  18.     rsp.Msg = "Hello " + req.Name
  19.     return nil
  20. }
  22. func main() {
  23.     service := grpc.NewService(
  24.         micro.Name("go.micro.srv.greeter"),
  25.         micro.RegisterTTL(time.Second*30),
  26.         micro.RegisterInterval(time.Second*10),
  27.     )
  29.     // optionally setup command line usage
  30.     service.Init()
  32.     // Register Handlers
  33.     hello.RegisterSayHandler(service.Server(), new(Say))
  35.     // Run server
  36.     if err := service.Run(); err != nil {
  37.         log.Fatal(err)
  38.     }
  39. }

GRPC Gateway

GRPC网关使用相同的proto文件配上http选项提供服务

  1. syntax = "proto3";
  3. package greeter;
  5. import "google/api/annotations.proto";
  7. service Say {
  8.     rpc Hello(Request) returns (Response) {
  9.         option (google.api.http) = {
  10.             post: "/greeter/hello"
  11.             body: "*"
  12.         };
  13.     }
  14. }
  16. message Request {
  17.     string name = 1;
  18. }
  20. message Response {
  21.     string msg = 1;
  22. }

通过下面的proto命令生成grpc的存根和反向代理

  1. protoc -I/usr/local/include -I. \
  2.   -I$GOPATH/src \
  3.   -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
  4.   --go_out=plugins=grpc:. \
  5.   path/to/your_service.proto
  1. protoc -I/usr/local/include -I. \
  2.   -I$GOPATH/src \
  3.   -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
  4.   --grpc-gateway_out=logtostderr=true:. \
  5.   path/to/your_service.proto

在下面的代码中我们写了一个简单的问候（greeter）服务API。类似的代码也会用来注册其它的端点。切记，网关需要端点地址及服务。

  2. package main
  4. import (
  5.     "flag"
  6.     "net/http"
  8.     "github.com/golang/glog"
  9.     "github.com/grpc-ecosystem/grpc-gateway/runtime"
  10.     "golang.org/x/net/context"
  11.     "google.golang.org/grpc"
  13.     hello "github.com/micro/examples/grpc/gateway/proto/hello"
  14. )
  16. var (
  17.     // the go.micro.srv.greeter address
  18.     endpoint = flag.String("endpoint", "localhost:9090", "go.micro.srv.greeter address")
  19. )
  21. func run() error {
  22.     ctx := context.Background()
  23.     ctx, cancel := context.WithCancel(ctx)
  24.     defer cancel()
  26.     mux := runtime.NewServeMux()
  27.     opts := []grpc.DialOption{grpc.WithInsecure()}
  29.     err := hello.RegisterSayHandlerFromEndpoint(ctx, mux, *endpoint, opts)
  30.     if err != nil {
  31.         return err
  32.     }
  34.     return http.ListenAndServe(":8080", mux)
  35. }
  37. func main() {
  38.     flag.Parse()
  40.     defer glog.Flush()
  42.     if err := run(); err != nil {
  43.         glog.Fatal(err)
  44.     }
  45. }

运行示例

现在运行greeter服务，指定mdns参数，因为现在我们还没有注册中心。

  1. go run examples/grpc/greeter/srv/main.go --registry=mdns --server_address=localhost:9090

运行网关程序，把greeter服务所有端点都放在localhost:9090下

  1. go run examples/grpc/gateway/main.go

用Curl命令请求网关

  1. curl -d '{"name": "john"}' http://localhost:8080/greeter/hello

局限性

我们需要向gRPC网关提供使用了服务发现、动态路由、负载均衡的后台micro api服务所在的地址。这降低了集成网关的通用性。

参考github.com/micro/micro了解更多。