tarpc

免责声明：这不是一个官方的 Google 产品。

tarpc 是一个专注于易用性的 Rust RPC 框架。定义一个服务只需要几行代码，大多数服务器的样板代码都由框架自动处理。

文档

什么是 RPC 框架？

"RPC" 代表 "远程过程调用"，是一种函数调用，其返回值的生成工作在别处进行。当调用 RPC 函数时，在幕后，该函数会联系其他进程，并要求它们评估该函数。原始函数随后返回其他进程产生的值。

RPC 框架是大多数面向微服务的架构的基本构建块。两个著名的例子是 gRPC 和 Cap'n Proto。

tarpc 与其他 RPC 框架的区别在于，它通过代码定义模式，而不是在单独的 .proto 等语言中定义。这意味着没有单独的编译过程，也不需要在不同的语言之间切换上下文。

tarpc 的其他一些功能

• 可插拔传输：任何实现了 Stream<Item = Request> + Sink<Response> 的类型都可以用作传输，连接客户端和服务器。
• Send + 'static 可选：如果传输不需要，tarpc 也不需要！
• 级联取消：丢弃请求将向服务器发送取消消息。服务器将停止对请求的所有未完成工作，然后取消其自身的请求，这一过程会重复进行，直至整个递归依赖链。
• 可配置的截止时间和截止时间传播：如果未指定，则请求截止时间默认为10秒。服务器将在截止时间过后自动停止工作。服务器发送的任何使用请求上下文的请求都将传播请求截止时间。例如，如果服务器正在处理一个10秒截止时间的请求，做了2秒的工作，然后向另一个服务器发送请求，那个服务器将看到一个8秒的截止时间。
• 分布式跟踪：tarpc使用了跟踪原语，这些原语通过OpenTelemetry跟踪进行了扩展。使用兼容的跟踪订阅者，例如Jaeger，每个RPC都可以通过客户端、服务器以及服务器下游的其他依赖关系进行跟踪。即使对于未连接到分布式跟踪收集器的应用程序，仪器也可以被常规记录器，如env_logger，所摄取。
• Serde序列化：启用serde1 Cargo功能将使服务请求和响应具有Serialize + Deserialize功能。尽管这是完全可选的，但可以使用内存传输，因此不需要序列化时不需要支付序列化的代价。

用法

将以下依赖项添加到您的Cargo.toml中

tarpc = "0.33"

tarpc::service属性展开为一个集合，该集合形成了一个RPC服务。这些生成的类型使得编写服务器变得更加简单和便捷。只需实现生成的服务特质，然后您就可以开始了！

示例

此示例使用tokio，因此请将以下依赖项添加到您的Cargo.toml中

anyhow = "1.0"
futures = "0.3"
tarpc = { version = "0.31", features = ["tokio1"] }
tokio = { version = "1.0", features = ["macros"] }

在以下示例中，我们使用进程内通道在客户端和服务器之间进行通信。在实际代码中，您可能会通过网络进行通信。有关更实际的示例，请参阅example-service。

首先，让我们设置依赖项和服务定义。

use futures::{
    future::{self, Ready},
    prelude::*,
};
use tarpc::{
    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.
#[tarpc::service]
trait World {
    /// Returns a greeting for name.
    async fn hello(name: String) -> String;
}

此服务定义生成一个名为World的特质。接下来，我们需要为我们的Server结构体实现它。

// 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 HelloServer;

impl World for HelloServer {
    // Each defined rpc generates two items in the trait, a fn that serves the RPC, and
    // an associated type representing the future output by the fn.

    type HelloFut = Ready<String>;

    fn hello(self, _: context::Context, name: String) -> Self::HelloFut {
        future::ready(format!("Hello, {name}!"))
    }
}

最后，让我们编写我们的main，它将启动服务器。虽然此示例使用进程内通道，但tarpc还提供了一个通用的serde_transport，它位于serde-transport功能之后，并提供了额外的tcp功能，这些功能位于tcp功能之后。

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let (client_transport, server_transport) = tarpc::transport::channel::unbounded();

    let server = server::BaseChannel::with_defaults(server_transport);
    tokio::spawn(server.execute(HelloServer.serve()));

    // WorldClient is generated by the #[tarpc::service] attribute. It has a constructor `new`
    // that takes a config and any Transport as input.
    let mut client = WorldClient::new(client::Config::default(), client_transport).spawn();

    // 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::current(), "Stim".to_string()).await?;

    println!("{hello}");

    Ok(())
}

服务文档

使用与平常相同的cargo doc来查看由service!调用展开的所有项创建的文档。

许可：MIT