Flutter Rust Bridge 中自定义日志结构与流式传输的实践与问题排查

前言

在使用 Flutter Rust Bridge 进行跨平台开发时，开发者经常会遇到需要将 Rust 端的日志信息实时传输到 Flutter 端的需求。本文将详细介绍如何实现这一功能，以及在实现过程中可能遇到的问题及其解决方案。

自定义日志结构设计

首先，我们需要在 Rust 端定义一个日志结构体，用于承载日志信息：

#[frb]
pub struct LogEntry {
    #[frb(name = "type")]
    pub type_: String,
    pub message: String,
    pub time: String,
}

这个结构体包含三个字段：

• type_: 日志类型（如 ERROR、WARN、INFO）
• message: 日志内容
• time: 日志时间戳

流式日志传输实现

在 Rust 端，我们可以创建一个流式日志生成器，定期产生日志事件：

use chrono::Local;

pub fn on_tick(sink: StreamSink<LogEntry>) -> Result<()> {
    let mut ticks = 0;
    let event_types = ["ERROR", "WARN", "INFO"];
    loop {
        let event_type = event_types[ticks % 3].to_string();
        let log_entry = LogEntry {
            type_: event_type.clone(),
            message: format!("this is a `{}` msg.", event_type),
            time: Local::now().format("%Y-%m-%d %H:%M:%S.%2f").to_string(),
        };
        sink.add(log_entry);
        sleep(Duration::from_secs(1));
        if ticks == usize::MAX {
            break;
        }
        ticks += 1;
    }
    Ok(())
}

Flutter 端接收日志

在 Flutter 端，我们可以这样接收并处理日志流：

void startLogStream() {
    api.onTick().listen((logEntry) {
      try {
        // 处理日志条目
      } catch (e) {
        print('处理日志条目时出错: $e');
      }
    }, onError: (error) {
      print('日志流错误: $error');
    });
}

常见问题与解决方案

1. 时间格式化问题

在最初的实现中，使用 Local::now().format("%Y-%m-%d %H:%M:%S.%2f") 会导致 panic。这是因为 %2f 不是有效的格式化字符串。正确的做法是：

use time::{format_description, OffsetDateTime};

let format = format_description::parse(
    "[year]-[month]-[day] [hour]:[minute]:[second].[subsecond digits:2]",
).unwrap();

let time_str = OffsetDateTime::now_local()
    .unwrap()
    .format(&format)
    .unwrap();

2. 错误堆栈不清晰

当出现 panic 时，Dart 端的错误堆栈可能不够清晰。可以通过以下方式获取更详细的 Rust 堆栈信息：

#[frb(init)]
pub fn lets_init_app_here() {
    std::env::set_var("RUST_BACKTRACE", "full");
}

3. 流式传输稳定性

为确保流式传输的稳定性，建议：

• 添加错误处理：sink.add(log_entry).expect("添加日志出错");
• 控制日志频率：避免过高的日志频率导致性能问题
• 实现优雅关闭：确保在应用退出时能正确关闭流

最佳实践建议

1. 日志结构设计：

   • 保持字段命名一致性（Rust 和 Dart 端）
   • 使用标准时间格式
   • 添加必要的元数据字段

2. 错误处理：

   • Rust 端应处理所有可能的错误
   • Dart 端应捕获并处理异常
   • 添加日志记录失败的恢复机制

3. 性能优化：

   • 考虑使用缓冲机制批量传输日志
   • 对于高频日志，考虑采样或聚合
   • 实现日志级别过滤

总结

通过 Flutter Rust Bridge 实现 Rust 到 Flutter 的日志流式传输是一个强大而实用的功能。在实现过程中，开发者需要注意时间格式化、错误处理和性能优化等关键点。本文介绍的方法和解决方案可以帮助开发者构建稳定、高效的跨平台日志系统。