Converting Java object to JSON with specific syntax

Question

I want to convert Java object to JSON string. Lets say the object looks like this:

public class User{
    private Long id;
    private String firstName;
}

And the json should look like this:

{
    "inputFields":[
        {
            "name":"id",
            "value":"123"
        },
        {
            "name":"firstName",
            "value":"George"
        }
    ]
}

Tried to use Jackson, but it looks like it doesn't provide such kind of serialization.

You Need Custom Serializer to `Serialize` the array of Class `User` Object. — Vikrant Kashyap, Apr 01 '16 at 08:58
This is what you need to do: http://www.baeldung.com/jackson-custom-serialization — dabadaba, Apr 01 '16 at 08:59
Why do you need such an awkward JSON structure? Wouldn't it be better to have `"id":"123","name":"George"`? — Magnus, Apr 01 '16 at 09:00
You might want to have a look at this thread - [How to serialize Object to JSON?](http://stackoverflow.com/questions/16607444/how-to-serialize-object-to-json) — Viorel Florian, Apr 01 '16 at 09:05
@BadCash, there always is a reason. For this case I am trying to integrate with external WebService, and it requires such structure. — Yuriy Kravets, Apr 01 '16 at 09:07

dumitru · Accepted Answer · 2016-04-07T08:11:07.893

Jackson can use custom serializer where you can have control in generating the output. The following are the step to do this:

Annotate your POJO to use a custom serializer

@JsonSerialize(using = CustomSerializer.class)
static class User{
    public Long id;
    public String firstName;

    public User(Long id, String firstName) {
        this.id = id;
        this.firstName = firstName;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
}

Declare the serialzer

static class CustomSerializer extends JsonSerializer{

    @Override
    public void serialize(Object value, JsonGenerator jgen, SerializerProvider serializers) throws IOException, JsonProcessingException {
        jgen.writeStartObject();
        jgen.writeArrayFieldStart("inputFields");

        Field[] fields = value.getClass().getDeclaredFields();

        for (Field field : fields) {
            try {
                field.setAccessible(true);
                jgen.writeStartObject();
                jgen.writeObjectField("name", field.getName());
                jgen.writeObjectField("value", field.get(value));
                jgen.writeEndObject();
            } catch (IllegalArgumentException | IllegalAccessException e) {
                e.printStackTrace();
            }

        }

        jgen.writeEndArray();
        jgen.writeEndObject();
    }
}

A simple test

public static void main(String[] args) throws JsonProcessingException {
    User user = new User(1L, "Mike");
    ObjectMapper om = new ObjectMapper();
    om.writeValueAsString(user);
    System.out.println(om.writeValueAsString(user));
}

And the output will be

{"inputFields":[{"name":"id","value":1},{"name":"firstName","value":"Mike"}]}

add `field.setAccessible(true);` to the loop and I will accept this answer as the most "on point" and elegant. — Yuriy Kravets, Apr 01 '16 at 10:21
true, to prevent accessibility using reflection one should set that flag. thanks — dumitru, Apr 01 '16 at 13:03

stepanian · Answer 2 · 2016-04-01T09:18:48.357

0

Create an InputFields class and move the User object data to it before converting to json.

Edit: The InputFields class would obviously have the same structure as the desired json result.

edited Apr 01 '16 at 09:18

answered Apr 01 '16 at 09:11

stepanian

11,373
8
43
63

1

And make the field a Collection inside the InputFields class. Or create a custom converter. – dambros Apr 01 '16 at 09:13
@stepanian actually, the inputFields is not a big problem, the problem is structure of name-value pairs – Yuriy Kravets Apr 01 '16 at 09:13
I understand that. The InputFields class will have that structure. – stepanian Apr 01 '16 at 09:14

Duoglas Du · Answer 3 · 2016-04-01T09:37:57.910

Just a example of stepanian's answer, but i prefer dumitru's way to implement a CustomSerializer.

create a InputField class

public class InputField {

    private String name;
    private String value;

    public String getValue() {
        return value;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

parse User

public static List<InputField> parseInputFields(Object model) {
    List<InputField> inputFields = new ArrayList<InputField>();

    Field[] field = model.getClass().getDeclaredFields();
    try {
        for (int j = 0; j < field.length; j++) {

            InputField inputField = new InputField();

            inputField.setName(field[j].getName());
            inputField.setValue(String.valueOf(field[j].get(model));

            inputFields.add(inputField);
        }
    } catch (NoSuchMethodException e) {
        e.printStackTrace();
    } catch (SecurityException e) {
        e.printStackTrace();
    } catch (IllegalAccessException e) {
        e.printStackTrace();
    } catch (IllegalArgumentException e) {
        e.printStackTrace();
    } catch (InvocationTargetException e) {
        e.printStackTrace();
    }

    return inputFields;
}

test

public static void main(String[] args) throws JsonProcessingException {
    User user = new User(1L, "Mike");

    Map<String, Object> tmpMap=new HashedMap();
    tmpMap.put("inputFields", parseInputFields(user));

    ObjectMapper om = new ObjectMapper();
    System.out.println(om.writeValueAsString(tmpMap));
}

Converting Java object to JSON with specific syntax

3 Answers3