- 四种服务(流式与一元)：
rpc SayHello(HelloRequest) returns (HelloResponse);
...
rpc SayHello(stream HelloRequest) returns (stream HelloResponse);
// 区别在于stream关键字
// rpc client(client-data-structure) returns (server-data-structure) {}pip install grpcio
pip install grpcio-toolsvscode推荐下载vscode-proto3插件
syntax 'proto3'; // 指定proto buffers版本为proto3
package Service // package用于创建命名空间，相当于c++的namespace
//此外，还有option关键字用于指定protoc编译器的某些行为
service ServiceName {
//method
rpc serverFunction(client-data-structure) returns (server-data-structure) {}
}
message client-data-structure {
int32 interval = 1;
// 这里的1并不是internal的默认值，而是internal在client-data-structure这个message的编号
bool var1 = 2;
repeated int32 IntArr = 3; // 用repeated关键字定义数组
...
}
...python -m gprc_tools.protoc \
-I{dir-where-protofiles-in} \
--python_out={output-files-of-.py-files} \
--pyi_out={output-files-of-.pyi-files} \
--grpc_python_out={grpc-python-code} \
{relative-path-of-the-.proto-files}示例：
python -m grpc_tools.protoc -Igrpc/example/custom/path=../../protos --python_out=. --grpc_python_out=. ../../protos/route_guide.proto- 客户端(server.py)：
这是最简单的服务端代码样板，实际需要自己按需拓展。
import grpc from concurrent import futures import {}_pb2_grpc import {}_pb2 #例如 对应try.proto, server.py需要实现 class TryServicer({}_pb2_grpc.TryServicer) 用大驼峰命名 #这个class需要继承grpc_tools自动实现的类{proto文件名大驼峰} class {}Servicer({}_pb2_grpc.{}Servicer): #在类里面实现你在.proto文件里面写的功能 #比如rpc FuncClient(Request) returns (Response) #你就要实现def FuncClient(self, request, context): #request里面包含的是你的请求，可以理解为message关键字定义的数据相当于一个json #context包含你的请求上下文，比如客户端的ip，定义响应状态，设置超时等，可以通过context设置。 def FuncClient(self, request, context): return {}_pb2.{Client-data-structure}({key} = f"value: {value}") #我的理解是，{}_pb2_grpc.py定义的是服务的行为，{}_pb2.py定义的是数据的行为。 #不同于python的data.{}={}的数据赋值形式，这里采用类函数的传入赋值， #而且没有position编码，你必须显式指定你的value赋值给哪个key，不然报错。 def serve(): #服务 server = grpc.server(futures.ThreadPoolExecutor(max_workers = 10)) # 创建server {}_pb2_grpc.add_{}Servicer_to_server( {}Servicer(), server ) # 这个add_{}_to_server被称为注册函数，用于将你实现的服务的类注册到grpc服务器商，并用创建的server进程池部署服务 server.add_insecure_port("[::]:50051") # 监听所有50051端口 server.start() # 启动服务 server.wait_for_termination() # 这句代码用于在服务器显式关闭的时候关闭服务，但是感觉用处不大，直接stop(times)感觉更实用。 if __name__ == '__main__': server()
- 客户端代码(client.py):
import grpc import {}_pb2_grpc import {}_pb2 #主要实现run()方法，对服务端定义的接口进行请求。 def run(): channel = grpc.insecure_channel("localhost:50051") # 定义通道 stub = {}_pb2_grpc.{}Stub(channel) # 对于服务中的每个方法，编译器都会使用相同名称向 stub 对象添加一个对应的属性。，见下面 response = stub.FuncClient({}_pb_2.Client_data_structure({key} = {value})) # 利用服务端的FuncClient服务进行请求.将返回的数据保存到response变量中 print(response.{key}) # 对response进行操作。 if __name__ == '__main__': run()
python server.py
// 新开一个终端启动客户端
python client.py-
linux（wsl)
export MY_INSTALL_DIR=$HOME/.{dirName} mkdir -p $MY_INSTALL_DIR export PATH="$MY_INSTALL_DIR/bin:$PATH" echo "安装bash" wget -q -O cmake-linux.sh https://github.com/Kitware/CMake/releases/download/v3.30.3/cmake-3.30.3-linux-x86_64.sh sh cmake-linux.sh -- --skip-license --prefix=$MY_INSTALL_DIR rm cmake-linux.sh echo "安装grpc基本工具" sudo apt-get update && sudo apt-get upgrade sudo apt-get install -y build-essential autoconf libtool pkg-config echo "grpc本身" git clone --recurse-submodules -b v1.66.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc echo "安装grpc和proto buffers" cd grpc mkdir -p cmake/build pushd cmake/build cmake -DgRPC_INSTALL=ON \ -DgRPC_BUILD_TESTS=OFF \ -DCMAKE_CXX_STANDARD=17 \ -DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR \ ../.. make -j 4 make install popd
进行windows的grpc安装之前，先到下方的网站安装vs installer， 然后在下载器内选择<桌面C++开发工具>进行下载，此处不多赘叙 ms c++ 生成工具
-
Windows cmd：
set MY_INSTALL_DIR=%USERPROFILE%\cmake mkdir %INSTALL_DIR% set PATH=%PATH%;$MY_INSTALL_DIR\bin choco install cmake cmake --version git clone --recurse-submodules -b v1.66.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc cd grpc mkdir "cmake\build" pushd "cmake\build" cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DCMAKE_CXX_STANDARD=17 -DCMAKE_INSTALL_PREFIX=%MY_INSTALL_DIR% ..\.. cmake --build . --config Release --target install -j 4 popd
-
Windows powershell:
$env:MY_INSTALL_DIR = "$env:USERPROFILE\cmake" New-Item -ItemType Directory -Force -Path $env:MY_INSTALL_DIR [Environment]::SetEnvironmentVariable("MY_INSTALL_DIR", "$env:USERPROFILE\cmake", "User") [Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";$env:MY_INSTALL_DIR\bin", "User") "cmake 安装可能需要vpn" winget install cmake cmake --version git clone --recurse-submodules -b v1.66.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc cd grpc mkdir "cmake\build" pushd "cmake\build" cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -DCMAKE_CXX_STANDARD=17 -DCMAKE_INSTALL_PREFIX=%MY_INSTALL_DIR% ..\.. cmake --build . --config Release --target install -j 4 popd
如果一切顺利，grpc就安装成功了
cpp grpc文件生成示例：
- windows:
grpc_cpp_plugin 一般在你安装的grpc路径下grpc/cmake/build/Release/下
# grpc 文件 protoc -I . --grpc_out=./cpp_out --plugin=protoc-gen-grpc={your path to grpc_cpp_plugin} snack.proto # cpp 文件 protoc -I . --cpp_out=./cpp_out snack.proto
#include <grpc/grpc.h>
#include <grpcpp/security/server_credentials.h>
#include <grpcpp/server.h>
#include <grpcpp/server_builder.h>
#include <grpcpp/server_context.h>
#include "path/to/grpc.pb.h"
using grpc::Server;
using grpc::ServerBuilder;
using grpc::ServerContext;
using grpc::ServerReader;
using grpc::ServerReaderWriter;
using grpc::ServerWriter;
using grpc::Status;
using {protoName}::{data-structure};
...
using std::chrono::system_clock; // time module
class {}Impl final : public {}:Service {
public:
explicit {}Impl(const std::string& db){
{}::ParseDb(db, &json_list)
} // 官方示例，ParseDb可以读取json文件
// 双向非流式
Status GetFeature(ServerContext* context, const Data* data, ...) override {// ServerContext * context 接收客户端上下文
data->set_param1()
data->get_param1() // proto 会为proto文件内的每个message内的int等基本类型分别生成get方法和set方法
data->mutable_lacation()->CopyFrom(*data) //如果message内的类型是嵌套的message，则生成一个对应指针。
return Status::OK //返回OK状态码，告诉grpc要发送的数据已经准备好了。
}
//服务器端流式
} server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # 用SOCK_STREAM创建套接字
server_address = (host, port) #
server_socket.bind(self.server_address) # 绑定服务地址
server_socket.listen() # 监听
while True:
client_socket, client_address = self.server_socket.accept() # 接受连接
data = client_socket.recv(4096)
response = ""
client_socket.sendall(response.encode('UTF-8'))
# client_socket.close() 如果执行这个，client在recv方法之后的sendall因为被终止无法执行。
if not data:
server_socket.close() client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
server_address = ('localhost', 12345)
client_socket.connect(server_address)
message = ""
client_socket.sendall(message.encode('UTF-8'))
response = client_socket.recv(4096)
client_socket.close()server_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) # 用SOCK_DGRAM创建套接字
server_address = ('localhost', 12345)
server_socket.bind(server_address)
server_socket.settimeout(10) # 设置监听超时
data, address = server_socket.recvfrom(1024) # 使用recvfrom关键字
server_socket.sendto(response.encode(), address) # 一般使用sendto
server_socket.close()client_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
server_address = ('localhost', 12345)
client_socket.sendto(msg.encode('UTF-8'), server_address)
client_socket.close()