为什么还需要另一种序列化格式？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；
• 所有无序容器（哈希表/哈希集合）按键（如果有值冲突则按值）的字典顺序排序；
• 结构体按照结构体中的字段顺序序列化；
• 枚举使用u8来序列化枚举序号，然后存储枚举值内部的数据（如果存在）。

形式规范

注意

• 一些Rust语法的部分尚未形式化，例如枚举和变体。我们反向推导Rust语法的EBNF形式，来自syn类型；
• 我们不得不扩展EBNF的重复次数，而不是将它们定义为[ ident_field ':' ident_type ',' ] *，而是将它们定义为ident_field0 ':' ident_type0 ',' ident_field1 ':' ident_type1 ',' ...，以便我们可以引用伪代码中的各个元素；
• 我们使用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