python 使用gRPC

Posted 2020-12-26 yuzhen jie

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)