Rust Thrift库

概述

此crate实现了构建工作Thrift服务器和客户端所需的所有组件。它分为以下模块

1. 错误
2. 协议
3. 传输
4. 服务器
5. 自动生成

模块按照以下方式分层。生成的层是Thrift编译器Rust插件的代码生成的。它使用此crate中定义的组件来序列化和反序列化类型并实现RPC。用户通过编写自己的代码与这些类型和服务交互。

+-----------+
|  app dev  |
+-----------+
| generated | <-> errors/results
+-----------+
|  protocol |
+-----------+
| transport |
+-----------+

使用此crate

将 thrift = "x.y.z" 添加到您的 Cargo.toml，其中 x.y.z 是您正在使用的Thrift编译器的版本。

API文档

完整的 Rustdoc

兼容性

此Rust库和自动生成的代码针对Rust版本1.28+。它目前不使用任何Rust 2018功能。

重大更改

重大更改已最小化。当它们发生时，它们将在下面概述，并附带过渡指南。

Thrift 0.15.0

• [THRIFT-5360] - 对于 Error 类型，不再定义或生成 description() 方法。

  Error.description() 在 1.27 版本中被软弃用，并在 1.41 版本中正式弃用。库的错误类型也不实现 Error.description()。因此，由于这个变化，生成的 Rust Error 表示不再实现 Error.description() 方法。相反，它生成一个包含相同信息的 Display 实现。

  例如

  exception Xception {
    1: i32 errorCode,
    2: string message
  }
  

  曾经生成

  use std::error::Error;
  use std::fmt;
  use std::fmt::{Display, Formatter};
  
  // auto-generated by the Thrift compiler
  #[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
  pub struct Xception {
    pub error_code: Option<i32>,
    pub message: Option<String>,
  }
  
  // auto-generated by the Thrift compiler
  impl Error for Xception {
    fn description(&self) -> &str {
      "remote service threw Xception"
    }
  }
  
  // auto-generated by the Thrift compiler
  impl From<Xception> for thrift::Error {
    fn from(e: Xception) -> Self {
      thrift::Error::User(Box::new(e))
    }
  }
  
  // auto-generated by the Thrift compiler
  impl Display for Xception {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
      self.description().format(f)
    }
  }
  

  现在它生成

  use std::error::Error;
  use std::fmt;
  use std::fmt::{Display, Formatter};
  
  // auto-generated by the Thrift compiler
  #[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
  pub struct Xception {
    pub error_code: Option<i32>,
    pub message: Option<String>,
  }
  
  // auto-generated by the Thrift compiler
  impl Error for Xception { }
  
  // auto-generated by the Thrift compiler
  impl From<Xception> for thrift::Error {
    fn from(e: Xception) -> Self {
      thrift::Error::User(Box::new(e))
    }
  }
  
  // auto-generated by the Thrift compiler
  impl Display for Xception {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
      write!(f, "remote service threw Xception")
    }
  }
  

• [THRIFT-5314] - 生成与未来兼容的枚举实现（即不因未知值而报错）

  由于这个变化，枚举的 Rust 表示从标准的 Rust 枚举变为带有关联常量的新类型结构体。

  例如

    // THRIFT
    enum Operation {
      ADD,
      SUBTRACT,
      MULTIPLY,
      DIVIDE,
    }
  

  曾经生成

    // OLD AUTO-GENERATED RUST
    pub enum Operation {
       Add,
       Subtract,
       Multiply,
       Divide,
     }
  

  现在它生成

    // NEW AUTO-GENERATED RUST
    pub struct Operation(pub i32);
  
    impl Operation {
      pub const ADD: Operation = Operation(0);
      pub const SUBTRACT: Operation = Operation(1);
      pub const MULTIPLY: Operation = Operation(2);
      pub const DIVIDE: Operation = Operation(3);
    }
  

Thrift 0.14.0

• [THRIFT-5158] - Rust 库和生成器现在只支持 Rust 2018。需要 rust 1.40.0 或更高版本

  将 Rust thrift 库更新到 Rust 2018 通过 cargo fix --edition。仓库中的所有测试代码也已更新。代码生成器也已更新以只支持 Rust 2018。

Thrift 0.13.0

• [THRIFT-4536] - 使用 std 中的 TryFrom，需要 rust 1.34.0 或更高版本

  之前 TryFrom 来自 try_from crate，现在来自 std 库，但此功能仅在 rust 1.34.0 中可用。此外，ordered-float 现在在 thrift 模块下重新导出，以减少可能的依赖不匹配。

Thrift 0.12.0

• [THRIFT-4529] - Rust 枚举变体现在使用驼峰命名法而不是大写命名法，以符合 Rust 命名约定

  以前，自动生成的代码中的枚举变体都是大写的。例如，以下 thrift 枚举

  // THRIFT
  enum Operation {
    ADD,
    SUBTRACT,
    MULTIPLY,
    DIVIDE,
  }
  

  曾经生成

  // OLD AUTO-GENERATED RUST
  pub enum Operation {
     ADD,
     SUBTRACT,
     MULTIPLY,
     DIVIDE,
   }
  

  现在它生成

  // NEW AUTO-GENERATED RUST
  pub enum Operation {
     Add,
     Subtract,
     Multiply,
     Divide,
   }
  

  您需要将代码中的所有枚举变体更改为使用驼峰命名。这应该是一个搜索和替换。

贡献

欢迎提交错误报告和 PR！请参阅 Thrift 网站 获取更多详细信息。

Thrift Rust 支持需要几个目录中的代码

• compiler/cpp/src/thrift/generate/t_rs_generator.cc：绑定代码生成器
• lib/rs：运行时库
• lib/rs/test：补充测试
• tutorial/rs：教程客户端和服务器
• test/rs：跨语言测试客户端和服务器

所有库代码、测试代码和自动生成的代码在编译并通过 clippy 时没有警告。所有新代码都必须如此！在做出更改时，请确保

• rustc 不输出任何警告
• clippy 在默认设置下不输出任何警告（包括自动生成的代码）
• cargo test 执行成功
• make precross 和 make check 执行成功
• tutorial/bin/tutorial_client 和 tutorial/bin/tutorial_server 通信