Overview

A predictable and fast json parser that uses minimal reflection for Android. Define your models in json - The library will generate models, serializers, and deserializers automatically at build time.

How fast is it?

Super fast! It's faster than jackson-databind, Gson, and Moshi. It's very comparable in speed with LoganSquare (both libraries use code generation and jackson-core under the hood).

How is it different from other json libraries?

• Strictly enforced immutable types
• Generated code for models, serializers and deserializers, no reflection when creating models.
• Fully proguard ready (models, serializers and deserializers can all be obfuscated, and removed by proguard if unused.)

How does it work?

The library uses a custom gradle task to generate models based on the definitions you provide. It can also generate and automatically register serializers and deserializers.

Setup

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.jaynewstrom.jsonDelight:gradle-plugin:0.22.1'
    }
}

apply plugin: 'com.android.application'
apply plugin: 'com.jaynewstrom.jsonDelight'

Usage

Define your models in /src/main/jsonDelight/{the package you want the model to live in}. The gradle task will create the models for you at build time. An example json file is below.

{
  "public": false, // Not required, defaults to false.
  "createSerializer": true, // Not required, defaults to false.
  "createDeserializer": false, // Not required, defaults to false.
  "fields": [
    {
      "name": "foo", // Required!
      "type": "String", // Required!
      "public": false, // Not required, defaults to the types public flag.
      "jsonName": "foo", // Not required, defaults to the "name" property.
      "list": false, // Not required, defaults to false.
      "nullable": false, // Not required, defaults to false.
      "customSerializer": null, // Not required.
      "customDeserializer": null // Not required.
    }
  ]
}

Custom Serializers/Deserializers

Have a type that you can't generate? Platform types such as java.Util.Date can still be (de)serialized! Just call jsonDeserializerFactory.register(...) or jsonSerializerFactory.register(...) to register your custom (de)serializers.

Field Specific Serializers/Deserializers

If your server is sending data back in a goofy way {"foo": "true"} you can use a custom deserializer to deserialize it into a boolean, rather than a string. Just add "customDeserializer": "LenientBooleanDeserializer" to the field definition when defining it in json. You can also do tricks like this to deserialize polymorphic types and nested types.

Working with other json parsers

Want to work with data that is a little more dynamic? Want to use jackson-databind? Have models that aren't performance critical? You can use a custom JsonSerializer or JsonDeserializer to bridge the gap between the libraries! Just call jsonDeserializerFactory.register(...) or jsonSerializerFactory.register(...) to register your custom (de)serializers.

Use with Retrofit

Add the retrofit dependency to your build.gradle.

dependencies {
    ...
    compile 'com.jaynewstrom.jsonDelight:retrofit-converter:0.22.1'
}

Add the converter to your retrofit instance.

new Retrofit.Builder()
    ...
    .addConverterFactory(JsonConverterFactory.create(new JsonFactory(), new JsonSerializerFactory(), new JsonDeserializerFactory()))
    .build();

Any models used in a retrofit call will be run through the converter.

Local Development

This project uses gradle as a build system, and uses the new composite builds. See LOCAL_DEVELOPMENT.md for working on this project.

Thanks!

I got the idea for this library by looking into SqlDelight, and a lot of the basic needs of this library come from examples within SqlDelight.

License

Copyright 2016 Jay Newstrom

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.