4个版本
新 0.1.5 | 2024年8月20日 |
---|---|
0.1.4 | 2024年8月20日 |
0.1.3 | 2024年8月19日 |
0.1.2 | 2024年8月19日 |
#18 在 #rpc-service
531 每月下载量
在 2 个crate中使用 (通过 lrcall)
41KB
758 行
lrcall
lrcall
是一个兼容本地和远程过程调用的Rust过程调用框架。lrcall注重易用性。定义服务只需要几行代码,并且大多数服务器的样板代码都为您处理。
基于google/tarpc进行二次开发
LPC是什么?
"LPC"代表"本地过程调用",是一种在本地执行返回值生成的工作的函数调用。
RPC是什么?
"RPC"代表"远程过程调用",是一种在别处执行返回值生成的工作的函数调用。当调用rpc函数时,在幕后,该函数会联系其他进程并要求它们评估该函数。原始函数随后返回其他进程生成的值。
lrcall的一些特性
- 客户端同时支持本地调用和远程调用,这意味着用户可以根据上下文动态切换调用方法。
- 在代码中定义模式,而不是在像.proto这样的单独语言中。
- 可插拔传输:任何实现
Stream<Item = Request> + Sink<Response>
的类型都可以用作传输来连接客户端和服务器。 Send + 'static
可选:如果传输不需要,lrcall也不需要!- 级联取消:丢弃请求将向服务器发送取消消息。服务器将停止对请求的任何未完成工作,随后取消其自身的请求,并对整个传递依赖链重复此操作。
- 可配置的截止时间和截止时间传播:如果未指定,则请求截止时间默认为10秒。当截止时间经过后,服务器将自动停止工作。服务器发送的任何使用请求上下文的请求都将传播请求截止时间。例如,如果服务器正在处理一个10秒的截止时间的请求,执行了2秒的工作,然后向另一个服务器发送请求,那个服务器将看到一个8秒的截止时间。
- 分布式跟踪:lrcall使用跟踪原语,这些原语由OpenTelemetry跟踪扩展。使用兼容的跟踪订阅者,如OTLP,每个RPC都可以通过客户端、服务器以及服务器下游的其他依赖项进行跟踪。即使对于未连接到分布式跟踪收集器的应用程序,仪器也可以被常规记录器,如env_logger,摄取。
- Serde序列化:启用
serde1
Cargo功能将使服务请求和响应实现Serialize + Deserialize
。尽管这是完全可选的,但也可以使用内存传输,因此不必在不需要时支付序列化的代价。
用法
将以下依赖项添加到您的Cargo.toml
中
lrcall = "0.1"
lrcall::service
属性展开为形成一个rpc服务的项目集合。这些生成的类型使编写具有较少样板代码的服务变得简单而方便。只需实现生成的服务特质,然后就可以开始比赛了!
示例
此示例使用tokio,因此请将以下依赖项添加到您的Cargo.toml
anyhow = "1.0"
futures = "0.3"
lrcall = { version = "0.1", features = ["tokio1"] }
tokio = { version = "1.0", features = ["macros"] }
在以下示例中,我们使用进程内通道在客户端和服务器之间进行通信。在实际代码中,您可能会通过网络进行通信。有关更实际的示例,请参阅lrcall-example。
首先,让我们设置依赖关系和服务定义。
# extern crate futures;
use futures::{
prelude::*,
};
use lrcall::{
client, context,
server::{self, incoming::Incoming, Channel},
};
// This is the service definition. It looks a lot like a trait definition.
// It defines one RPC, hello, which takes one arg, name, and returns a String.
#[lrcall::service]
trait World {
/// Returns a greeting for name.
async fn hello(name: String) -> String;
}
此服务定义生成一个名为World
的特质。接下来我们需要为我们的Server结构体实现它。
# extern crate futures;
# use futures::{
# prelude::*,
# };
# use lrcall::{
# client, context,
# server::{self, incoming::Incoming},
# };
# // This is the service definition. It looks a lot like a trait definition.
# // It defines one RPC, hello, which takes one arg, name, and returns a String.
# #[lrcall::service]
# trait World {
# /// Returns a greeting for name.
# async fn hello(name: String) -> String;
# }
// This is the type that implements the generated World trait. It is the business logic
// and is used to start the server.
#[derive(Clone)]
struct HelloService;
impl World for HelloService {
// Each defined rpc generates an async fn that serves the RPC
async fn hello(self, _: context::Context, name: String) -> String {
format!("Hello, {name}!")
}
}
最后,让我们编写我们的main
,它将启动服务器。虽然此示例使用进程内通道,但lrcall还提供了一个位于serde-transport
功能之后的泛型serde_transport
,该功能在tcp
功能之后提供了额外的TCP功能。
# extern crate futures;
# use futures::{
# prelude::*,
# };
# use lrcall::{
# client, context,
# server::{self, Channel},
# };
# // This is the service definition. It looks a lot like a trait definition.
# // It defines one RPC, hello, which takes one arg, name, and returns a String.
# #[lrcall::service]
# trait World {
# /// Returns a greeting for name.
# async fn hello(name: String) -> String;
# }
# // This is the type that implements the generated World trait. It is the business logic
# // and is used to start the server.
# #[derive(Clone)]
# struct HelloService;
# impl World for HelloService {
// Each defined rpc generates an async fn that serves the RPC
# async fn hello(self, _: context::Context, name: String) -> String {
# format!("Hello, {name}!")
# }
# }
# #[cfg(not(feature = "tokio1"))]
# fn main() {}
# #[cfg(feature = "tokio1")]
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let (client_transport, server_transport) = lrcall::transport::channel::unbounded();
let server = server::BaseChannel::with_defaults(server_transport);
tokio::spawn(
server.execute(HelloService.serve())
// Handle all requests concurrently.
.for_each(|response| async move {
tokio::spawn(response);
}));
// WorldClient is generated by the #[lrcall::service] attribute. It has a constructor `new`
// that takes a config and any Transport as input.
let mut client = WorldClient::<HelloService>::rpc_client(WorldChannel::spawn(client::Config::default(), client_transport));
// The client has an RPC method for each RPC defined in the annotated trait. It takes the same
// args as defined, with the addition of a Context, which is always the first arg. The Context
// specifies a deadline and trace information which can be helpful in debugging requests.
let hello = client.hello(context::rpc_current(), "Andeya".to_string()).await?;
println!("{hello}");
Ok(())
}
依赖关系
~280–730KB
~18K SLoC