Python gRPC

概述：

gRPC 是谷歌開源的一個rpc（遠程程式調用）框架，可以輕鬆實現跨語言，跨平臺編程，其採用gRPC協議（基於HTTP2）。

• rpc：
  remote procedure call， 翻譯過來就是是遠程程式調用。具體來說，就是客戶端c1需要調用伺服器s1上的某個方法（函數），得到相應的返回值並傳遞給c1。
  
• gRPC協議
  要說gRPC協議需要先瞭解HTTP2， 雖然HTTP1.X 協議至今仍是主流協議，但是隨著我們對性能要求越來越高，和web規模的不斷擴大，HTTP2就應運而生。
  在這裡，我們只需要知道其性能是高於現有的HTTP1就好了，感興趣的朋友可以深入瞭解HTTP2。

使用原因

在上家公司，因為之前的項目有一下幾個痛點，所以決定採用rpc框架：

1. 項目的app，網站，m站，小程式等是獨立項目， 一處改，處處改，效率低下
2. 所有模塊在一個項目裡面，維護起來需要熟悉所有業務流程，維護難度加大
3. 擴展性不強，應付高一點的併發需要將項目所有東西複製到新加伺服器，運行所有模塊，包括併發量不高的模塊，造成資源浪費

所以我們花了點時間處理這些問題，將訂單，用戶等模塊拆開，方便獨立部署，獨立升級，獨立維護，這樣可以大大提高維護效率和項目的伸縮性。

使用方法

• 準備.proto文件

  syntax = "proto3";
  package order;
  message OrderRequest {// 定義請求數據
      string phone = 1;
      string price = 2;
      map<string, string> request_arg = 3;//便於欄位擴展
  }

 message JSONResponse{// 定義返回格式
     string rst_string = 1; //統一返回json字元串作處理
     }

  service OrderHandler {
    // format a list of events.
    rpc create_order (OrderRequest) returns (JSONResponse) {}
 }
// 其中:
// message: 定義數據結構<br>
// service: 定義介面的名字，參數，

• 生成所需文件(伺服器和客戶端均需要)

python -m grpc_tools.protoc -I./ --python_out=./ --grpc_python_out=./ ./*.proto

運行後會生成兩個文件（test_pb2.py, test_pb2_grpc.py）

• 編寫server端代碼

import time
import test_pb2
import test_pb2_grpc
import grpc
 
 
def test(request):
    # 實際調用到的函數
    json_response = test_pb2.JSONResponse()
    json_response.rst_string = json.dumps({"ret":"Hi gRPC"})# 構造出proto文件中定義的返回值格式
    return json_response
    
 class OrderHandler(test_pb2_grpc.OrderHandlerServicer):
    '''
    gRPC請求會進入這個類中進行分發，根據客戶端請求的方法找到對應的處理方法
    感興趣的可以打斷點查看request， context中的內容，他們包含了請求的所有信息
    '''

     def create_order(self, request, context):
         return test(request, context)

 def serve():
     # 開啟gRPC服務，監聽特定埠，
     server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
     test_pb2_grpc.add_OrderHandlerServicer_to_server(
                                            OrderHandler(), server)
     server.add_insecure_port('[::]:{}'.format(12006))
     server.start()
     try:
         while True:
             time.sleep(186400)
     except KeyboardInterrupt:
         server.stop(0)
serve()

• 編寫客戶端代碼進行 測試 client.py

 import grpc
 import test_pb2_grpc
 import test_pb2

 channel = grpc.insecure_channel("127.0.0.1:12006")
 stub = test_pb2_grpc.OrderHandlerStub(channel)
 # 要完成請求需要先構造出proto文件中定義的請求格式
 ret = stub.create_order(test_pb2.OrderRequest(phone="12990", price="50"))
 
 print(ret.rst_string)