Skip to content

[CORE 15] JsonTools

Elmar Dott edited this page Jan 11, 2023 · 3 revisions

JsonTools

@since: 3.0 > @api-version: 1.0 > Dependencies: Jackson

Files:


JsonTools is a proxy for the Jackson JSON library, to wrap all necessary functionality to process JavaScript Object Notation (JSON) objects.

The main usage for JsonTools is serialize Java Objects to JSON Strings and back from JSON Strings to Plain Java Data Objects. This functionality is used in the GenericDAO for JSON serialization and deserialization. Also in REST services need the JSON processing to exchange information. To archive this goal the three functions are available:

  • ​ serializeAsJsonObject(DomainObject)
  • ​ deserializeJsonAsObject(json, DomainObject.class);
  • ​ deserializeJsonAsList(json)

JsonTools needed to get instanced as generic, by the transformed DomainObject. DomainObjects are Plain Old Java Objects (POJO) without any business logic. They just storages for structured data.

Sample:

// DomainObject
public class DomainObject {

    private String key;
    private int value;


    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }
}

String jsonObject = 
    "{\"key\":\"key\",\"value\":12345}";
String jsonObjectList = 
    "{ {\"key\":\"key\",\"value\":12345} }";        

DomainObject domainObject = new DomainObject();
        domainObject.setKey("key");
        domainObject.setValue(12345);

JsonTools<DomainObject> jsonTools = new JacksonJsonTools();

String jsonString 
    = jsonTools.serializeAsJsonObject(domainObject);
DomainObject object 
    = deserializeJsonAsObject(jsonObject, DomainObject.class);
List<DomainObject> objectList
    = jsonTools.deserializeJsonAsList(jsonObjectList);