Bootstrap

实现跨语言通信:Rust 和 Thrift 的最佳实践

前言

在分布式系统中,服务之间高效且安全的通信至关重要。Apache Thrift 是一个被广泛应用的跨语言 RPC(远程过程调用)框架,它支持多种编程语言,包括 Rust。Rust 以其卓越的性能和内存安全保障,成为越来越多开发者的首选语言。
本文将深入探讨如何在 Rust 项目中集成 Thrift,帮助开发者实现跨服务的高效通信,并且探讨异步编程和 TLS 安全通信的高级实现方式。

什么是 Thrift?

Thrift 是由 Facebook 开发并开源的一个高效的服务框架。它允许你定义数据类型和服务接口,然后生成跨多种编程语言的代码。简单来说,Thrift 提供了一个统一的接口来实现不同语言之间的通信。

集成步骤

你可以通过以下命令安装 Thrift 编译器:

# For macOS using Homebrew
brew install thrift

# For Ubuntu
sudo apt-get install thrift-compiler

1. 定义 Thrift 文件

首先,你需要定义一个 .thrift 文件,描述你的数据结构和服务接口。创建一个文件 example.thrift:

namespace rs example

struct User {
  1: i32 id,
  2: string name,
  3: i32 age
}

service UserService {
  User getUser(1: i32 id),
  void saveUser(1: User user)
}

这个文件描述了一个 User 结构体和一个 UserService 服务。

2. 生成 Rust 代码

使用 Thrift 编译器生成 Rust 代码:

thrift --gen rs example.thrift

这将会在当前目录下生成一个 gen-rs 目录,里面包含了 Thrift 为 Rust 生成的代码。

3. 在 Rust 项目中使用 Thrift

创建一个新的 Rust 项目:

cargo new rust_thrift_example
cd rust_thrift_example

编辑 Cargo.toml 文件,添加 Thrift 依赖:

[dependencies]
thrift = "0.14.1"

将生成的 gen-rs 文件夹复制到 src 目录下,以便在项目中使用。

接下来,我们编写一个简单的客户端和服务器。

服务器端代码

在 src 目录下创建一个新文件 server.rs,编写服务器端代码:

use thrift::protocol::{TBinaryInputProtocol, TBinaryOutputProtocol};
use thrift::server::{TServer, TSimpleServer};
use thrift::transport::{TBufferedReadTransport, TBufferedWriteTransport, TIoChannel, TTcpChannel, TTcpListener, TTransport};

mod gen_rs {
    pub mod example;
}

use gen_rs::example::{User, UserServiceSyncProcessor};

struct UserServiceHandler;

impl UserServiceSyncProcessor for UserServiceHandler {
    fn getUser(&self, id: i32) -> thrift::Result<User> {
        Ok(User { id, name: format!("User{}", id), age: 30 })
    }

    fn saveUser(&self, user: User) -> thrift::Result<()> {
        println!("User saved: {:?}", user);
        Ok(())
    }
}

fn main() -> thrift::Result<()> {
    let listener = TTcpListener::new("127.0.0.1:9090")?;
    let server = TSimpleServer::new(
        UserServiceHandler,
        TBinaryInputProtocol::new,
        TBinaryOutputProtocol::new,
        TBufferedReadTransport::new,
        TBufferedWriteTransport::new,
        listener,
    );
    println!("Starting the server...");
    server.serve()?;
    Ok(())
}
客户端代码

在 src 目录下创建一个新文件 client.rs,编写客户端代码:

use thrift::protocol::{TBinaryInputProtocol, TBinaryOutputProtocol};
use thrift::transport::{TBufferedReadTransport, TBufferedWriteTransport, TTcpChannel, TTransport};

mod gen_rs {
    pub mod example;
}

use gen_rs::example::{UserServiceSyncClient};

fn main() -> thrift::Result<()> {
    let mut transport = TTcpChannel::new();
    transport.open("127.0.0.1:9090")?;
    let (i_prot, o_prot) = (
        TBinaryInputProtocol::new(TBufferedReadTransport::new(transport.try_clone()?)),
        TBinaryOutputProtocol::new(TBufferedWriteTransport::new(transport)),
    );

    let client = UserServiceSyncClient::new(i_prot, o_prot);

    let user = client.getUser(1)?;
    println!("Got user: {:?}", user);

    client.saveUser(user)?;

    Ok(())
}

4. 运行服务器和客户端

首先,编译并运行服务器:

cargo run --bin server

然后,在另一个终端窗口中运行客户端:

cargo run --bin client

你应该会看到客户端从服务器获取到用户信息并将其保存。

实际应用

在上面的教程中,我们已经成功地实现了一个基础的 Thrift 服务和客户端。但是,在实际应用中,我们可能会遇到更多的需求和挑战。接下来,我们将深入探讨一些常见的需求和解决方案。

异步编程

随着现代应用对性能和并发的要求越来越高,异步编程变得越来越重要。Rust 提供了强大的异步编程支持,我们可以利用这些特性来提升 Thrift 服务的性能。

使用 tokio 和 async 实现异步 Thrift 服务

tokio 是一个用于异步编程的强大框架。我们可以结合 tokio 和 Rust 的 async 特性来实现异步 Thrift 服务。

首先,确保在 Cargo.toml 文件中添加 tokio 依赖:

[dependencies]
thrift = "0.14.1"
tokio = { version = "1", features = ["full"] }

