Serializing Java objects for REST API Requests in Open Event Organizer App
Open Event Organizer App is a client side application which uses REST API for network requests. The server supports sending and receiving of data only in JSONAPI spec, so, we needed to serialize java models into JSON objects and deserialize JSON data into java models following JSONAPI spec. To achieve this we followed the following steps.
Specifications
We will be using jasminb/jsonapi-converter which handles request/response parsing of models following JSONAPI Spec and Retrofit plugin of jackson converter to serializing JSON to Java Models and vice versa.
Let’s create a java model. We are using some annotations provided by Lombok library to avoid writing boilerplate code. @JsonNaming annotation is used to apply KebabCaseStrategy while serializing fields
@Data @Type(“order”) @AllArgsConstructor @JsonNaming(PropertyNamingStrategy.KebabCaseStrategy.class) @Table(database = OrgaDatabase.class, allFields = true) public class Order { @PrimaryKey public float amount; @Relationship(“event”) public Order() { } |
In the NetworkModule class, there is a method providesMappedClasses() containing a list of classes that needs to be serialized/deserialized. We need to add the above model in the list. Then, this list is provided to Singleton instance of JSONAPIConvertorFactory through Dagger. JSONAPIConvertorFactory uses the Retrofit ObjectMapper and maps the classes that are handled by this instance.
@Provides Class[] providesMappedClasses() { return new Class[]{Event.class, Attendee.class, Ticket.class, Order.class}; } |
Further, various serialization properties can be used while building Singleton ObjectMapper instance. Adding any properties here ensures that these are applied to all the mapped classes by JSONAPIConvertorFactory. For eg, we are using the serialization property to throw an exception and fail whenever empty beans are encountered.
@Provides @Singleton ObjectMapper providesObjectMapper() { return new ObjectMapper() .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) .disable(SerializationFeature.FAIL_ON_EMPTY_BEANS) // Handle constant breaking changes in API by not including null fields // TODO: Remove when API stabilizes and/or need to include null values is there .setSerializationInclusion(JsonInclude.Include.NON_ABSENT); } |
Resources
- Github Repository for jsonapi-converter https://github.com/jasminb/jsonapi-converter
- Github repository for Jackson Retrofit Plugin https://github.com/square/retrofit/tree/master/retrofit-converters/jackson
- Official Website for Project Lombok https://projectlombok.org/
Github Repository for Open-Event-Orga-App https://github.com/fossasia/open-event-orga-app