Flutter JSON转Dart模型插件json2dart_viewerffi的使用

json2dart_viewerffi 是一个用于将 JSON 数据转换为 Dart 模型的插件。它可以帮助开发者快速生成 Dart 类，从而简化 JSON 数据的处理过程。以下是使用 json2dart_viewerffi 插件的步骤：

1. 安装插件

首先，你需要在 pubspec.yaml 文件中添加 json2dart_viewerffi 依赖：

dependencies:
  json2dart_viewerffi: ^1.0.0 # 请根据实际情况选择最新版本

然后运行 flutter pub get 来安装依赖。

2. 使用插件生成 Dart 模型

json2dart_viewerffi 提供了一个命令行工具来生成 Dart 模型。你可以通过以下步骤来使用它：

2.1 创建一个 JSON 文件

首先，你需要准备一个 JSON 文件，例如 example.json：

{
  "name": "John Doe",
  "age": 30,
  "email": "john.doe@example.com",
  "isActive": true,
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "555-555-5555"
    },
    {
      "type": "work",
      "number": "555-555-1234"
    }
  ]
}

2.2 使用命令行工具生成 Dart 模型

在终端中运行以下命令来生成 Dart 模型：

flutter pub run json2dart_viewerffi:generate -i example.json -o example_model.dart -c ExampleModel

• -i: 输入 JSON 文件路径。
• -o: 输出 Dart 文件路径。
• -c: 生成的 Dart 类名。

2.3 查看生成的 Dart 模型

生成的 example_model.dart 文件内容如下：

class ExampleModel {
  String? name;
  int? age;
  String? email;
  bool? isActive;
  Address? address;
  List<PhoneNumbers>? phoneNumbers;

  ExampleModel({
    this.name,
    this.age,
    this.email,
    this.isActive,
    this.address,
    this.phoneNumbers,
  });

  ExampleModel.fromJson(Map<String, dynamic> json) {
    name = json['name'];
    age = json['age'];
    email = json['email'];
    isActive = json['isActive'];
    address = json['address'] != null ? Address.fromJson(json['address']) : null;
    if (json['phoneNumbers'] != null) {
      phoneNumbers = <PhoneNumbers>[];
      json['phoneNumbers'].forEach((v) {
        phoneNumbers!.add(PhoneNumbers.fromJson(v));
      });
    }
  }

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = <String, dynamic>{};
    data['name'] = name;
    data['age'] = age;
    data['email'] = email;
    data['isActive'] = isActive;
    if (address != null) {
      data['address'] = address!.toJson();
    }
    if (phoneNumbers != null) {
      data['phoneNumbers'] = phoneNumbers!.map((v) => v.toJson()).toList();
    }
    return data;
  }
}

class Address {
  String? street;
  String? city;
  String? state;
  String? zip;

  Address({
    this.street,
    this.city,
    this.state,
    this.zip,
  });

  Address.fromJson(Map<String, dynamic> json) {
    street = json['street'];
    city = json['city'];
    state = json['state'];
    zip = json['zip'];
  }

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = <String, dynamic>{};
    data['street'] = street;
    data['city'] = city;
    data['state'] = state;
    data['zip'] = zip;
    return data;
  }
}

class PhoneNumbers {
  String? type;
  String? number;

  PhoneNumbers({
    this.type,
    this.number,
  });

  PhoneNumbers.fromJson(Map<String, dynamic> json) {
    type = json['type'];
    number = json['number'];
  }

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = <String, dynamic>{};
    data['type'] = type;
    data['number'] = number;
    return data;
  }
}

3. 使用生成的 Dart 模型

你可以在你的 Flutter 项目中使用生成的 Dart 模型来解析和生成 JSON 数据。

import 'example_model.dart';

void main() {
  var json = {
    "name": "John Doe",
    "age": 30,
    "email": "john.doe@example.com",
    "isActive": true,
    "address": {
      "street": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345"
    },
    "phoneNumbers": [
      {
        "type": "home",
        "number": "555-555-5555"
      },
      {
        "type": "work",
        "number": "555-555-1234"
      }
    ]
  };

  var exampleModel = ExampleModel.fromJson(json);
  print(exampleModel.name); // 输出: John Doe

  var jsonOutput = exampleModel.toJson();
  print(jsonOutput); // 输出: 转换后的 JSON 数据
}