我们为什么还需要另一种序列化格式？Borsh是第一个优先考虑以下对于安全关键型项目至关重要的特性的序列化器

• 一致且明确的二进制表示
  • 一致意味着对象与其二进制表示之间存在一一映射。没有两个二进制表示可以反序列化为同一个对象。这对于使用二进制表示来计算哈希的应用程序非常有用；
  • Borsh附带了一份完整的规范，可用于其他语言的实现；
• 安全。Borsh实现使用安全的编码实践。在Rust中，Borsh几乎只使用安全的代码，只有一个例外，即使用 unsafe 以避免耗尽攻击；
• 速度。在Rust中，Borsh通过放弃使用 Serde 来实现高性能，在某些情况下比 bincode 更快；这也减少了代码的大小。

示例

use oasis_borsh::{BorshSerialize, BorshDeserialize};

#[derive(BorshSerialize, BorshDeserialize, PartialEq, Debug)]
struct A {
    x: u64,
    y: String,
}

#[test]
fn test_simple_struct() {
    let a = A {
        x: 3301,
        y: "liber primus".to_string(),
    };
    let encoded_a = a.try_to_vec().unwrap();
    let decoded_a = A::try_from_slice(&encoded_a).unwrap();
    assert_eq!(a, decoded_a);
}

特性

放弃使用Serde允许borsh具有一些当前对Serde兼容序列化器不可用的特性。目前我们支持两个特性：borsh_init 和 borsh_skip（前者在Serde中不可用）。

borsh_init 允许在反序列化后自动运行初始化函数。这为严格不可变对象提供了很多便利。使用示例

#[derive(BorshSerialize, BorshDeserialize)]
#[borsh_init(init)]
struct Message {
    message: String,
    timestamp: u64,
    public_key: CryptoKey,
    signature: CryptoSignature
    hash: CryptoHash
}

impl Message {
    pub fn init(&mut self) {
        self.hash = CryptoHash::new().write_string(self.message).write_u64(self.timestamp);
        self.signature.verify(self.hash, self.public_key);
    }
}

borsh_skip 允许跳过序列化/反序列化字段，假设它们实现了 Default 特性，类似于 #[serde(skip)]。

#[derive(BorshSerialize, BorshDeserialize)]
struct A {
    x: u64,
    #[borsh_skip]
    y: f32,
}

基准测试

我们在关注最多的区块链项目对象（区块、区块头、交易、账户）上进行了以下基准测试：我们采用了 nearprotocol 区块链的对象结构。我们使用了 Criterion 来构建以下图表。

基准测试在 Google Cloud n1-standard-2 (2 vCPUs, 7.5 GB memory) 上运行。

区块头序列化速度与区块头字节大小（大小仅大致对应序列化复杂度，导致图形不平滑）的关系

区块头反序列化速度与区块头字节大小的关系

区块序列化速度与区块字节大小的关系

区块反序列化速度与区块字节大小的关系

查看完整报告 这里。

规范

简而言之，Borsh 是一种非自描述的二进制序列化格式。它设计用于将任何对象序列化为规范且确定的字节集。

一般原则

• 整数是低位字节序；
• 动态容器的大小作为 u32 写在值之前；
• 所有无序容器（hashmap(hashset)）按键的字典顺序排序（在解决冲突的情况下按值排序）；
• 结构体按结构体中的字段顺序序列化；
• 枚举使用 u8 对枚举序号进行序列化，然后存储枚举值中的数据（如果存在）。

形式规范

注意

• Rust 语法的一些部分尚未正式化，如枚举和变体。我们逆向推导 Rust 语法 EBNF 形式，从 syn 类型;
• 我们不得不扩展 EBNF 的重复次数，而不是将它们定义为 [ 标识字段 ':' 标识类型 ',' ] *，而是定义为 标识字段0 ':' 标识类型0 ',' 标识字段1 ':' 标识类型1 ',' ...，这样我们就可以在伪代码中引用单个元素；
• 我们使用 repr() 函数来表示我们将给定元素的表示写入一个虚拟缓冲区。

发布

在你将更改合并到主分支并提高所有三个 crate 的版本后，是时候正式发布新版本了。

确保 borsh，borsh-derive 和 borsh-derive-internal 都有新的 crate 版本。然后导航到每个文件夹并按顺序运行（

cd ../borsh-derive-internal; cargo publish
cd ../borsh-derive; cargo publish
cd ../borsh; cargo publish

确保你在主分支上，然后标记代码并推送标记

git tag -a v9.9.9 -m "My superawesome change."
git push origin v9.9.9