gRPC-Gateway helps you to provide your APIs in both gRPC and RESTful style at the same time.
官方网站：https://github.com/grpc-ecosystem/grpc-gateway
官方文档：https://grpc-ecosystem.github.io/grpc-gateway/

image.png

配置插件

下载

  1. $ go get github.com/grpc-ecosystem/grpc-gateway
  2. go: downloading github.com/grpc-ecosystem/grpc-gateway v1.16.0
  3. go: github.com/grpc-ecosystem/grpc-gateway upgrade => v1.16.0

进入

  1. cd $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v1.16.0/protoc-gen-grpc-gateway
  2. $ go install

proto

  1. syntax = "proto3";
  3. package user;
  5. //引入google api实现http转rpc
  6. import "google/api/annotations.proto";
  9. message UserRequest{
  10.   // [修饰符] 类型 字段名 = 标识符
  11.   string name = 1;
  12. }
  14. message UserResponse{
  15.   int32 id = 1;
  16.   string name = 2;
  17.   int32 age = 3;
  18.   repeated string title = 4; // 可变数组，即 slice 类型
  19. }
  21. service userInfoService {
  22.   rpc GetUserInfo(UserRequest) returns (UserResponse){
  23.     option (google.api.http) = {
  24.       post: "/v1/userInfo"
  25.       body: "*"
  26.     };
  27.   }
  28. }

执行

  1. protoc  -I/usr/local/include -I. \
  2. -I$GOPATH/src \
  3. -I$GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway\@v1.16.0/third_party/googleapis/ \
  4. --go_out=plugins=grpc:. \
  5. proto/user.proto

生成pb代理文件

  1. protoc -I/usr/local/include -I. \
  2.   -I$GOPATH/src \
  3.   -I$GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway\@v1.16.0/third_party/googleapis/ \
  4.   --grpc-gateway_out=logtostderr=true:. \
  5.   proto/user.proto

图片.png

user 服务代码

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "google.golang.org/grpc"
  7.     proto "github.com/baxiang/go-note/grpc_gateway_service/proto"
  8.     "log"
  9.     "net"
  10. )
  12. //定义服务端 实现 约定的接口
  13. type UserInfoService struct{}
  15. //实现 interface
  16. func (s *UserInfoService) GetUserInfo(ctx context.Context, req *proto.UserRequest) (resp *proto.UserResponse, err error) {
  17.     resp = &proto.UserResponse{
  18.         Id:    1,
  19.         Name:  req.Name,
  20.         Age:   25,
  21.         Title: []string{"Java", "Go"},
  22.     }
  24.     return
  25. }
  27. func main() {
  28.     port := ":6666"
  29.     l, err := net.Listen("tcp", port)
  30.     if err != nil {
  31.         log.Fatalf("listen error: %v\n", err)
  32.     }
  34.     fmt.Printf("listen %s\n", port)
  36.     s := grpc.NewServer()
  37.     // 将 UserInfoService 注册到 gRPC
  38.     // 注意第二个参数 UserInfoServiceServer 是接口类型的变量
  39.     // 需要取地址传参
  40.     proto.RegisterUserInfoServiceServer(s, &UserInfoService{})
  41.     s.Serve(l)
  42. }

执行服务

  1.  go run cmd/server/server.go

网关代码

  1. package main
  3. import (
  4.     "context"
  5.     "github.com/grpc-ecosystem/grpc-gateway/runtime"
  6.     "google.golang.org/grpc"
  7.     "log"
  8.     //多个服务引入多个包
  9.     proto "github.com/baxiang/go-note/grpc_gateway_service/proto"
  10.     "net/http"
  11. )
  13. var userPoint = "localhost:6666"
  15. func main() {
  16.     ctx, cancel := context.WithCancel(context.Background())
  17.     defer cancel()
  19.     // Register gRPC server endpoint
  20.     // Note: Make sure the gRPC server is running properly and accessible
  21.     mux := runtime.NewServeMux()
  22.     //多个服务注册多次即可
  23.     err := proto.RegisterUserInfoServiceHandlerFromEndpoint(ctx, mux, userPoint, []grpc.DialOption{grpc.WithInsecure()})
  24.     if err != nil {
  25.         log.Fatal(err)
  26.     }
  27.     // Start HTTP server (and proxy calls to gRPC server endpoint)
  28.     log.Fatal(http.ListenAndServe(":8081", mux))
  29. }

执行网关

  1. go run cmd/gateway/gateway.go

测试

  1. curl -H "Content-Type:application/json" -X POST --data '{"name":"test"}' http://127.0.0.1:8081/v1/userInfo

参考

https://blog.csdn.net/NikoKVCS/article/details/94568057
https://blog.csdn.net/zoeou/article/details/107593875