Flutter JSON生成插件otter_json_generator的使用

Otter JSON

JSON序列化与代码生成。

目录

• 为什么使用它
• 如何使用
• 链接
• 作者

为什么使用它

你是否曾为json_serializable所困扰？所有生成的代码和’part’会使你的源代码变得混乱。使用Otter JSON，保持一切简单且整洁。

特性

• 生成的代码和源代码分离
• 轻松注册新的序列化器
• 支持所有原生类型
• 支持Flutter常见类
• 支持列表
• 支持嵌套对象

如何使用

依赖项

在pubspec.yaml文件中添加以下依赖项：

dependencies:
  otter_json:

dev_dependencies:
  build_runner:
  otter_json_generator:

注解

在需要序列化的类上添加@JSON注解：

@JSON
class Person {
  String firstName;
  String lastName;
}

生成

运行以下命令来生成序列化代码：

flutter pub run build_runner build

注册

在应用启动时注册生成的序列化模块：

Otter.module(GeneratedJsonModule());

toJson, fromJson

使用Otter.toJson和Otter.fromJson方法进行序列化和反序列化：

Map<String, dynamic> map = Otter.toJson(Person());
Person person = Otter.fromJson({});

自定义序列化器

如果你需要自定义序列化逻辑，可以创建一个实现JsonSerializer接口的类：

class ColorSerializer implements JsonSerializer<Color, int> {
  [@override](/user/override)
  Color decode(int output) {
    return Color(output);
  }

  [@override](/user/override)
  int encode(Color input) {
    return input.value;
  }
}

Otter.serializer(ColorSerializer());

链接

• otter_json
• otter_json_generator

作者

• @hokamc

示例代码

library example;

import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:otter_json/otter_json.dart';

[@ImportJsonModule](/user/ImportJsonModule)([DefaultJsonModule, ExampleJsonModule])
class ExampleImportJsonModule {}

[@JsonModule](/user/JsonModule)([ExampleSerializer])
class ExampleJsonModule {}

class Example implements Json {
  [@JsonField](/user/JsonField)("name2")
  final String name;
  final int age;
  final double money;
  final List<int> list;
  final Map<String, int> map;
  final AnotherExample example2;
  final List<AnotherExample> example2s;
  final Color color;
  final int? nullInt;
  final ExampleEnum eenum;
  final Example2Enum? enum2;

  Example({
    required this.name,
    required this.age,
    required this.money,
    required this.list,
    required this.map,
    required this.example2,
    required this.example2s,
    required this.color,
    this.nullInt,
    required this.eenum,
    this.enum2,
  });
}

enum ExampleEnum {
  [@JsonField](/user/JsonField)("A1")
  a1,
  a2,
  b1,
  b2
}

enum Example2Enum {
  [@JsonField](/user/JsonField)(1)
  a1,
  [@JsonField](/user/JsonField)(2)
  a2,
  [@JsonField](/user/JsonField)(3)
  b1,
  [@JsonField](/user/JsonField)(4)
  b2
}

class AnotherExample implements Json {
  final String name;

  AnotherExample({required this.name});
}

class ExampleSerializer implements JsonSerializer<Color, int> {
  [@override](/user/override)
  Color decode(int output) {
    return Color(output);
  }

  [@override](/user/override)
  int encode(Color input) {
    return input.value;
  }
}