Flutter JSON事件处理插件json_events的使用

插件简介

json_events 是一个用于解析大型JSON文件/对象的Dart包。该包以单向方式处理JSON，并根据遇到的标记（tokens）发出事件。它适用于需要高效解析大型JSON数据的场景，特别适合在Flutter应用中处理流式或大体量的JSON数据。

注意事项

⚠️ 为了支持Web端，此库不支持非常大的数字。请检查Dart与JavaScript之间的数字兼容性问题。

使用方法

手动解析

从 Stream 解析

Stream<List<int>> s = ...;

await for (JsonEvent je in s
    .transform(const Utf8Decoder())
    .transform(const JsonEventDecoder())
    .flatten()) {
  print("Event Type: ${je.type.name} Value: ${je.value}");
}

从 String 解析

Stream<String> s = Stream.value(...);

await for (JsonEvent je in s.transform(const JsonEventDecoder()).flatten()) {
  print("Event Type: ${je.type.name} Value: ${je.value}");
}

使用 Mixin

对象类使用示例

class MyClass with JsonObjectTraverser {
  late int x;
  late List<MyClass> arr;
  late List<int> pArr;
  late List<List<int>> pNestedArray;
  String? text;

  @override
  Future<void> readJson(String key) async {
    switch (key) {
      case "x":
        x = await this.readPropertyJsonContinue<int>();
      case "arr":
        arr = await this.readArrayJsonContinue<MyClass>(creator: MyClass.new).toList();
      case "pArr":
        pArr = await this.readArrayJsonContinue<int>().toList();
      case "pNestedArray":
        pNestedArray = await this.readNestedArrayJsonContinue<List<int>, int>().toList();
      case "text":
        text = await this.readPropertyJsonContinue<String?>();
    }
  }
}

// 调用加载器
MyClass mc = MyClass();
await mc.loadJson(streamIterator);

数组类使用示例

import "package:collection/collection.dart";

class MyArrayClass extends DelegatingList<MyClass> with JsonArrayTraverser<MyClass> {
  @override
  FutureOr<MyClass> Function()? get creator => MyClass.new;

  MyArrayClass() : super([]);
}

// 调用加载器
MyArrayClass mc = MyArrayClass();
await mc.loadJsonFromStream(stream);

示例代码

下面是一个完整的示例代码，展示了如何使用 json_events 包来解析一个JSON字符串并打印出每个事件的类型和值：

import "dart:async";
import "package:json_events/json_events.dart";

Future<void> main() async {
  String jsonString = """
  {
    "compressionlevel": -1,
    "height": 32,
    "infinite": false,
    "layers": [
      {
        "id": 16,
        "image": "../images/background.jpg",
        "name": "Image Layer 1",
        "opacity": 1,
        "type": "imagelayer",
        "visible": true,
        "x": 0,
        "y": 0,
        "a": {
          "b": "1",
          "c": "2"
        }
      }
    ],
    "fields": [
      "16",
      "20",
      "32"
    ],
    "width": 32
  }
  """;

  Stream<JsonEvent> s = Stream<String>.value(jsonString)
      .transform(const JsonEventDecoder())
      .flatten();

  await for (JsonEvent je in s) {
    // ignore: avoid_print
    print("Event Type: ${je.type.name} Value: ${je.value}");
  }
}

声明

• 大部分解析代码来自 Dart SDK
• 受到 dart-json-stream-parser 的启发
• 测试用例来自 JSONTestSuite

通过上述内容，您可以了解如何在Flutter项目中使用 json_events 插件进行高效的JSON解析。希望这些信息对您有所帮助！