gRPC 的route_guide例子

本文轉載自查看原文 2015-06-11 16:19 4619 Go語言/ gRPC

本文的例子代碼在： https://github.com/grpc/grpc-go/tree/master/examples/route_guide

功能就類似目前LBS一樣，在每個位置上報一些文字信息，上報方式有多種。

在 .proto 文件中定義服務

在 .proto 文件中定義一個服務很簡單，就像如下的代碼：

service RouteGuide {
   ...
}

定義rpc的方法，需要指定他們的 request 和response 類型。gRPC 可以定義四種類型的方法，這個 RouteGuide 服務例子中都會出現。

1、就像普通函數調用一樣，

客戶端帶着 stub 發送請求，然后等服務器端返回。

// Points are represented as latitude-longitude pairs in the E7 representation
// (degrees multiplied by 10**7 and rounded to the nearest integer).
// Latitudes should be in the range +/- 90 degrees and longitude should be in
// the range +/- 180 degrees (inclusive).
message Point {
int32 latitude = 1;
int32 longitude = 2;
}

// A feature names something at a given point.
//
// If a feature could not be named, the name is empty.
message Feature {
// The name of the feature.
string name = 1;
// The point where the feature is detected.
Point location = 2;
}

  // A simple RPC.
  //
  // Obtains the feature at a given position.
  //
  // If no feature is found for the given point, a feature with an empty name
  // should be returned.
  rpc GetFeature(Point) returns (Feature) {}

2、服務器端返回的是個RPC的流

客戶端發送請求到服務器端，並獲得一個流讀取消息的序列。客戶端從返回的流中讀取數據。注意這里用了 stream 這個關鍵字。

// A latitude-longitude rectangle, represented as two diagonally opposite

// points "lo" and "hi".

message Rectangle {

// One corner of the rectangle.

Point lo = 1;

// The other corner of the rectangle.

Point hi = 2;

}

// A server-to-client streaming RPC.

// Obtains the Features available within the given Rectangle. Results are

// streamed rather than returned at once (e.g. in a response message with a

// repeated field), as the rectangle may cover a large area and contain a

// huge number of features.

rpc ListFeatures(Rectangle) returns (stream Feature) {}

3、客戶端用流傳輸，服務器端正常。

客戶端將消息寫入流的序列，並將它們發送到服務器。一旦客戶端已經寫完了消息，客戶端等待服務器讀取所有這些，返回其響應。

// A RouteSummary is received in response to a RecordRoute rpc.

// It contains the number of individual points received, the number of

// detected features, and the total distance covered as the cumulative sum of

// the distance between each point.

message RouteSummary {

// The number of points received.

int32 point_count = 1;

// The number of known features passed while traversing the route.

int32 feature_count = 2;

// The distance covered in metres.

int32 distance = 3;

// The duration of the traversal in seconds.

int32 elapsed_time = 4;

}

// A client-to-server streaming RPC.

// Accepts a stream of Points on a route being traversed, returning a

// RouteSummary when traversal is completed.

rpc RecordRoute(stream Point) returns (RouteSummary) {}

4、服務器和客戶端都用流來處理，即雙向流

兩個流獨立運行，所以客戶端和服務器端都可以讀取和寫入任何他們喜歡的東西。

// A RouteNote is a message sent while at a given point.

message RouteNote {

// The location from which the message is sent.

Point location = 1;

// The message to be sent.

string message = 2;

}

// A Bidirectional streaming RPC.

// Accepts a stream of RouteNotes sent while a route is being traversed,

// while receiving other RouteNotes (e.g. from other users).

rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}

產生客戶端和服務器端代碼

有一個封裝好的 shell 腳本在 https://github.com/grpc/grpc-go/blob/master/codegen.sh

這個工具各種依賴的安裝方法請參考： http://www.cnblogs.com/ghj1976/p/4564133.html

我們這里執行的命令是： ./codegen.sh ./examples/route_guide/proto/route_guide.proto

這時候我們產生的文件是：

https://github.com/grpc/grpc-go/blob/master/examples/route_guide/proto/route_guide.pb.go

這個產生的文件中，既有公共類的相關信息，也有客戶端和服務器端的代碼。

服務器端我們要做這些事情：

實現上面 proto 文件產生的服務器端接口
服務器端運行 rpc 服務器去監聽來自客戶端的請求，並將它們路由到正確的服務上。

實現 RouteGuideServer 接口

我們在 route_guide.pb.go 中可以看到我們需要實現的接口：

// Server API for RouteGuide service

type RouteGuideServer interface {
    // A simple RPC.
    //
    // Obtains the feature at a given position.
    //
    // If no feature is found for the given point, a feature with an empty name
    // should be returned.
    GetFeature(context.Context, *Point) (*Feature, error)

    // A server-to-client streaming RPC.
    //
    // Obtains the Features available within the given Rectangle. Results are
    // streamed rather than returned at once (e.g. in a response message with a
    // repeated field), as the rectangle may cover a large area and contain a
    // huge number of features.
    ListFeatures(*Rectangle, RouteGuide_ListFeaturesServer) error

    // A client-to-server streaming RPC.
    //
    // Accepts a stream of Points on a route being traversed, returning a
    // RouteSummary when traversal is completed.
    RecordRoute(RouteGuide_RecordRouteServer) error

    // A Bidirectional streaming RPC.
    //
    // Accepts a stream of RouteNotes sent while a route is being traversed,
    // while receiving other RouteNotes (e.g. from other users).
    RouteChat(RouteGuide_RouteChatServer) error
}

simple RPC.

GetFeature 需要根據客戶端傳入的一個點, 返回數據庫中對應的 Feature.

Server-side streaming RPC

返回所有在這個區域的 Feature。

注意，我們這里用到 stream.Send 方法發送的結果數據。在發送完成或者發送除了錯誤時，才return 結束這個函數。

Client-side streaming RPC

客戶端上通過 stream 上傳一批點，服務器端記錄點的個數、已知的feature數、總行駛距離、總時間消耗。

$)V44Z8BC%)$GPZJT_5{2WOC$

注意，這里通過 stream.Recv 接收數據，通過 stream.SendAndClose 關閉返回流。

Bidirectional streaming RPC

服務器端接收客戶端上報的位置信息流，針對當前一個位置，回應這個位置的已有位置信息流。

這里用的 stream.Recv() 接收， stream.Send 發送。

開始服務

開啟服務我們做了下面步驟：

1、制定服務的監控端口, lis, err := net.Listen("tcp", fmt.Sprintf(":%d", *port))

2、創建一個 gRPC 服務實例 grpc.NewServer().

3、在gRPC 服務實例上注冊我們的服務實現 pb.RegisterRouteGuideServer(grpcServer, &routeGuideServer{})

4、調用 grpcServer.Serve(lis) 開啟服務，我們監控的端口做阻塞等待，知道該進程被殺死或者 Stop() 方法被調用。

編譯服務器端

編譯時，由於牆的原因，有些依賴包需要特殊下載，相關資料請參考：

http://www.cnblogs.com/ghj1976/p/4549602.html

創建客戶端

這部分代碼可以在 https://github.com/grpc/grpc-go/blob/master/examples/route_guide/client/client.go 看到。

建立通道

要調用服務，我們需要先創建一個 gRPC 通道與服務器進行通訊，我們這里通過 grpc.Dial 來指定服務器地址和端口來創建這個通道。

一旦gRPC通道建立后，我們需要一個客戶端stub去執行RPC，這里我們使用 .proto 文件生產的 NewRouteGuideClient 方法。