Uniffi-rs 中结构体与构造函数的正确使用方式

在 Rust 与 Swift 的跨语言交互中，Uniffi-rs 是一个强大的工具，但开发者在使用过程中可能会遇到一些关于结构体和构造函数的困惑。本文将深入探讨如何正确地在 Uniffi-rs 中定义和使用结构体及其构造函数。

结构体与对象的区别

Uniffi-rs 对结构体（Record）和对象（Object）有着明确的区分。结构体主要用于简单的数据封装，而对象则支持更复杂的行为和方法实现。

对于简单的数据封装，可以直接使用 #[derive(uniffi::Record)] 来定义结构体：

#[derive(uniffi::Record)]
pub struct FzilInput {
    pub bytes: Vec<u8>
}

这种定义方式会自动为 Swift 端生成相应的结构体，并支持基本的字段访问。

构造函数的限制

当我们需要为类型添加构造函数时，需要注意 Uniffi-rs 的一个重要限制：只有对象类型（Object）才能拥有导出的实现块（impl block）和构造函数。这意味着如果我们尝试为一个记录类型（Record）添加构造函数，会遇到编译错误。

错误示例：

#[uniffi::export]
impl FzilInput {
    #[uniffi::constructor]
    pub fn new(bytes: Vec<u8>) -> Self {
        Self { bytes }
    }
}

这种写法会导致错误，因为 FzilInput 是一个记录类型而非对象类型。

正确的对象定义方式

如果需要使用构造函数，我们应该将类型定义为对象：

#[derive(uniffi::Object)]
pub struct FzilInput {
    bytes: Vec<u8>
}

#[uniffi::export]
impl FzilInput {
    #[uniffi::constructor]
    pub fn new(bytes: Vec<u8>) -> Arc<Self> {
        Arc::new(Self { bytes })
    }
    
    pub fn get_bytes(&self) -> Vec<u8> {
        self.bytes.clone()
    }
}

注意这里的关键变化：

1. 使用 #[derive(uniffi::Object)] 而非 Record
2. 构造函数返回 Arc<Self> 而非 Self
3. 字段默认私有，需要通过方法暴露

Swift 端的使用

在 Swift 端，这样的对象可以这样使用：

let bytes: [UInt8] = [0x01, 0x02, 0x03]
let input = FzilInput(bytes: bytes)
let retrievedBytes = input.getBytes()

对于字节数组（Vec），Uniffi-rs 会自动处理为 Swift 中的 [UInt8] 类型。

设计建议

1. 简单数据传输：如果只需要传递数据，使用 Record 结构体更轻量级
2. 需要方法实现：如果需要添加方法或构造函数，使用 Object 类型
3. 性能考虑：频繁创建的对象考虑使用 Arc 引用计数
4. 数据封装：对象字段默认私有，通过方法暴露更安全

理解这些区别和限制，可以帮助开发者更有效地使用 Uniffi-rs 进行 Rust 和 Swift 之间的互操作开发。