rust之poem框架实践系列（一）grpc

本文将通过poem框架所提供的grpc功能来实现一个简单token provider服务

goem介绍

poem 是一个功能齐全且易于使用的 Web 框架，采用 Rust 编程语言。

（git源码地址：https://github.com/poem-web/poem）

gRPC介绍

gRPC 是Google发起的一个开源远程过程调用系统。该系统基于HTTP/2协议传输，使用Protocol Buffers 作为接口描述语言。其他功能：认证双向流流控制超时最常见的应用场景是：微服务框架下，多种语言服务之间的高效交互。将手机服务、浏览器连接至后台产生高效的客户端库。

实践项目：token服务

token服务经常被设计为微服务平台中通用的一个服务，常常是用来进行相关校验，如接口的访问权限校验、用户身份的有效性校验等。

本项目将只提供两个简单的grpc接口：

token生成
token校验

创建项目

cargo init token_provider

添加依赖

Cargo.toml文件内容如下：

[package]
name = "token_provider"
version = "0.1.0"
edition = "2021"[dependencies]
prost = "0.11.0"
serde = {version = "1.0.139", features = ["derive"]}
serde_json = "1.0.82"
tokio = {version = "1.19.2", features = ["macros", "rt-multi-thread"]}
poem = "1.3.47"
poem-grpc = "0.2.11"[build-dependencies]
poem-grpc-build = "0.2.4"

添加proto文件

在项目根目录：

mkdir proto

echo ‘’ > token_service.proto

token_service.proto文件内容如下：

syntax = "proto3";
package token_service;service TokenService {rpc GetToken(GetTokenRequest) returns (GetTokenReply);rpc CheckToken(CheckTokenRequest) returns (CheckTokenReply);
}
//
message GetTokenRequest{string source_code=1;//用来成token的源内容，可以是用户名、角色等的组合
}
message GetTokenReply{string token=1;
}
//
message CheckTokenRequest{string token = 1;
}
message CheckTokenReply{string source_code=1;
}

添加build.rs文件

在项目根目录：

echo ‘’ > build.rs

build.rs文件内容如下：

use std::io::Result;use poem_grpc_build::compile_protos;fn main() -> Result<()> {compile_protos(&["./proto/token_service.proto",],&["./proto"],)
}

编译proto

cargo build

注：要保证本机已经安装了protobuf，否则编译的时候会提示找不到protoc二进制文件，我的是Mac系统，执行 brew install protobuf

如果编译能够顺利完成，在目录 target/debug/build下可以发现token_provider-xxxx的两个文件夹，其中一个文件夹内容out文件夹及通过proto自动生成的对应源码toker_service.rs文件，对应的接口框架已经生成

接下来将具体实现接口内容

实现接口

打开main.rs文件并添加如下内容：

use poem::{listener::TcpListener, Server};
use poem_grpc::{Code, Request, Response, RouteGrpc, Status};
//必须导入proto，否则无法获取对应的已经生成的接口
mod token_service {poem_grpc::include_proto!("token_service");
}
use token_service::{CheckTokenReply, CheckTokenRequest, GetTokenReply, GetTokenRequest, TokenService,TokenServiceServer,
};
//服务的地址信息
const ADDR: &str = "127.0.0.1:5100";//对生成的接口进行具体实现
struct RTokenService;#[poem::async_trait]
impl TokenService for RTokenService {///获取tokenasync fn get_token(&self,request: Request<GetTokenRequest>,) -> Result<Response<GetTokenReply>, Status> {let source_code = request.into_inner().source_code;if !source_code.is_empty() {let token = String::from(""); //根据自己的具体逻辑生成tokenreturn Ok(Response::new(GetTokenReply { token }));} else {return Err(Status::new(Code::InvalidArgument).with_message("empty source code"));}}///校验token，并返回source_codeasync fn check_token(&self,request: Request<CheckTokenRequest>,) -> Result<Response<CheckTokenReply>, Status> {//let token = request.into_inner().token;let source_code = String::from("..."); //从token中提取出source_code，并根据自己的逻辑进行验证Ok(Response::new(CheckTokenReply { source_code }))}
}#[tokio::main]
async fn main() -> Result<(), std::io::Error> {let route = RouteGrpc::new().add_service(TokenServiceServer::new(RTokenService));Server::new(TcpListener::bind(ADDR)).run(route).await
}

运行服务

cargo run

测试服务接口

echo ‘’ > token_test_client.rs

文件内容如下：

use poem_grpc::{ClientConfig, Request};
mod constant;poem_grpc::include_proto!("token_service");#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {let client = TokenServiceClient::new(ClientConfig::builder().uri(["http://", "127.0.0.1:5100"].concat()).build().unwrap(),);//生成tokenlet request = Request::new(GetTokenRequest {source_code: "111".into(),});let response = client.get_token(request).await?;println!("RESPONSE={:?}", response);//验证tokenlet request = Request::new(CheckTokenRequest {token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NjA4ODkyMTksImlhdCI6MTY2MDgwMjgxOSwic3ViIjoiY29tbW9uIHRva2VuIiwic291cmNlX2NvZGUiOiIxMTEifQ.R382aJ0P6D1YkMIjNCw8ePTo5Pji-hg6uXqX6QXdux8".into(),});let response = client.check_token(request).await?;println!("RESPONSE={:?}", response);Ok(())
}

总结

至此，token的grpc服务已经完成。

下一篇将用poem创建一个简单的rest api服务（包括友好的swanger）来演示与grpc服务的交互。