Creating & Parsing JSON data with Java Servlet/Struts/JSP

JSON (JavaScript Object Notation) is a lightweight computer data interchange format. It is a text-based, human-readable format for representing simple data structures and associative arrays (called objects). The JSON format is specified in RFC 4627 by Douglas Crockford. The official Internet media type for JSON is application/json.

The JSON format is often used for transmitting structured data over a network connection in a process called serialization. Its main application is in AJAX web application programming, where it serves as an alternative to the traditional use of the XML format.

Supported data types

java logo

  1. Number (integer, real, or floating point)
  2. String (double-quoted Unicode with backslash escapement)
  3. Boolean (true and false)
  4. Array (an ordered sequence of values, comma-separated and enclosed in square brackets)
  5. Object (collection of key/value pairs, comma-separated and enclosed in curly brackets)
  6. null

Syntax

The following example shows the JSON representation of an object that describes a person. The object has string fields for first name and last name, contains an object representing the person’s address, and contains a list of phone numbers (an array).

{
    "firstName": "John",
    "lastName": "Smith",
    "address": {
        "streetAddress": "21 2nd Street",
        "city": "New York",
        "state": "NY",
        "postalCode": 10021
    },
    "phoneNumbers": [
        "212 732-1234",
        "646 123-4567"
    ]
}

Creating JSON data in Java

JSON.org has provided libraries to create/parse JSON data through Java code. These libraries can be used in any Java/J2EE project including Servlet, Struts, JSF, JSP etc and JSON data can be created.

Download JAR file json-rpc-1.0.jar (75 kb)

Use JSONObject class to create JSON data in Java. A JSONObject is an unordered collection of name/value pairs. Its external form is a string wrapped in curly braces with colons between the names and values, and commas between the values and names. The internal form is an object having get() and opt() methods for accessing the values by name, and put() methods for adding or replacing values by name. The values can be any of these types: Boolean, JSONArray, JSONObject, Number, and String, or the JSONObject.NULL object.

import org.json.JSONObject;

...
...

JSONObject json = new JSONObject();
json.put("city", "Mumbai");
json.put("country", "India");

...

String output = json.toString();

...

Thus by using toString() method you can get the output in JSON format.

JSON Array in Java

A JSONArray is an ordered sequence of values. Its external text form is a string wrapped in square brackets with commas separating the values. The internal form is an object having get and opt methods for accessing the values by index, and put methods for adding or replacing values. The values can be any of these types: Boolean, JSONArray, JSONObject, Number, String, or the JSONObject.NULL object.

The constructor can convert a JSON text into a Java object. The toString method converts to JSON text.

JSONArray class can also be used to convert a collection of Java beans into JSON data. Similar to JSONObject, JSONArray has a put() method that can be used to put a collection into JSON object.

Thus by using JSONArray you can handle any type of data and convert corresponding JSON output.

Using json-lib library

JSON-lib is a java library for transforming beans, maps, collections, java arrays and XML to JSON and back again to beans and DynaBeans.

Json-lib comes in two flavors, depending on the jdk compatibility. json-lib-x.x-jdk13 is compatible with JDK 1.3.1 and upwards. json-lib-x.x-jdk15 is compatible with JDK 1.5, includes support for Enums in JSONArray and JSONObject.

Download: json-lib.jar

Json-lib requires (at least) the following dependencies in your classpath:

  1. jakarta commons-lang 2.5
  2. jakarta commons-beanutils 1.8.0
  3. jakarta commons-collections 3.2.1
  4. jakarta commons-logging 1.1.1
  5. ezmorph 1.0.6

Example

package net.viralpatel.java;

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

import net.sf.json.JSONObject;

public class JsonMain {
	public static void main(String[] args) {
		
		Map<String, Long> map = new HashMap<String, Long>();
		map.put("A", 10L);
		map.put("B", 20L);
		map.put("C", 30L);
		
		JSONObject json = new JSONObject();
		json.accumulateAll(map);
		
		System.out.println(json.toString());

		
		List<String> list = new ArrayList<String>();
		list.add("Sunday");
		list.add("Monday");
		list.add("Tuesday");
		
		json.accumulate("weekdays", list);
		System.out.println(json.toString());
	}
}

Output:

{"A":10,"B":20,"C":30}
{"A":10,"B":20,"C":30,"weekdays":["Sunday","Monday","Tuesday"]}


Using Google Gson library

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

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

Google Gson Example

