Built JSON provides serialization for the [Libraries for Object Oriented Dart] (https://github.com/google/built_value.dart/blob/master/libraries_for_object_oriented_dart.md#libraries-for-object-oriented-dart).
This allows a complete serializable object oriented data model to be based on Enum Classes, [Built Collections] (https://github.com/google/built_collection.dart#built-collections-for-dart) and [Built Values] (https://github.com/google/built_value.dart#built-values-for-dart).
Built JSON for Java, a separate project, will provide compatible serialization for Java, mapping Enum Classes to standard Java enums, Built Collections to [Immutable Collections] (https://github.com/google/guava/wiki/ImmutableCollectionsExplained) and Built Values to [AutoValues] (https://github.com/google/auto/tree/master/value#autovalue).
Built JSON is not yet ready for use. Watch this space!
There are many ways to serialize data. Why do we need another?
Built JSON is about serialization of object oriented data. There are many ways to do this, too. Built JSON is different to other libraries for a number of reasons:
Built JSON fully supports object oriented design: any object model that you can design can be serialized, including full use of generics and interfaces. Some other libraries require concrete types or do not fully support generics.
Built JSON allows different object oriented models over the same data. For example, in a client server application, it's likely that the client and server want different functionality from their data model. So, they are allowed to have different classes that map to the same data. Most other libraries enforce a 1:1 mapping between classes and types on the wire.
Built JSON requires well behaved types. They must be immutable, can use
interface but not concrete inheritance, must have predictable nullability,
toString. In fact, they must be Enum Classes, Built
Collections or Built Values. Some other libraries allow badly behaved types to
Built JSON supports changes to the data model. Optional fields can be added or removed, and fields can be switched from optional to required, allowing your data model to evolve without breaking compatbility. Some other libraries break compatability on any change to any serializable class.
Built JSON is modular. Each endpoint can choose which classes to know about; for example, you can have multiple clients that each know about only a subset of the classes the server knows. Most other libraries are monolithic, requiring all endpoints to know all types.
Built JSON is multi language. Support will be come first for Dart, Java and Java/GWT. Many other libraries support a single language only.
Built JSON has first class support for validation via Built Values. An important part of a powerful data model is ensuring it's valid, so classes can make guarantees about what they can do. Other libraries also support validation but usually in a less prominent way.
And, finally, Built JSON is pluggable. Arbitrary extensions can be added to give custom JSON serialization for your own types. This could be used to interoperate with other tools or to add hand coded high performance serializers for specific classes. Some other libraries are not so extensible.
See [this example]
(https://github.com/google/built_json.dart/tree/master/example) for a full
project with a
build.dart and some examples.
Please file feature requests and bugs at the issue tracker.
Add this to your package's pubspec.yaml file:
dependencies: built_json_generator: "^0.1.5"
You can install packages from the command line:
$ pub get
$ flutter packages get
Alternatively, your editor might support
pub get or
flutter packages get.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
|0.1.5||Oct 19, 2016|
|0.1.4||Sep 21, 2016|
|0.1.3||Sep 21, 2016|
|0.1.2||Sep 12, 2016|
|0.1.1||May 25, 2016|
|0.1.0||May 25, 2016|
|0.0.7||May 9, 2016|
|0.0.6||May 5, 2016|
|0.0.5||Mar 18, 2016|
|0.0.4||Feb 23, 2016|
We analyzed this package on Jun 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Detected platforms: Flutter, web, other
No platform restriction found in primary library
Fix analysis and formatting issues.
Analysis or formatting checks reported 27 errors 1 hint.
Strong-mode analysis of
lib/src/source_class.dartfailed with the following error:
line: 10 col: 8
Target of URI doesn't exist: 'package:built_value/built_value.dart'.
Strong-mode analysis of
lib/src/source_class.g.dartfailed with the following error:
line: 25 col: 34
The method 'update' isn't defined for the class 'SourceClassBuilder'.
Similar analysis of the following files failed:
Package is getting outdated.
The package was released 86 weeks ago.
Package is pre-v1 release.
While there is nothing inherently wrong with versions of
0.*.*, it usually means that the author is still experimenting with the general direction API.
Maintain an example.
Create a short demo in the
example/directory to show how to use this package. Common file name patterns include:
example.dartor you could also use
|Dart SDK||>=1.12.0-dev.5.10 <2.0.0|