brpc-rs: Apache BRPC库的Rust版本

Apache BRPC 是一个工业级的RPC框架，用于构建可靠且高性能的服务。 brpc-rs 允许使用Rust编程语言实现BRPC客户端和服务器。

状态

该项目目前是一个正在积极开发的原型。许多API尚不存在；提供的API在1.0版本之前可能不稳定。

仓库结构

• 项目根目录
  • brpc-build
    • brpc-build 包，构建时代码生成器
  • brpc-protoc-plugin
    • brpc-protoc-plugin 包，Google Protobuf编译器的插件
  • brpc-sys
    • brpc-sys 包，Apache BRPC的FFI绑定
  • examples
    • examples
  • src
    • brpc-rs 包，brpc-rs的Rust API

此图说明了这些包如何协同工作

快速入门

先决条件

首先 构建 和 安装 Apache BRPC。说明请参阅 getting_started.md。

或者，您可以使用为Ubuntu 16.04/18.04 预构建的Apache BRPC 0.9.6的deb包。这些包不是官方包。

确保已安装以下依赖项

$ sudo apt-get install libprotobuf-dev libprotoc-dev protobuf-compiler
$ sudo apt-get install libssl-dev libgflags-dev libleveldb-dev

从crates.io安装brpc-protoc-plugin。

$ cargo install brpc-protoc-plugin --version 0.1.0-alpha4

现在我们可以开始一个 brpc-rs 项目了。

Cargo.toml

让我们创建一个小的crate，echo_service，其中包含一个echo_client和一个echo_server。

$ cargo new echo_service && cd echo_service

在 Cargo.toml 中，将 brpc-rs、prost 和 bytes 添加到 [dependencies] 部分；将 brpc-build 添加到 [build-dependencies] 部分。例如：

[build-dependencies]
brpc-build = "0.1.0"

[dependencies]
brpc-rs = "0.1.0"
prost = "0.5.0"
bytes = "0.4.12"

在 Cargo.toml 中定义两个二进制文件：echo_client 和 echo_server

[[bin]]
name = "echo_client"
path = "src/client.rs"

[[bin]]
name = "echo_server"
path = "src/server.rs"

build.rs

将一个protobuf文件echo.proto放入src目录。此文件定义了EchoRequest、EchoResponse和EchoService。

syntax="proto2";
package example;
message EchoRequest {
      required string message = 1;
};
message EchoResponse {
      required string message = 1;
};
service EchoService {
      rpc echo(EchoRequest) returns (EchoResponse);
};

在Cargo.toml的[package]部分添加一行build = "build.rs"。然后，创建一个名为build.rs的文件，从src/echo.proto生成绑定。

fn main() {
    brpc_build::compile_protos(&["src/echo.proto"],
                               &["src"]).unwrap();
}

注意在echo.proto中的package名称是example。因此，build.rs将生成两个名为example.rs和example.brpc.rs的文件。

src/server.rs

接下来，让我们实现echo服务器。创建src/server.rs如下所示

use brpc_rs::{Server, ServerOptions, ServiceOwnership};

pub mod echo {
    include!(concat!(env!("OUT_DIR"), "/example.rs"));
    include!(concat!(env!("OUT_DIR"), "/example.brpc.rs"));
}

fn main() {
    let mut service = echo::EchoService::new();
    service.set_echo_handler(&mut move |request, mut response| {
        response.message = request.message.clone();
        Ok(())
    });

    let mut server = Server::new();
    let mut options = ServerOptions::new();
    options.set_idle_timeout_ms(1000);
    server
        .add_service(&service, ServiceOwnership::ServerDoesntOwnService)
        .expect("Failed to add service");
    server.start(50000, &options).expect("Failed to start service");
    server.run(); // Run until CTRL-C
}

因为EchoService在echo.proto中定义了一个名为echo()的函数，所以brpc-protoc-plugin为EchoService生成了set_echo_handler()的Rust定义。set_echo_handler()接受一个闭包来处理来自客户端的EchoRequest并返回包含相同消息的EchoResponse。剩余的行创建了一个监听在0.0.0.0:50000的服务器。

src/client.rs

use brpc_rs::{Channel, ChannelOptions};

pub mod echo {
    include!(concat!(env!("OUT_DIR"), "/example.rs"));
    include!(concat!(env!("OUT_DIR"), "/example.brpc.rs"));
}

fn main() {
    let mut options = ChannelOptions::new();
    options.set_timeout_ms(100);
    let addr = "127.0.0.1:50000".parse().expect("Invalid socket address");
    let ch = Channel::with_options(&addr, &options);
    let client = echo::EchoServiceStub::with_channel(&ch);
    let request = echo::EchoRequest {
        message: "hello".to_owned(),
    };
    match client.echo(&request) {
        Ok(r) => println!("Response: {:?}", r),
        Err(e) => eprintln!("Error: {:?}", e),
    }
}

客户端首先创建一个Channel并使用该通道初始化一个service_stub。然后，客户端调用service_stub.echo()来发送请求。

运行客户端和服务器

$ cargo run --bin echo_server &
$ cargo run --bin echo_client
Response: EchoResponse { message: "hello" }

维护者

• 景一鸣 <jingyiming@baidu.com> @kevinis

许可

brpc-rs根据Apache License，版本2.0提供。副本请见LICENSE文件。