Serializers

Serializers is a Dart library for serializing objects into maps/json.

INSTALLATION

Add the dependency to your project’s pubspec.yaml.

name: my_project
dependencies:
  serializers: any

And run pub install.

HOW TO USE

Suppose we have the following model:

class Person {
  String firstName;
  String lastName;

  Person(this.firstName, this.lastName);

  get fullName => "$firstName $lastName";
}

We can define a serializer for this model as follows:

class PersonSerializer extends Serializer<Person>{}

Serializing the model is done as follows:

var person = new Person('Bill', 'Evans');
var data = new PersonSerializer().serialize(person, object: true);

Where data is equal to:

{"firstName" : "Bill", "lastName" : "Evans", "fullName" : "Bill Evans"};

Mirrors and Map

By default a serializer uses reflection mirrors. If the model implements the [] operator, you can use it instead of mirrors. To do that pass map:true.

Map data = new PersonSerializer().serialize(person, map: true);

Configuration

A serializer can be configured using the following properties: fields, root, custom, postProcessing.

class PersonSerializer extends Serializer<Person>{
  get fields => ["firstName"];

  get custom => {
    "customField" : (Person p) => p.lastName.toUpperCase();
  };

  get root => "person";

  Map postProcessing(Map data, Person person){
    data["reversedFullName"] = "${person.lastName} ${person.firstName}";
    return data;
  }
}

var person = new Person('Bill', 'Evans');
new PersonSerializer().serialize(person, object: true);

Returns:

{"person" : {"firstName" : "Bill", "customField" : "EVANS", "reversedFullName" : "Evans Bill"}}