Flutter Rust Bridge 中生成 Freezed 模型的 JSON 序列化方法

在 Flutter Rust Bridge 项目中，开发者经常需要将 Rust 结构体转换为 Dart 类，并希望这些类能够支持 JSON 序列化和反序列化。本文将详细介绍如何正确配置以生成这些方法。

问题背景

当使用 Flutter Rust Bridge 时，开发者可能会遇到以下情况：

1. 在 Rust 端定义了带有 #[frb(dart_metadata=("freezed"))] 注解的结构体
2. 期望生成的 Dart 类能够自动包含 fromJson 和 toJson 方法
3. 尝试了多种配置方式但未能成功生成这些方法

解决方案

1. 确保使用最新版本

首先需要确认使用的是最新版本的 Flutter Rust Bridge 工具链。旧版本可能不支持某些功能或存在已知问题。

2. 正确配置 JSON 序列化

在 Rust 结构体上，除了 freezed 注解外，还需要添加 json_serializable 注解：

#[frb(dart_metadata=("freezed", "json_serializable"))]
pub struct TransactionCompat {
    // 字段定义
}

3. 配置 build.yaml 文件

在项目的 build.yaml 文件中，需要正确配置 JSON 序列化选项：

targets:
  $default:
    builders:
      freezed:
        generate_for:
          - lib/generated/**.dart
      json_serializable:
        options:
          explicit_to_json: true
          create_to_json: true
        generate_for:
          - lib/generated/**.dart

常见问题排查

1. 版本不一致：确保 flutter_rust_bridge 和 flutter_rust_bridge_codegen 版本一致且为最新
2. 注解格式错误：检查 dart_metadata 注解的格式是否正确
3. 构建配置缺失：确认 build.yaml 文件已正确配置并放置在项目根目录

实现原理

Flutter Rust Bridge 通过代码生成器将 Rust 结构体转换为 Dart 类。当添加 freezed 和 json_serializable 注解时：

1. freezed 注解会生成不可变的数据类
2. json_serializable 注解会生成 JSON 序列化相关代码
3. 构建系统会根据配置自动处理这些注解并生成相应代码

最佳实践

1. 始终使用最新稳定版本的 Flutter Rust Bridge
2. 为需要 JSON 序列化的类同时添加 freezed 和 json_serializable 注解
3. 定期检查构建配置是否与最新文档一致
4. 在大型项目中，考虑将序列化相关配置集中管理

通过以上配置，开发者可以轻松实现 Rust 结构体与 Dart 类之间的双向 JSON 转换，大大简化了跨语言数据交换的过程。