jsonize 1.2.0

A json serialize class to convert 'to' and 'from' json format DateTime and any of your own classes.

A json serialize class to convert 'to' and 'from' json format DateTime and any of your own classes.

Introduction

Jsonize solves the problem of serializing and deserializing objects into undefined structures.
This package does not implement the 'toJson' and 'fromJson' methods for you. For that you can use one of the many available packages like json_serializable.

Usage

By default Jsonize supports DateTime serialization in any place of your data structure.

  List<dynamic> myList = [1, "Hello!", DateTime.now()];
  var jsonRep = Jsonize.toJson(myList);
  var myDeserializedList = Jsonize.fromJson(jsonRep);

Jsonize also supports your own classes. You can register a type or let your class implement the Jsonizable interface.

class MyClass implements Jsonizable<MyClass> {
  String? str;
  MyClass([this.str]);
  factory MyClass.empty() => MyClass();

  // Jsonizable implementation
  @override
  String get jsonClassCode => "mc";
  @override
  dynamic toJson() => str;
  @override
  MyClass? fromJson(value) => MyClass(value);
}

void main() {
  Jsonize.registerClass(MyClass.empty());
  Map<String, dynamic> myMap = {
    "my_num": 1,
    "my_str": "Hello!",
    "my_dt": DateTime.now(),
    "my_class": MyClass("here I am!")
  };
  var jsonRep = Jsonize.toJson(myMap);
  var myDeserializedMap = Jsonize.fromJson(jsonRep);

For more complex cases like subclasses, please refer to the examples section.

Jsonize methods

toJson

static String toJson(dynamic value,
      {String? indent,
       String? jsonClassToken,
       String? dtClassCode,
       DateTimeFormat? dateTimeFormat,
       CallbackFunction? convertCallback})

Transforms an object/structure of objects into a json string applying the class tokens in order to revert back your original objects.

Parameters:

• value: the value you want to transform to json string.
• indent: The indentation token. If omitted no indentation is used (space saving!).
• jsonClassToken: The token used by Jsonize to identify a serialized object.
• dtClassCode: The code used to serialize DateTime objects.
• dateTimeFormat: The DateTime serialization format (see DateTimeFormat enum).
• convertCallback: An optional function called before returning the object's encoded json representation.

fromJson

  static dynamic fromJson(dynamic value,
      {String? jsonClassToken,
       String? dtClassCode,
       DateTimeFormat? dateTimeFormat,
       CallbackFunction? convertCallback})

Transforms a json string back to an object/structure of objects.

Parameters:

• value: the value you want to transform to json string.
• jsonClassToken: The token used by Jsonize to identify a serialized object.
• dtClassCode: The code used to serialize DateTime objects.
• dateTimeFormat: The DateTime serialization format (see DateTimeFormat enum).
• convertCallback: An optional function called before decoding the json representation into the object.

registerClass

static void registerClass(Jsonizable object)

Registers a new Jsonizable class by it instance.

Parameters:

• object: the class instance jsonize will be able to serialize.

registerClasses

static void registerClasses(Iterable<Jsonizable> objects)

Registers new Jsonizable classes by it instances.

Parameters:

• objects: the class instances jsonize will be able to serialize.

registerType

static void registerType(Type classType,
      String classTypeCode,
      ConvertFunction? toJsonFunc,
      ConvertFunction? fromJsonFunc)

Registers a new type to the Jsonize conversion handling (i.e. used for classes that does not implement Jsonizable interface)

Parameters:

• type: the type jsonize will be able to serialize.
• classTypeCode: the class type token jsonize will use to identify this object type/class.
• toJsonFunc: the json encoder function.
• fromJsonFunc: the json decoder function.

Jsonize enums

DateTimeFormat

• string: a human readable date time string representation.
• stringWithMillis: a human readable date time string representation with milliseconds.
• stringWithMicros: a human readable date time string representation with microseconds.
• epoch: a number representing the seconds since the "Unix epoch" 1970-01-01T00:00:00 (json space safer!).
• epochWithMillis: a number representing the milliseconds since the "Unix epoch" 1970-01-01T00:00:00.
• epochWithMicros: a number representing the microseconds since the "Unix epoch" 1970-01-01T00:00:00.

Additional information

Since current Dart implementation does not really support reflection, Jsonize requires what I would define as two extra steps:

1. register all your types/classes you want to serialize
2. In case of implementing the Jsonizable interface, you will need to register a class instance (e.g. factory MyClass.empty() => ...)

I hope future Dart releases will support better reflection and type handling.