Go語言初探gRPC服務

原文鏈接：https://www.jianshu.com/p/20ed82218163

環境：2018-05-12 protoc 3.5.1 go1.10.1 windows
gRPC: Google主導開發的RPC框架，這裏不再贅述。

準備工作

先安裝Protobuf 編譯器 protoc，下載地址：https://github.com/google/protobuf/releases
我的是windows，將壓縮包bin目錄下的exe放到環境PATH目錄中即可。

然後獲取插件支持庫

  // gRPC運行時接口編解碼支持庫
  go get -u github.com/golang/protobuf/proto
  // 從 Proto文件(gRPC接口描述文件) 生成 go文件 的編譯器插件
  go get -u github.com/golang/protobuf/protoc-gen-go

獲取go的gRPC包(網絡問題可參閱https://www.jianshu.com/p/6392cb9dc38f)

  go get google.golang.org/grpc

接口文件 /src/

新建test.proto示例：

  syntax = "proto3";
  // 定義包名
  package test;
  
  // 可以定義多個服務，每個服務內可以定義多個接口
  service Waiter {
    // 定義接口 (結構體可以複用)
    // 方法 (請求消息結構體) returns (返回消息結構體) {}
    rpc DoMD5 (Req) returns (Res) {}
  }

  // 定義 Req 消息結構
  message Req {
    // 類型 字段 = 標識號
    string jsonStr = 1;
  }

  // 定義 Res 消息結構
  message Res {
    string backJson = 1;
  }
// PS：jsonStr和backJson只是隨手寫的名字，並沒有用json

proto文件語法詳解參閱：https://blog.csdn.net/u014308482/article/details/52958148

然後將proto文件編譯爲go文件

  // protoc --go_out=plugins=grpc:{輸出目錄}  {proto文件}
  protoc --go_out=plugins=grpc:./test/ ./test.proto

注意：原則上不要修改編譯出來的*.bp.go文件的代碼，因爲雙方接口基於同一個proto文件編譯成自己的語言源碼，此文件只作爲接口數據處理，業務具體實現不在*.bp.go中。

服務端 /src/server/

本人也是剛接觸Go，基於https://github.com/freewebsys/grpc-go-demo的Demo在修改中理解gRPC
其中中文註釋均爲個人理解筆記，若有不嚴謹的地方，還望指正。

    package main
    import (
        "log"
        "net"
        "golang.org/x/net/context"
        "google.golang.org/grpc"
        "test"
        "google.golang.org/grpc/reflection"
        "fmt"
        "crypto/md5"
    )

    // 業務實現方法的容器
    type server struct{}

    // 爲server定義 DoMD5 方法 內部處理請求並返回結果
    // 參數 (context.Context[固定], *test.Req[相應接口定義的請求參數])
    // 返回 (*test.Res[相應接口定義的返回參數，必須用指針], error)
    func (s *server) DoMD5(ctx context.Context, in *test.Req) (*test.Res, error) {
        fmt.Println("MD5方法請求JSON:"+in.JsonStr)
        return &test.Res{BackJson: "MD5 :" + fmt.Sprintf("%x", md5.Sum([]byte(in.JsonStr)))}, nil
    }

    func main() {
        lis, err := net.Listen("tcp", ":8028")  //監聽所有網卡8028端口的TCP連接
        if err != nil {
            log.Fatalf("監聽失敗: %v", err)
        }
        s := grpc.NewServer() //創建gRPC服務

        /**註冊接口服務
         * 以定義proto時的service爲單位註冊，服務中可以有多個方法
         * (proto編譯時會爲每個service生成Register***Server方法)
         * 包.註冊服務方法(gRpc服務實例，包含接口方法的結構體[指針])
         */
        test.RegisterWaiterServer(s, &server{})
        /**如果有可以註冊多個接口服務,結構體要實現對應的接口方法
         * user.RegisterLoginServer(s, &server{})
         * minMovie.RegisterFbiServer(s, &server{})
         */
        // 在gRPC服務器上註冊反射服務
        reflection.Register(s)
        // 將監聽交給gRPC服務處理
        err = s.Serve(lis)
        if  err != nil {
            log.Fatalf("failed to serve: %v", err)
        }
    }

客戶端 /src/client/

        package main
        import (
            "log"
            "os"
            "golang.org/x/net/context"
            "google.golang.org/grpc"
            "test"
        )
    
    
        func main() {
            // 建立連接到gRPC服務
            conn, err := grpc.Dial("127.0.0.1:8028", grpc.WithInsecure())
            if err != nil {
                log.Fatalf("did not connect: %v", err)
            }
            // 函數結束時關閉連接
            defer conn.Close()
    
            // 創建Waiter服務的客戶端
            t := test.NewWaiterClient(conn)
    
            // 模擬請求數據
            res := "test123"
            // os.Args[1] 爲用戶執行輸入的參數 如：go run ***.go 123
            if len(os.Args) > 1 {
                res = os.Args[1]
            }
    
            // 調用gRPC接口
            tr, err := t.DoMD5(context.Background(), &test.Req{JsonStr: res})
            if err != nil {
                log.Fatalf("could not greet: %v", err)
            }
            log.Printf("服務端響應: %s", tr.BackJson)
        }

啓動服務端監聽，運行客戶端即可達成遠程調用