然后,修改服务器端代码以支持异步:
use thrift::protocol::{TBinaryInputProtocol, TBinaryOutputProtocol};
use thrift::server::TServer;
use thrift::transport::{TBufferedReadTransport, TBufferedWriteTransport, TIoChannel, TTcpChannel, TTcpListener};
use tokio::net::TcpListener;
use tokio::sync::Mutex;
use std::sync::Arc;

mod gen_rs {
    pub mod example;
}

use gen_rs::example::{User, UserServiceAsyncProcessor};

struct UserServiceHandler;

#[async_trait::async_trait]
impl UserServiceAsyncProcessor for UserServiceHandler {
    async fn getUser(&self, id: i32) -> thrift::Result<User> {
        Ok(User { id, name: format!("User{}", id), age: 30 })
    }

    async fn saveUser(&self, user: User) -> thrift::Result<()> {
        println!("User saved: {:?}", user);
        Ok(())
    }
}

#[tokio::main]
async fn main() -> thrift::Result<()> {
    let listener = TcpListener::bind("127.0.0.1:9090").await?;
    let handler = Arc::new(Mutex::new(UserServiceHandler));

    loop {
        let (socket, _) = listener.accept().await?;
        let handler = handler.clone();

        tokio::spawn(async move {
            let (i_prot, o_prot) = (
                TBinaryInputProtocol::new(TBufferedReadTransport::new(TTcpChannel::new(socket))),
                TBinaryOutputProtocol::new(TBufferedWriteTransport::new(TTcpChannel::new(socket))),
            );

            let processor = UserServiceAsyncProcessor::new(handler);

            let mut server = TServer::new(i_prot, o_prot, processor);
            server.serve().await.unwrap();
        });
    }
}

在这个示例中,我们使用 tokio::net::TcpListener 来异步监听连接,并使用 tokio::spawn 来处理每个连接,从而实现并发处理。

使用 TLS 加密通信

在生产环境中,安全性是极为重要的考量。我们可以使用 TLS (传输层安全) 来加密 Thrift 服务的通信。

配置 TLS
首先,确保在 Cargo.toml 文件中添加 tokio-rustls 依赖:

[dependencies]
thrift = "0.14.1"
tokio = { version = "1", features = ["full"] }
tokio-rustls = "0.22"
rustls = "0.20"

然后,生成自签名证书或使用受信任的证书。为了简化演示,我们使用自签名证书:
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes

接着,修改服务器端代码以支持 TLS:

use thrift::protocol::{TBinaryInputProtocol, TBinaryOutputProtocol};
use thrift::server::TServer;
use thrift::transport::{TBufferedReadTransport, TBufferedWriteTransport, TIoChannel, TTcpChannel};
use tokio::net::TcpListener;
use tokio::sync::Mutex;
use tokio_rustls::rustls::{ServerConfig, NoClientAuth, Certificate, PrivateKey};
use tokio_rustls::TlsAcceptor;
use tokio_rustls::rustls::internal::pemfile::{certs, rsa_private_keys};
use std::sync::Arc;
use std::fs::File;
use std::io::{BufReader, self};

mod gen_rs {
    pub mod example;
}

use gen_rs::example::{User, UserServiceAsyncProcessor};

struct UserServiceHandler;

#[async_trait::async_trait]
impl UserServiceAsyncProcessor for UserServiceHandler {
    async fn getUser(&self, id: i32) -> thrift::Result<User> {
        Ok(User { id, name: format!("User{}", id), age: 30 })
    }

    async fn saveUser(&self, user: User) -> thrift::Result<()> {
        println!("User saved: {:?}", user);
        Ok(())
    }
}

#[tokio::main]
async fn main() -> thrift::Result<()> {
    let mut config = ServerConfig::new(NoClientAuth::new());
    let cert_file = &mut BufReader::new(File::("cert.pem")?);
    let key_file = &mut BufReader::new(File::open("key.pem")?);
    let cert_chain = certs(cert_file).map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid cert"))?;
    let mut keys = rsa_private_keys(key_file).map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key"))?;
    config.set_single_cert(cert_chain, keys.remove(0)).map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key"))?;

    let acceptor = TlsAcceptor::from(Arc::new(config));
    let listener = TcpListener::bind("127.0.0.1:9090").await?;
    let handler = Arc::new(Mutex::new(UserServiceHandler));

    loop {
        let (socket, _) = listener.accept().await?;
        let handler = handler.clone();
        let acceptor = acceptor.clone();

        tokio::spawn(async move {
            let tls_socket = acceptor.accept(socket).await.unwrap();
            let (i_prot, o_prot) = (
                TBinaryInputProtocol::new(TBufferedReadTransport::new(TTcpChannel::new(tls_socket))),
                TBinaryOutputProtocol::new(TBufferedWriteTransport::new(TTcpChannel::new(tls_socket))),
            );

            let processor = UserServiceAsyncProcessor::new(handler);

            let mut server = TServer::new(i_prot, o_prot, processor);
            server.serve().await.unwrap();
        });
    }
}

使用 TLS 的客户端代码类似,只需在创建连接时使用 tokio-rustls 的 TlsConnector 来进行加密连接。

总结

本文详细介绍了如何在 Rust 项目中集成 Apache Thrift,以及如何通过异步编程和 TLS 实现更高效和安全的服务通信。Rust 和 Thrift 的结合为开发者提供了一种可靠的跨语言通信解决方案,能够满足现代分布式系统的高性能和高安全性需求。希望通过本文的教程,开发者能够更好地理解和应用 Rust 和 Thrift,实现高效的分布式系统开发。

;