UniFFI-RS 中处理 Box 类型的最佳实践

在使用 UniFFI-RS 进行跨语言绑定时，开发者可能会遇到需要处理大型结构体的情况。Rust 的 clippy 工具通常会建议使用 Box 来包装这些"胖"结构体以优化内存使用。然而，当这些被 Box 包装的类型需要与 UniFFI 交互时，会遇到一些特殊的挑战。

问题背景

当尝试为 Box<T> 类型实现 uniffi::Record 时，编译器会报错提示 Box<T> 没有实现 Lower<UniFfiTag> trait。这是因为 UniFFI 的设计中，Box<T> 并不是一个可以直接暴露给外部语言的原生类型。

根本原因

UniFFI 的 custom_type! 宏目前无法正确处理包含尖括号(< 和 >)的类型名称。这意味着直接尝试为 Box<Recipient> 这样的类型定义自定义类型转换会失败。

解决方案

正确的处理方式是使用类型别名来间接引用 Box 包装的类型：

// 首先定义一个类型别名
pub type BoxedRecipient = Box<Recipient>;

// 然后为这个别名注册自定义类型
uniffi::custom_type!(BoxedRecipient, String);

之后，按照常规方式实现 UniffiCustomTypeConverter trait：

impl crate::UniffiCustomTypeConverter for BoxedRecipient {
    type Builtin = String;

    fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
        // 实现从基础类型到自定义类型的转换逻辑
        todo!()
    }

    fn from_custom(obj: Self) -> Self::Builtin {
        // 实现从自定义类型到基础类型的转换逻辑
        todo!()
    }
}

设计考量

这种设计选择有几个重要原因：

1. 类型清晰性：在生成的绑定代码中，BoxedRecipient 比 Box<Recipient> 更清晰地表达了意图
2. 一致性：与 UniFFI 处理其他复合类型的方式保持一致
3. 可扩展性：如果需要修改内部实现（比如将来不再使用 Box），外部接口可以保持不变

最佳实践建议

1. 对于需要跨语言边界传递的大型结构体，优先考虑使用 Box 包装
2. 为 Box 包装的类型创建有意义的别名，提高代码可读性
3. 在实现转换逻辑时，注意处理可能的错误情况
4. 考虑为这些类型添加适当的文档，说明其设计目的和使用方式

通过遵循这些模式，开发者可以有效地在 UniFFI 项目中管理内存使用，同时保持清晰的跨语言接口。