import java.util.List;
import com.google.gson.Gson;

public class Test {

    public static void main(String... args) throws Exception {
        String json = 
            "{"
                + "'title': 'Computing and Information systems',"
                + "'id' : 1,"
                + "'children' : 'true',"
                + "'groups' : [{"
                    + "'title' : 'Level one CIS',"
                    + "'id' : 2,"
                    + "'children' : 'true',"
                    + "'groups' : [{"
                        + "'title' : 'Intro To Computing and Internet',"
                        + "'id' : 3,"
                        + "'children': 'false',"
                        + "'groups':[]"
                    + "}]" 
                + "}]"
            + "}";

        // Now do the magic.
        Data data = new Gson().fromJson(json, Data.class);

        // Show it.
        System.out.println(data);
    }

}

class Data {
    private String title;
    private Long id;
    private Boolean children;
    private List<Data> groups;

    public String getTitle() { return title; }
    public Long getId() { return id; }
    public Boolean getChildren() { return children; }
    public List<Data> getGroups() { return groups; }

    public void setTitle(String title) { this.title = title; }
    public void setId(Long id) { this.id = id; }
    public void setChildren(Boolean children) { this.children = children; }
    public void setGroups(List<Data> groups) { this.groups = groups; }

    public String toString() {
        return String.format("title:%s,id:%d,children:%s,groups:%s", title, id, children, groups);
    }




28 Comments

  • Navin 3 June, 2009, 17:33

    Hi Team,
    I want to know how JSON helps in file upload in Java/Servlet/JSP.
    Sample code will be appriciated.

    regards,
    K. Navin.

  • npk 15 June, 2009, 7:48

    Hi Team,

