Flutter Rust Bridge 中 StreamSink 错误处理的最佳实践

在使用 Flutter Rust Bridge 进行跨语言开发时，StreamSink 是一个常用的工具，用于在 Rust 和 Dart 之间建立数据流通道。然而，开发者经常会遇到一个常见问题：当 Rust 端返回错误时，Dart 端无法捕获这些错误。

问题背景

在 Rust 端定义一个使用 StreamSink 的方法时，如：

pub fn sftp_upload_file(attr: String, remote_path: String, local_path: String, sink: StreamSink<(u64, u64)>) -> Result<(), SessionError> {
    // 业务逻辑
}

对应的 Dart 端生成的代码会返回一个 Stream。开发者通常期望使用 try-catch 来捕获可能的错误：

try {
    final stream = rust.crateApiSshSftpUploadFile(...);
    await for (var item in stream) {
        // 处理数据
    }
} catch (e) {
    // 期望捕获错误，但实际上不会执行
}

然而，这种错误处理方式并不能捕获 Rust 端返回的错误。

解决方案

方案一：使用枚举类型封装数据和错误

最直接的解决方案是修改返回类型，将数据和错误都封装在一个枚举类型中：

pub enum UploadProgress {
    Data(u64, u64),
    Error(String),
}

pub fn sftp_upload_file(..., sink: StreamSink<UploadProgress>) -> Result<(), SessionError> {
    // 业务逻辑
    if let Err(e) = some_operation() {
        sink.add(UploadProgress::Error(e.to_string()));
        return Ok(());
    }
    // 正常处理
    sink.add(UploadProgress::Data(current, total));
    Ok(())
}

Dart 端可以这样处理：

await for (var item in stream) {
    switch (item) {
        case Data(:final field0, :final field1):
            // 处理进度数据
        case Error(:final field0):
            // 处理错误
    }
}

这种方式的优点是：

1. 实现简单直接
2. 可以自定义错误类型和数据结构
3. 错误处理逻辑清晰可见

方案二：扩展 StreamSink 功能（高级方案）

更优雅的解决方案是扩展 StreamSink 的功能，使其支持直接发送错误。这需要修改 Flutter Rust Bridge 的源码，添加类似 add_error 的方法：

impl<T> StreamSink<T> {
    pub fn add_error(&self, error: String) {
        // 实现将错误发送到 Dart 端
    }
}

这样 Rust 端可以：

if let Err(e) = operation() {
    sink.add_error(e.to_string());
    return Ok(());
}

Dart 端则可以保持原有的 try-catch 结构：

try {
    await for (var item in stream) {
        // 处理数据
    }
} catch (e) {
    // 现在可以捕获到错误了
}

方案选择建议

对于大多数开发者，特别是 Rust 新手，推荐使用第一种方案。它不需要修改框架代码，实现简单，且错误处理逻辑明确。

第二种方案更适合有 Rust 开发经验的开发者，或者需要更符合 Dart 习惯的错误处理方式的场景。如果你选择这种方案，可以考虑向 Flutter Rust Bridge 项目提交 Pull Request，贡献这个功能。

总结

在 Flutter Rust Bridge 中使用 StreamSink 时，错误处理需要特别注意。通过封装枚举类型是最简单可靠的解决方案，而扩展 StreamSink 功能则提供了更符合 Dart 习惯的 API。开发者应根据项目需求和自身技术能力选择合适的方案。