Flutter JSON解析与分析插件ejson_analyzer的使用

在Flutter开发中，JSON解析是一个常见的需求。ejson_analyzer 是一个强大的插件，可以帮助开发者自动生成JSON解析的代码，从而简化开发流程并减少手动编写代码的工作量。

插件安装

首先，在 pubspec.yaml 文件中添加 ejson_analyzer 依赖：

dependencies:
  ejson_analyzer: ^1.0.0  # 请根据最新版本更新此行

dev_dependencies:
  build_runner: ^2.0.0   # 用于生成代码

然后运行以下命令以安装依赖：

flutter pub get

创建数据模型

假设我们有以下JSON数据结构：

{
  "name": "John Doe",
  "age": 30,
  "isStudent": false,
  "skills": ["Dart", "Flutter"]
}

我们需要为这些数据创建一个对应的 Dart 类。首先，定义一个简单的类：

// person.dart
class Person {
  String name;
  int age;
  bool isStudent;
  List<String> skills;

  Person({this.name, this.age, this.isStudent, this.skills});
}

使用ejson_analyzer生成解析代码

为了生成JSON解析代码，我们需要在类上添加注解，并运行代码生成工具。

添加注解

在 Person 类中，使用 @JsonSerializable 注解，并导入 json_annotation 包：

import 'package:json_annotation/json_annotation.dart';

part 'person.g.dart';  // 自动生成的文件名

@JsonSerializable()
class Person {
  String name;
  int age;
  bool isStudent;
  List<String> skills;

  Person({this.name, this.age, this.isStudent, this.skills});

  // 自动生成的工厂方法
  factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
  Map<String, dynamic> toJson() => _$PersonToJson(this);
}

生成代码

运行以下命令来生成解析代码：

flutter pub run build_runner build

执行成功后，会生成一个 person.g.dart 文件，其中包含了 fromJson 和 toJson 方法的实现。

使用生成的代码

现在我们可以轻松地将JSON字符串解析为 Person 对象，也可以将 Person 对象序列化为JSON字符串。

解析JSON

void main() {
  // 原始JSON字符串
  String jsonString = '''
  {
    "name": "John Doe",
    "age": 30,
    "isStudent": false,
    "skills": ["Dart", "Flutter"]
  }
  ''';

  // 将JSON字符串解析为Person对象
  Person person = Person.fromJson(json.decode(jsonString));

  // 输出解析结果
  print('Name: ${person.name}, Age: ${person.age}, Student: ${person.isStudent}, Skills: ${person.skills}');
}

序列化为JSON

void main() {
  // 创建Person对象
  Person person = Person(
    name: 'John Doe',
    age: 30,
    isStudent: false,
    skills: ['Dart', 'Flutter'],
  );

  // 将Person对象序列化为JSON字符串
  Map<String, dynamic> jsonMap = person.toJson();
  String jsonString = json.encode(jsonMap);

  // 输出JSON字符串
  print('JSON String: $jsonString');
}