platform/README.md

serialize

Source-generated serialization for Dart objects. This package uses package:source_gen to eliminate the time you spend writing boilerplate serialization code for your models. package:angel_serialize also powers package:angel_orm.

• Usage
  • Models
    • Field Aliases
    • Excluding Keys
    • Required Fields
  • Serialization
  • Nesting
  • ID and Date Fields
  • TypeScript Definition Generator
  • Constructor Parameters

Usage

In your pubspec.yaml, you need to install the following dependencies:

dependencies:
  angel_model: ^1.0.0 # Only required if using Angel!!!
  angel_serialize: ^2.0.0
dev_dependencies:
  angel_serialize_generator: ^2.0.0
  build_runner: ^0.8.0

With the recent updates to package:build_runner, you can build models in lib/src/models/**.dart automatically by running pub run build_runner build.

To tweak this: https://pub.dartlang.org/packages/build_config

If you want to watch for file changes and re-build when necessary, replace the build call with a call to watch. They take the same parameters.

Models

There are a few changes opposed to normal Model classes. You need to add a @serializable annotation to your model class to have it serialized, and a serializable model class's name should also start with a leading underscore.

In addition, you may consider using an abstract class to ensure immutability of models.

Rather you writing the public class, angel_serialize does it for you. This means that the main class can have its constructors automatically generated, in addition into serialization functions.

For example, say we have a Book model. Create a class named _Book:

library angel_serialize.test.models.book;

import 'package:angel_model/angel_model.dart';
import 'package:angel_serialize/angel_serialize.dart';
import 'package:collection/collection.dart';
part 'book.g.dart';

@serializable
abstract class _Book extends Model {
  String get author;
  
  String get title;
  
  String get description;
  
  int get pageCount;
  
  BookType get type;
}

/// It even supports enums!
enum BookType {
  fiction,
  nonFiction
}

The following files will be generated:

• book.g.dart
• book.serializer.g.dart

Serialization

You can use the generated files as follows:

myFunction() {
  var warAndPeace = new Book(
    author: 'Leo Tolstoy',
    title: 'War and Peace',
    description: 'You will cry after reading this.',
    pageCount: 1225
  );
  
  // Easily serialize models into Maps
  var map = BookSerializer.toMap(warAndPeace);
  
  // Also deserialize from Maps
  var book = BookSerializer.fromMap(map);
  print(book.title); // 'War and Peace'
  
  // For compatibility with `JSON.encode`, a `toJson` method
  // is included that forwards to `BookSerializer.toMap`:
  expect(book.toJson(), map);
  
  // Generated classes act as value types, and thus can be compared.
  expect(BookSerializer.fromMap(map), equals(warAndPeace));
}

As of 2.0.2, the generated output also includes information about the serialized names of keys on your model class.

  myOtherFunction() {
    // Relying on the serialized key of a field? No worries.
      map[BookFields.author] = 'Zora Neale Hurston';
  }
}

Customizing Serialization

Currently, these serialization methods are supported:

• to Map
• to JSON

You can customize these by means of serializers:

@Serializable(serializers: const [Serializers.map, Serializers.json])
class _MyClass extends Model {}

Aliases

Whereas Dart fields conventionally are camelCased, most database columns tend to be snake_cased. This is not a problem, because we can define an alias for a field.

By default angel_serialize will transform keys into snake case. Use Alias to provide a custom name, or pass autoSnakeCaseNames: false to the builder;

@serializable
abstract class _Spy extends Model {
  /// Will show up as 'agency_id' in serialized JSON.
  /// 
  /// When deserializing JSON, instead of searching for an 'agencyId' key,
  /// it will use 'agency_id'.
  /// 
  /// Hooray!
  String agencyId;
  
  @Alias('foo')
  String someOtherField;
}

You can also override autoSnakeCaseNames per model:

@Serializable(autoSnakeCaseNames: false)
abstract class _OtherCasing extends Model {
  String camelCasedField;
}

Excluding Keys

In pratice, there may keys that you want to exclude from JSON. To accomplish this, simply annotate them with @exclude:

@serializable
abstract class _Whisper extends Model {
  /// Will never be serialized to JSON
  @exclude
  String secret;
}

There are times, however, when you want to only exclude either serialization or deserialization, but not both. For example, you might want to deserialize passwords from a database without sending them to users as JSON.

In this case, use canSerialize or canDeserialize:

@serializable
abstract class _Whisper extends Model {
  /// Will never be serialized to JSON
  /// 
  /// ... But it can be deserialized
  @Exclude(canDeserialize: true)
  String secret;
}

Required Fields

It is easy to mark a field as required; just use the @required annotation from package:meta:

@serializable
abstract class _Foo extends Model {
  @required
  int myRequiredInt;
  
  @Required('Custom message')
  int myOtherRequiredInt;
}

The given field will be marked as @required in the generated constructor, and serializers will check for its presence, throwing a FormatException if it is missing.

Nesting

angel_serialize also supports a few types of nesting of @serializable classes:

• As a class member, ex. Book myField
• As the type argument to a List, ex. List<Book>
• As the second type argument to a Map, ex. Map<String, Book>

In other words, the following are all legal, and will be serialized/deserialized. You can use either the underscored name of a child class (ex. _Book), or the generated class name (ex Book):

@serializable
abstract class _Author extends Model {
  List<Book> books;
  Book newestBook;
  Map<String, Book> booksByIsbn;
}

If your model (Author) depends on a model defined in another file (Book), then you will need to generate book.g.dart before, author.g.dart, in a separate build action. This way, the analyzer can resolve the Book type.

ID and Dates

This package will automatically generate id, createdAt, and updatedAt fields for you, in the style of an Angel Model. To disable this, set autoIdAndDateFields to false in the builder constructor.

You can also override autoIdAndDateFields per model:

@Serializable(autoIdAndDateFields: false)
abstract class _Skinny extends Model {}

TypeScript Definitions

It is quite common to build frontends with JavaScript and/or TypeScript, so why not generate typings as well?

To accomplish this, add Serializers.typescript to your @Serializable() declaration:

@Serializable(serializers: const [Serializers.map, Serializers.json, Serializers.typescript])
class _Foo extends Model {}

The aforementioned _Author class will generate the following in author.d.ts:

interface Author {
  id: string;
  name: string;
  age: number;
  books: Book[];
  newest_book: Book;
  created_at: any;
  updated_at: any;
}
interface Library {
  id: string;
  collection: BookCollection;
  created_at: any;
  updated_at: any;
}
interface BookCollection {
  [key: string]: Book;
}

Fields with an @Exclude() that specifies canSerialize: false will not be present in the TypeScript definition. The rationale for this is that if a field (i.e. password) will never be sent to the client, the client shouldn't even know the field exists.

Constructor Parameters

Sometimes, you may need to have custom constructor parameters, for example, when using depedency injection frameworks. For these cases, angel_serialize can forward custom constructor parameters.

The following:

@serializable
abstract class _Bookmark extends _BookmarkBase {
  @exclude
  final Book book;

  int get page;
  String get comment;

  _Bookmark(this.book);
}

Generates:

class Bookmark extends _Bookmark {
  Bookmark(Book book,
      {this.id,
      this.page,
      this.comment,
      this.createdAt,
      this.updatedAt})
      : super(book);

  @override
  final String id;

  // ...
}