How to serialize Java objects into JSON format using Google’s GSON

JSON which is an abbreviated form of ‘JavaScript Object Notation’, is a text-based open standard designed for human-readable data interchange. Even though the name has the word JavaScript, JSON is not particularly tied to one language.The JSON format was originally specified by Douglas Crockford, and is described in RFC 4627. The official Internet media type for JSON is application/json. The JSON filename extension is .json.The JSON format is often used for serializing and transmitting structured data over a network connection. It is used primarily to transmit data between a server and web application, serving as an alternative to XML. [Wikipedia]

In this article, I will talk about how you can use Java and Google’s Gson to convert (Serialize) Java Objects into JSON format
Let’s say we have a class called ‘SomeClass’. In this class, I have created several variables – string, integer, some simmple list, a complex list and a map of strings.


public class SomeClass {

    private String helloString = "Hello";
    private int id = 123;
    private List simpleList = new ArrayList();
    private List complexList = new ArrayList();
    private Map<String, String> countryCapitalMap = new HashMap<String, String>();

    // To get helloString in JavaScript use data.helloString

    public SomeClass() {

        //Prepare a simple List
        simpleList.add("New York");

        //Prepare a complex List Object - List of List of String in this case
        List tempListCities = new ArrayList();
        tempListCities.add("Des Moines");
        tempListCities.add("Iowa City");


        List tempListActors = new ArrayList();
        tempListActors.add("Johnny Depp");
        tempListActors.add("Robert DeNiro");
        tempListActors.add("Al Pacino");


        //Prepare some maps
        countryCapitalMap.put("Nepal", "Kathmandu");
        countryCapitalMap.put("Canada", "Ottawa");


    public String getHelloString() {

        return helloString;

    public void setHelloString(String helloString) {

        this.helloString = helloString;

    public int getId() {

        return id;

    public void setId(int id) { = id;

    public List getSimpleList() {

        return simpleList;

    public void setSimpleList(List simpleList) {

        this.simpleList = simpleList;

Let’s say we would like to serialize this class to some text format using JSON. Since JSON itself is the object notation language but not the tool itself, we need some tools that can convert this class to the JSON format.

Google has a tool called Gson. Gson is a Java library that can be used to convert Java Objects into their JSON representation. It can also be used to convert a JSON string to an equivalent Java object. Gson can work with arbitrary Java objects including pre-existing objects that you do not have source-code of.

There are a few open-source projects that can convert Java objects to JSON. However, most of them require that you place Java annotations in your classes; something that you can not do if you do not have access to the source-code. Most also do not fully support the use of Java Generics. Gson considers both of these as very important design goals.

Gson Goals

  1. Provide simple toJson() and fromJson() methods to convert Java objects to JSON and vice-versa
  2. Allow pre-existing unmodifiable objects to be converted to and from JSON
  3. Extensive support of Java Generics
  4. Allow custom representations for objects
  5. Support arbitrarily complex objects (with deep inheritance hierarchies and extensive use of generic types)

[Text Source: Google]

Having noted that, we now will be using Gson library to convert the class above to JSON format.

Here is the utility class that can do this conversion. I am using gson-2.2.2.jar


import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


 * @author Kushal Paudyal
 * Tested with gson-2.2.2.jar

public class SimpleGsonTutorial {

    public static void main(String args[]) {

        Gson gson = new Gson();
        String jsonString = gson.toJson(new SomeClass());



Here is the output of this program when you run it. The output is the serialized JSON string for our SomeClass java object.

"simpleList":["Chicago","New York","Boston"],
"complexList":[["Des Moines","Iowa City","Ames"],["Johnny Depp","Robert DeNiro","AlPacino"]],

Note that Gson also allows you to create a java object from the JSON format. They have a fromGson() method that can do this reverse conversion.

Tagged , , , , , , , , , , , , , , , , , , , , , , . Bookmark the permalink.

One Response to Serialzing A Java Object Into XML and De-Serialzing using XMLEncoder And XMLDecoder

  1. harry says:

    Dear Kushal

    Thanks a lot for this. Is there any way to have it as instead of ? and 45 instead of


Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.