【小沐学Python】Python实现通信协议（grpc）

news2024/11/28 18:38:14

文章目录

1、简介
2、安装
3、定义接口
4、编译生成
5、代码编写
- 5.1 服务端
- 5.2 客户端
- 5.3 运行测试
结语

1、简介

https://grpc.io/docs/what-is-grpc/introduction/
https://github.com/grpc/grpc

gRPC 是一种现代、开源、高性能的远程过程调用（RPC）可以在任何地方运行的框架。gRPC 使客户端和服务器应用程序能够透明地进行通信，并简化互联系统的构建。

在这里插入图片描述

gRPC是一个高性能、通用的开源RPC框架，其由Google主要面向移动应用开发并基于HTTP/2协议标准而设计，基于ProtoBuf序列化协议开发，且支持众多开发语言。
在这里插入图片描述

在 gRPC 中，客户端应用程序可以直接调用服务器应用程序上的方法在另一台机器上，就好像它是本地对象一样，使你更容易创建分布式应用程序和服务。与许多 RPC 系统一样，gRPC 是基于定义服务的思想，指定可以使用其参数和返回类型进行远程调用。在服务器端， server 实现此接口并运行 gRPC 服务器来处理客户端调用。在客户端，客户端有一个存根（在某些客户端中称为客户端 languages），它提供与服务器相同的方法。
在这里插入图片描述

一个gRPC服务的大体结构图为：
在这里插入图片描述

2、安装

pip install grpcio
pip install grpcio-tools  
pip install protobuf

在这里插入图片描述

3、定义接口

创建 gRPC 服务的第一步是在.proto 文件中定义好接口，proto是一个协议文件，客户端和服务器的通信接口正是通过proto文件协定的，可以根据不同语言生成对应语言的代码文件。

helloworld.proto

syntax = "proto3";

option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";

package helloworld;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}

  rpc SayHelloStreamReply (HelloRequest) returns (stream HelloReply) {}

  rpc SayHelloBidiStream (stream HelloRequest) returns (stream HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

4、编译生成

命令行执行如下命令：

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

在这里插入图片描述
执行上述命令后，生成helloworld_pb2.py 和helloworld_pb2_grpc.py这两个文件。

5、代码编写

5.1 服务端

greeter_server.py

from concurrent import futures
import logging

import grpc
import helloworld_pb2
import helloworld_pb2_grpc


class Greeter(helloworld_pb2_grpc.GreeterServicer):
    def SayHello(self, request, context):
        return helloworld_pb2.HelloReply(message="Hello, %s!" % request.name)


def serve():
    port = "50051"
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    helloworld_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
    server.add_insecure_port("[::]:" + port)
    server.start()
    print("Server started, listening on " + port)
    server.wait_for_termination()


if __name__ == "__main__":
    logging.basicConfig()
    serve()

5.2 客户端

greeter_client.py

from __future__ import print_function

import logging

import grpc
import helloworld_pb2
import helloworld_pb2_grpc


def run():
    # NOTE(gRPC Python Team): .close() is possible on a channel and should be
    # used in circumstances in which the with statement does not fit the needs
    # of the code.
    print("Will try to greet world ...")
    with grpc.insecure_channel("localhost:50051") as channel:
        stub = helloworld_pb2_grpc.GreeterStub(channel)
        response = stub.SayHello(helloworld_pb2.HelloRequest(name="you"))
    print("Greeter client received: " + response.message)


if __name__ == "__main__":
    logging.basicConfig()
    run()

5.3 运行测试

运行服务端：
在这里插入图片描述
运行客户端：

结语

如果您觉得该方法或代码有一点点用处，可以给作者点个赞，或打赏杯咖啡；╮(￣▽￣)╭
如果您感觉方法或代码不咋地//(ㄒoㄒ)//，就在评论处留言，作者继续改进；o_O???
如果您需要相关功能的代码定制化开发，可以留言私信作者；(✿◡‿◡)
感谢各位大佬童鞋们的支持！( ´ ▽´ )ﾉ ( ´ ▽´)っ！！！