    I need to have a simple example of the below
    1) Simple JSON example with Servlet
    2) Fileupload using JSON & Servlet

    Thanks for your help.

  • Dharmesh 30 July, 2009, 17:19

    Lot of questions left unanswered in this post.. was looking for something more elaborate .. but its ok .. will google it elsewhere

  • Ratna Dinakar 28 October, 2009, 9:08

    Instead of JSON RPC Jar.. try using this JSON-Lib. It has many advance features compared to library of json.org.

  • Imran 13 November, 2009, 17:00

    Hi ,

    Im trying to write a servlet that returns geoJSON, do I need to use the same library or does anybody have an idea how to convert JTS Geometry directly into JSON?

    thanks
    Imran
    Lahore, Pakistan

  • chirag Patil 6 March, 2010, 17:50

    can anyone have JSON java tutorial with output?
    If anyone has then plz contact me on patil.boss@gmail.com

  • Hitesh jain 26 May, 2010, 13:36

    Hi,
    I need to use json object in java and in javascript and in jsp….can any one help me how to populate it on the jsp. ASAP

  • Vinod Halde 12 October, 2010, 12:00

    Hi,
    I need to use json object in java and in javascript and in jsp….can any one help me how to populate it on the jsp. and also I need to have a simple example of the below
    1) Simple JSON example with Servlet

  • Kamal 26 June, 2011, 8:27

    Hi,

    Please I am interested to get the source code for the example.
    Thanks

  • Subramani 13 June, 2012, 10:23

    HI,
    i need to work with servlet and json using dropdownlist in html page to retrive the values from database selecting dropdownlist in html page…can u tell me how to do this

    Tanks..

  • kris 18 October, 2012, 2:55

    Good one…Thanks!

  • manan shah 23 October, 2012, 15:49

    Thnaks Viral….

    I like your freemarker’s articlea as well as this one…..

    thanks buddy.

    • manan shah 23 October, 2012, 15:49

      Thnaks Viral….

      I like your freemarker’s article as well as this one…..

      thanks buddy.

  • Parthiban 29 October, 2012, 16:41

    Hi,
    I have the following json string

    {"records":
    	{"data":
    		{"featureName":" ","fields":"{@pref_lang= eng}","ruleName":"RULE_HSIA_2","weightage":"93","indexNo":"1"}}}
    

    By using Google gson, can u tell me how can i create pojo class for the above nested json string ?

  • Siva 3 December, 2012, 20:26

    Thanks Viral….

    This article is looking good.

  • mike 7 December, 2012, 9:17

    I want to use geojson but don’t know how to install it.
    Is it a jar file or a javascript file you need to have in the classpath.

  • Vaibhav 11 December, 2012, 0:10

    well i followed this and generated the JSONObject and returned it.
    How to parse this using Jquery ?

    I Populated the list of String with Student Names say, and then accumulated the List to JsonObject and returned this object. How to parse this JSON object such that i could display the Names line by Line inside a . Please Help

  • Sarma 11 December, 2012, 15:30

    Hi..I need to take the values from database and need to save in json file for plotting bar graphs using D3 charts..pls help

  • kiran 3 January, 2013, 15:54

    how to retrive the data from multiple files in to html using jsplumb
    can post me an example in which i need to construct Network graph in my application

  • Jaydeep 4 February, 2013, 15:21

    Thanks viral…
    This was helpful example…

  • sheela 13 February, 2013, 12:57

    Nice Site..Keep UP.. :)

  • Shirish 14 March, 2013, 7:02

    I got the below Error when I used the above code

    Mar 13, 2013 6:30:55 PM org.apache.catalina.core.StandardWrapperValve invoke
    SEVERE: Servlet.service() for servlet [appServlet] in context with path [/csus] threw exception [Handler processing failed; nested exception is java.lang.NoClassDefFoundError: org/json/JSONObject] with root cause
    java.lang.ClassNotFoundException: org.json.JSONObject

  • dinesh 20 May, 2013, 23:32

    i have the douts how i can send the above map to the java script

  • joshua 26 August, 2013, 21:58

    How can use json with Jquery easyui,because i m not able to get the data on the grid.

  • prashansa 5 September, 2013, 16:15

    hello
    I have String in this formate [{"id":6,"children":[{"id":8,"children":[{"id":7,"children":[{"id":5}]}]}]},{“children”:[{"children":[{}]}]},{}]
    How can I get key and value.Please Rply.

    import java.util.List;
    class Data {
        private String title;
        private Long id;
        private Boolean children;
        private List<Data> groups;
     
        public String getTitle() { return title; }
        public Long getId() { return id; }
        public Boolean getChildren() { return children; }
        public List<Data> getGroups() { return groups; }
     
        public void setTitle(String title) { this.title = title; }
        public void setId(Long id) { this.id = id; }
        public void setChildren(Boolean children) { this.children = children; }
        public void setGroups(List<Data> groups) { this.groups = groups; }
     
        public String toString() {
            return String.format("title:%s,id:%d,children:%s,groups:%s", title, id, children, groups);
        }
    }
    
    import java.util.List;
    import com.google.gson.Gson;
     
    public class Test {
     
        public static void main(String... args) throws Exception {
        String jj=	"{'id':5},{'children':[{'id':6},{'children':[{'id':7},{}]}]},{'id':8},{}";
            
            // Now do the magic.
            Data data = new Gson().fromJson(jj, Data.class);
            System.out.println(data);
        }
     
    }
    
     

    Thanks
    prashansa

    • Abakasha 6 February, 2014, 10:41

      hello prashansa can u tell me why this toString() is there inside Data class …what is its need

  • prashansa 5 September, 2013, 17:06

    hello,

    When I am Using your code it’s giving an error

    Exception in thread "main" com.google.gson.JsonParseException: Failed parsing JSON source: {‘title’: ‘Computing and Information systems’,’id’ : 1,’children’ : ‘true’,’groups’ : [{'title' : 'Level one CIS','id' : 2,'children' : 'true','groups' : [{'title' : 'Intro To Computing and Internet','id' : 3,'children': 'false','groups':[]}]}]} to Json
    at com.google.gson.Gson.fromJson(Gson.java:328)
    at com.google.gson.Gson.fromJson(Gson.java:299)
    at Test.main(Test.java:27)
    Caused by: com.google.gson.TokenMgrError: Lexical error at line 1, column 2. Encountered: "\’" (39), after : ""
    at com.google.gson.JsonParserTokenManager.getNextToken(JsonParserTokenManager.java:762)
    at com.google.gson.JsonParser.jj_ntk(JsonParser.java:439)
    at com.google.gson.JsonParser.JsonObject(JsonParser.java:45)
    at com.google.gson.JsonParser.parse(JsonParser.java:21)
    at com.google.gson.Gson.fromJson(Gson.java:323)
    … 2 more

  • Bittu 21 February, 2014, 21:22

    Please help me to implement datatable with play and scala…..
    I am very thankful if anyone help me….

Leave a Reply

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

Note

To post source code in comment, use [code language] [/code] tag, for example:

  • [code java] Java source code here [/code]
  • [code html] HTML here [/code]

Current day month ye@r *