Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Object Serialization to JSON (using Gson). How to set field names in UpperCamelCase?

I need to serialize a list of simple Java objects to JSON using Google Gson library.

The object:

public class SimpleNode {     private String imageIndex;     private String text;      public String getImageIndex() {         return imageIndex;     }      public void setImageIndex(String imageIndex) {         this.imageIndex = imageIndex;     }      public String getText() {         return text;     }      public void setText(String text) {        this.text = text;     } } 

I have written the following code for serialization:

 List<SimpleNode> testNodes = repository.getElements(0);  Gson gson = new Gson();  String jsonNodesAsString = gson.toJson(testNodes); 

It works, but the field name of the JSON objects is lowerCamelCase. Like this:

[   {     "imageIndex": "1",     "text": "Text 1"   },   {     "imageIndex": "2",     "text": "Text 2"   } ] 

How do I get a JSON with UpperCamelCase field name, like this:

[   {     "ImageIndex": "1",     "Text": "Text 1"   },   {     "ImageIndex": "2",     "Text": "Text 2"   } ] 

I think that I can rename member variables in to UpperCamelCase, but may be there is another way?

like image 246
Frank59 Avatar asked Feb 28 '14 13:02

Frank59


People also ask

How do you serialize with Gson?

Serialization in the context of Gson means converting a Java object to its JSON representation. In order to do the serialization, we need to create the Gson object, which handles the conversion. Next, we need to call the function toJson() and pass the User object. Program output.

Does Gson serialize private fields?

In this example you'll see how the Gson library handles the object fields. For object fields to be serialized into JSON string it doesn't need to use any annotations, it can even read private fields.

Does Gson ignore extra fields?

3. Deserialize JSON With Extra Unknown Fields to Object. As you can see, Gson will ignore the unknown fields and simply match the fields that it's able to.

What is Gson serialization and Deserialization?

Gson can serialize a collection of arbitrary objects but can't deserialize the data without additional information. That's because there's no way for the user to indicate the type of the resulting object. Instead, while deserializing, the Collection must be of a specific, generic type.


1 Answers

Taken from the docs:

Gson supports some pre-defined field naming policies to convert the standard Java field names (i.e. camel cased names starting with lower case --- "sampleFieldNameInJava") to a Json field name (i.e. sample_field_name_in_java or SampleFieldNameInJava). See the FieldNamingPolicy class for information on the pre-defined naming policies.

It also has an annotation based strategy to allows clients to define custom names on a per field basis. Note, that the annotation based strategy has field name validation which will raise "Runtime" exceptions if an invalid field name is provided as the annotation value.

The following is an example of how to use both Gson naming policy features:

private class SomeObject {   @SerializedName("custom_naming")    private final String someField;    private final String someOtherField;    public SomeObject(String a, String b) {     this.someField = a;     this.someOtherField = b;   } }  SomeObject someObject = new SomeObject("first", "second"); Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).create(); String jsonRepresentation = gson.toJson(someObject); System.out.println(jsonRepresentation); 

======== OUTPUT ========

{"custom_naming":"first","SomeOtherField":"second"} 

However, for what you want, you could just use this:

Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).create(); 

By using the UPPER_CAMEL_CASE option, you'll achieve your goal.

like image 101
Ben Dale Avatar answered Sep 19 '22 23:09

Ben Dale