Java JSON Processing (JSON-P) with Example
Last Updated :
17 Jul, 2022
JSON (JavaScript Object Notation) is text-based lightweight technology. Nowadays it is a dominant and much-expected way of communication in the form of key-value pairs. It is an easier way of transmitting data as it is having nice formatted way. We can nest the objects and also can provide JSON arrays also.
Implementation steps for a maven project
"jsonp" is the reference implementation for Java JSON Processing API. In a maven project, the required dependency has to be specified in pom.xml
XML
<dependency>
<groupId>org.glassfish</groupId>
<artifactId>javax.json</artifactId>
<version>1.0.2</version>
</dependency>
JSON processing can be done in 2 ways. They are provided by JSON API
| Object Model API | Features are similar to DOM Parser and it holds good for small objects. |
| Streaming API | Features are similar to StAX Parser and it holds good for large objects. Here we no need to keep the whole object in memory. |
Interfaces of Java JSON API:
| javax.json.JsonReader | To read a JsonObject or an array of JsonObject JsonReader is used. It is available from JSON class or JsonReaderFactory |
| javax.json.JsonWriter | Write JSON object to the output stream |
| javax.json.stream.JsonParser | Working functionality is a pull parser type and can provide support for reading JSON objects in a streaming way. |
| javax.json.stream.JsonGenerator | To write JSON objects in a streaming way. |
| javax.json.Json | This class has a variety of methods for creating these objects and their factories. |
| javax.json.JsonObject | This is the representation of immutable JSON object value. |
Let us see the above functionalities one by one. First let us take a sample JSON object. It may be stored in a file named "gfgwriterfile.txt". Key-value pair, the data is available.
Example: "id" is the key and its value is 123
{
"id":123,
"writerName":"GeekWriterA",
"status":true,
"address":{
"street":"MG Road",
"city":"Bangalore",
"zipcode":560100
},
"phoneNumbers":[1122334455, 1234567890],
"role":"HitechWriter"
}
We need to have Java bean classes to represent the above JSON format. Let us have 2 Java bean classes namely "Address.java" and "GFGWriter.java"
Address.java
Java
public class Address {
// attributes for address
private String street;
private String city;
private int zipcode;
// necessary getters and setters
public String getStreet() { return street; }
public void setStreet(String street)
{
this.street = street;
}
public String getCity() { return city; }
public void setCity(String city) { this.city = city; }
public int getZipcode() { return zipcode; }
public void setZipcode(int zipcode)
{
this.zipcode = zipcode;
}
@Override public String toString()
{
return getStreet() + ", " + getCity() + ", "
+ getZipcode();
}
}
We are going to use Address.java inside "GFGWriter.java"
GFGWriter.java
Java
import java.util.Arrays;
public class GFGWriter {
private int id;
private String writerName;
private boolean status;
private Address address;
private long[] phoneNumbers;
private String role;
public int getId() { return id; }
public void setId(int id) { this.id = id; }
public String getWriterName() { return writerName; }
public void setWriterName(String writerName)
{
this.writerName = writerName;
}
public boolean getStatus() { return status; }
public void setStatus(boolean status)
{
this.status = status;
}
public Address getAddress() { return address; }
public void setAddress(Address address)
{
this.address = address;
}
public long[] getPhoneNumbers() { return phoneNumbers; }
public void setPhoneNumbers(long[] phoneNumbers)
{
this.phoneNumbers = phoneNumbers;
}
public String getRole() { return role; }
public void setRole(String role) { this.role = role; }
@Override public String toString()
{
StringBuilder sb = new StringBuilder();
sb.append(
"***** GFG Portal Writer Details *****\n");
sb.append("ID=" + getId() + "\n");
sb.append("Writer Name=" + getWriterName() + "\n");
sb.append("Status=" + getStatus() + "\n");
sb.append("Role=" + getRole() + "\n");
sb.append("Phone Numbers="
+ Arrays.toString(getPhoneNumbers())
+ "\n");
sb.append("Address=" + getAddress());
sb.append("\n*****************************");
return sb.toString();
}
}
toString() method can be overridden as per our requirement and here, just a human-readable way it is written. Now let us see by using Java bean methods, let us see how to read the Java JSON
GFGWriterJSONReader.java (Here from gfgwriter.txt, we are going to read and display the data)
Java
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import javax.json.Json;
import javax.json.JsonArray;
import javax.json.JsonObject;
import javax.json.JsonReader;
import javax.json.JsonValue;
import com.gfg.model.Address;
import com.gfg.model.GFGWriter;
public class GFGWriterJSONReader {
public static final String JSON_FILE="gfgwriter.txt";
public static void main(String[] args) throws IOException {
InputStream fis = new FileInputStream(JSON_FILE);
// create JsonReader object
JsonReader jsonReader = Json.createReader(fis);
// get JsonObject from JsonReader
JsonObject jsonObject = jsonReader.readObject();
// we can close IO resource and JsonReader now
jsonReader.close();
fis.close();
// Retrieve data from JsonObject and create Employee bean
GFGWriter gfgWriter = new GFGWriter();
gfgWriter.setId(jsonObject.getInt("id"));
gfgWriter.setWriterName(jsonObject.getString("writerName"));
gfgWriter.setStatus(jsonObject.getBoolean("status"));
gfgWriter.setRole(jsonObject.getString("role"));
// reading arrays from json
JsonArray jsonArray = jsonObject.getJsonArray("phoneNumbers");
long[] numbers = new long[jsonArray.size()];
int index = 0;
for(JsonValue value : jsonArray){
numbers[index++] = Long.parseLong(value.toString());
}
gfgWriter.setPhoneNumbers(numbers);
// reading inner object from json object
JsonObject innerJsonObject = jsonObject.getJsonObject("address");
Address address = new Address();
address.setStreet(innerJsonObject.getString("street"));
address.setCity(innerJsonObject.getString("city"));
address.setZipcode(innerJsonObject.getInt("zipcode"));
gfgWriter.setAddress(address);
// print GFGWriter bean information
System.out.println(gfgWriter);
}
}
JsonReaderFactory implements Factory Design Pattern. Implementation is straightforward. On running the file, we will get the output as follows
Let us see the ways to write the JSON
GFGWriterCreation.java
Java
import com.gfg.model.Address;
import com.gfg.model.GFGWriter;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.OutputStream;
import javax.json.Json;
import javax.json.JsonArrayBuilder;
import javax.json.JsonObject;
import javax.json.JsonObjectBuilder;
import javax.json.JsonWriter;
public class GFGWriterCreation {
public static void main(String[] args)
throws FileNotFoundException
{
GFGWriter gfgWriter = createGFGWriter();
JsonObjectBuilder writerBuilder
= Json.createObjectBuilder();
JsonObjectBuilder addressBuilder
= Json.createObjectBuilder();
JsonArrayBuilder phoneNumberBuilder
= Json.createArrayBuilder();
for (long phone : gfgWriter.getPhoneNumbers()) {
phoneNumberBuilder.add(phone);
}
addressBuilder
.add("street",
gfgWriter.getAddress().getStreet())
.add("city", gfgWriter.getAddress().getCity())
.add("zipcode",
gfgWriter.getAddress().getZipcode());
writerBuilder.add("id", gfgWriter.getId())
.add("writerName", gfgWriter.getWriterName())
.add("status", gfgWriter.getStatus())
.add("role", gfgWriter.getRole());
writerBuilder.add("phoneNumbers",
phoneNumberBuilder);
writerBuilder.add("address", addressBuilder);
JsonObject gfgWriterJsonObject
= writerBuilder.build();
System.out.println("GFGWriter JSON String\n"
+ gfgWriterJsonObject);
// write to file
OutputStream os
= new FileOutputStream("gfgwriter.txt");
JsonWriter jsonWriter = Json.createWriter(os);
jsonWriter.writeObject(gfgWriterJsonObject);
jsonWriter.close();
}
public static GFGWriter createGFGWriter()
{
GFGWriter gfgWriter = new GFGWriter();
gfgWriter.setId(100);
gfgWriter.setWriterName("GeekA");
gfgWriter.setStatus(false);
gfgWriter.setPhoneNumbers(
new long[] { 123456, 987654 });
gfgWriter.setRole("Beginner");
Address add = new Address();
add.setCity("Bangalore");
add.setStreet("MG Road");
add.setZipcode(560100);
gfgWriter.setAddress(add);
return gfgWriter;
}
}
The JSON object is also getting saved in the 'gfgwriter.txt' file via the above code. JsonObjectBuilder implements builder pattern. On running the above program, we will be getting the output as
Java JSON Parser Example
GFGWriterJSONParser.java
Java
import com.gfg.model.Address;
import com.gfg.model.GFGWriter;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import javax.json.Json;
import javax.json.stream.JsonParser;
import javax.json.stream.JsonParser.Event;
public class GFGWriterJSONParser {
public static final String FILE_NAME
= "gfgwriterfile.txt";
public static void main(String[] args)
throws IOException
{
InputStream fis = new FileInputStream(FILE_NAME);
JsonParser jsonParser = Json.createParser(fis);
GFGWriter gfgWriter = new GFGWriter();
Address address = new Address();
String keyName = null;
List<Long> phoneNums = new ArrayList<Long>();
while (jsonParser.hasNext()) {
Event event = jsonParser.next();
switch (event) {
case KEY_NAME:
keyName = jsonParser.getString();
break;
case VALUE_STRING:
setStringValues(gfgWriter, address, keyName,
jsonParser.getString());
break;
case VALUE_NUMBER:
setNumberValues(gfgWriter, address, keyName,
jsonParser.getLong(),
phoneNums);
break;
case VALUE_FALSE:
setBooleanValues(gfgWriter, address,
keyName, false);
break;
case VALUE_TRUE:
setBooleanValues(gfgWriter, address,
keyName, true);
break;
case VALUE_NULL:
// don't set anything
break;
default:
// we are not looking for other events
}
}
gfgWriter.setAddress(address);
long[] nums = new long[phoneNums.size()];
int index = 0;
for (Long l : phoneNums) {
nums[index++] = l;
}
gfgWriter.setPhoneNumbers(nums);
System.out.println(gfgWriter);
// close resources
fis.close();
jsonParser.close();
}
private static void
setNumberValues(GFGWriter gfgWriter, Address address,
String keyName, long value,
List<Long> phoneNumbers)
{
switch (keyName) {
case "zipcode":
address.setZipcode((int)value);
break;
case "id":
gfgWriter.setId((int)value);
break;
case "phoneNumbers":
phoneNumbers.add(value);
break;
default:
System.out.println("Unknown element with key="
+ keyName);
}
}
private static void
setBooleanValues(GFGWriter gfgWriter, Address address,
String key, boolean value)
{
if ("status".equals(key)) {
gfgWriter.setStatus(value);
}
else {
System.out.println("Unknown element with key="
+ key);
}
}
private static void setStringValues(GFGWriter gfgWriter,
Address address,
String key,
String value)
{
switch (key) {
case "writerName":
gfgWriter.setWriterName(value);
break;
case "role":
gfgWriter.setRole(value);
break;
case "city":
address.setCity(value);
break;
case "street":
address.setStreet(value);
break;
default:
System.out.println("Unkonwn Key=" + key);
}
}
}
On running, we will get the same output as JSON Reader. That is similar output what we get during JSON reader. Complexity will be more if we need to parse complex JSON. Next, let us see JsonGeneratorExample
GFGWriterJSONGenerator.java
Java
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import javax.json.Json;
import javax.json.stream.JsonGenerator;
import com.gfg.model.GFGWriter;
public class GFGWriterJSONGenerator {
public static void main(String[] args) throws IOException {
OutputStream fos = new FileOutputStream("gfgwriter_stream.txt");
JsonGenerator jsonGenerator = Json.createGenerator(fos);
GFGWriter gfgWriter = GFGWriterCreation.createGFGWriter();
jsonGenerator.writeStartObject(); // {
jsonGenerator.write("id", gfgWriter.getId()); // "id":100
jsonGenerator.write("writerName", gfgWriter.getWriterName());
jsonGenerator.write("role", gfgWriter.getRole());
jsonGenerator.write("status", gfgWriter.getStatus());
jsonGenerator.writeStartObject("address") // start of address object
.write("street", gfgWriter.getAddress().getStreet())
.write("city",gfgWriter.getAddress().getCity())
.write("zipcode",gfgWriter.getAddress().getZipcode())
.writeEnd(); // end of address object
jsonGenerator.writeStartArray("phoneNumbers"); // start of phone num array
for(long num : gfgWriter.getPhoneNumbers()){
jsonGenerator.write(num);
}
jsonGenerator.writeEnd(); // end of phone num array
jsonGenerator.writeEnd(); // }
jsonGenerator.close();
}
}
On running the above program, we can see the contents written in "gfgwriter_stream.txt", "JsonGenerator" is very easy to use and its specialty is it provides good performance for large data.
Similar Reads
Java Tutorial Java is a high-level, object-oriented programming language used to build web apps, mobile applications, and enterprise software systems. Known for its Write Once, Run Anywhere capability, which means code written in Java can run on any device that supports the Java Virtual Machine (JVM).Syntax and s
7 min read
Basics
Introduction to JavaJava is a high-level, object-oriented programming language developed by Sun Microsystems in 1995. It is platform-independent, which means we can write code once and run it anywhere using the Java Virtual Machine (JVM). Java is mostly used for building desktop applications, web applications, Android
4 min read
Java Programming BasicsJava is one of the most popular and widely used programming language and platform. A platform is an environment that helps to develop and run programs written in any programming language. Java is fast, reliable and secure. From desktop to web applications, scientific supercomputers to gaming console
4 min read
Java MethodsJava Methods are blocks of code that perform a specific task. A method allows us to reuse code, improving both efficiency and organization. All methods in Java must belong to a class. Methods are similar to functions and expose the behavior of objects.Example: Java program to demonstrate how to crea
7 min read
Access Modifiers in JavaIn Java, access modifiers are essential tools that define how the members of a class, like variables, methods, and even the class itself, can be accessed from other parts of our program. They are an important part of building secure and modular code when designing large applications. In this article
6 min read
Arrays in JavaIn Java, an array is an important linear data structure that allows us to store multiple values of the same type. Arrays in Java are objects, like all other objects in Java, arrays implicitly inherit from the java.lang.Object class. This allows you to invoke methods defined in Object (such as toStri
9 min read
Java StringsIn Java, a String is the type of object that can store a sequence of characters enclosed by double quotes and every character is stored in 16 bits, i.e., using UTF 16-bit encoding. A string acts the same as an array of characters. Java provides a robust and flexible API for handling strings, allowin
8 min read
Regular Expressions in JavaIn Java, Regular Expressions or Regex (in short) in Java is an API for defining String patterns that can be used for searching, manipulating, and editing a string in Java. Email validation and passwords are a few areas of strings where Regex is widely used to define the constraints. Regular Expressi
7 min read
OOPs & Interfaces
Classes and Objects in JavaIn Java, classes and objects are basic concepts of Object Oriented Programming (OOPs) that are used to represent real-world concepts and entities. A class is a template to create objects having similar properties and behavior, or in other words, we can say that a class is a blueprint for objects.An
10 min read
Java ConstructorsIn Java, constructors play an important role in object creation. A constructor is a special block of code that is called when an object is created. Its main job is to initialize the object, to set up its internal state, or to assign default values to its attributes. This process happens automaticall
10 min read
Java OOP(Object Oriented Programming) ConceptsBefore Object-Oriented Programming (OOPs), most programs used a procedural approach, where the focus was on writing step-by-step functions. This made it harder to manage and reuse code in large applications.To overcome these limitations, Object-Oriented Programming was introduced. Java is built arou
10 min read
Java PackagesPackages in Java are a mechanism that encapsulates a group of classes, sub-packages and interfaces. Packages are used for: Prevent naming conflicts by allowing classes with the same name to exist in different packages, like college.staff.cse.Employee and college.staff.ee.Employee.Make it easier to o
7 min read
Java InterfaceAn Interface in Java programming language is defined as an abstract type used to specify the behaviour of a class. An interface in Java is a blueprint of a behaviour. A Java interface contains static constants and abstract methods. Key Properties of Interface:The interface in Java is a mechanism to
11 min read
Collections
Exception Handling
Java Exception HandlingException handling in Java is an effective mechanism for managing runtime errors to ensure the application's regular flow is maintained. Some Common examples of exceptions include ClassNotFoundException, IOException, SQLException, RemoteException, etc. By handling these exceptions, Java enables deve
8 min read
Java Try Catch BlockA try-catch block in Java is a mechanism to handle exceptions. This make sure that the application continues to run even if an error occurs. The code inside the try block is executed, and if any exception occurs, it is then caught by the catch block.Example: Here, we are going to handle the Arithmet
4 min read
Java final, finally and finalizeIn Java, the keywords "final", "finally" and "finalize" have distinct roles. final enforces immutability and prevents changes to variables, methods or classes. finally ensures a block of code runs after a try-catch, regardless of exceptions. finalize is a method used for cleanup before an object is
4 min read
Chained Exceptions in JavaChained Exceptions in Java allow associating one exception with another, i.e. one exception describes the cause of another exception. For example, consider a situation in which a method throws an ArithmeticException because of an attempt to divide by zero.But the root cause of the error was an I/O f
3 min read
Null Pointer Exception in JavaA NullPointerException in Java is a RuntimeException. It occurs when a program attempts to use an object reference that has the null value. In Java, "null" is a special value that can be assigned to object references to indicate the absence of a value.Reasons for Null Pointer ExceptionA NullPointerE
5 min read
Exception Handling with Method Overriding in JavaException handling with method overriding in Java refers to the rules and behavior that apply when a subclass overrides a method from its superclass and both methods involve exceptions. It ensures that the overridden method in the subclass does not declare broader or new checked exceptions than thos
4 min read
Java Advanced
Java Multithreading TutorialThreads are the backbone of multithreading. We are living in the real world which in itself is caught on the web surrounded by lots of applications. With the advancement in technologies, we cannot achieve the speed required to run them simultaneously unless we introduce the concept of multi-tasking
15+ min read
Synchronization in JavaIn multithreading, synchronization is important to make sure multiple threads safely work on shared resources. Without synchronization, data can become inconsistent or corrupted if multiple threads access and modify shared variables at the same time. In Java, it is a mechanism that ensures that only
10 min read
File Handling in JavaIn Java, with the help of File Class, we can work with files. This File Class is inside the java.io package. The File class can be used to create an object of the class and then specifying the name of the file.Why File Handling is Required?File Handling is an integral part of any programming languag
6 min read
Java Method ReferencesIn Java, a method is a collection of statements that perform some specific task and return the result to the caller. A method reference is the shorthand syntax for a lambda expression that contains just one method call. In general, one does not have to pass arguments to method references.Why Use Met
9 min read
Java 8 Stream TutorialJava 8 introduces Stream, which is a new abstract layer, and some new additional packages in Java 8 called java.util.stream. A Stream is a sequence of components that can be processed sequentially. These packages include classes, interfaces, and enum to allow functional-style operations on the eleme
15+ min read
Java NetworkingWhen computing devices such as laptops, desktops, servers, smartphones, and tablets and an eternally-expanding arrangement of IoT gadgets such as cameras, door locks, doorbells, refrigerators, audio/visual systems, thermostats, and various sensors are sharing information and data with each other is
15+ min read
JDBC TutorialJDBC stands for Java Database Connectivity. JDBC is a Java API or tool used in Java applications to interact with the database. It is a specification from Sun Microsystems that provides APIs for Java applications to communicate with different databases. Interfaces and Classes for JDBC API comes unde
12 min read
Java Memory ManagementJava memory management is the process by which the Java Virtual Machine (JVM) automatically handles the allocation and deallocation of memory. It uses a garbage collector to reclaim memory by removing unused objects, eliminating the need for manual memory managementJVM Memory StructureJVM defines va
4 min read
Garbage Collection in JavaGarbage collection in Java is an automatic memory management process that helps Java programs run efficiently. Objects are created on the heap area. Eventually, some objects will no longer be needed.Garbage collection is an automatic process that removes unused objects from heap.Working of Garbage C
6 min read
Memory Leaks in JavaIn programming, a memory leak happens when a program keeps using memory but does not give it back when it's done. It simply means the program slowly uses more and more memory, which can make things slow and even stop working. Working of Memory Management in JavaJava has automatic garbage collection,
3 min read
Practice Java
Java Interview Questions and AnswersJava is one of the most popular programming languages in the world, known for its versatility, portability, and wide range of applications. Java is the most used language in top companies such as Uber, Airbnb, Google, Netflix, Instagram, Spotify, Amazon, and many more because of its features and per
15+ min read
Java Programs - Java Programming ExamplesIn this article, we will learn and prepare for Interviews using Java Programming Examples. From basic Java programs like the Fibonacci series, Prime numbers, Factorial numbers, and Palindrome numbers to advanced Java programs.Java is one of the most popular programming languages today because of its
8 min read
Java Exercises - Basic to Advanced Java Practice Programs with SolutionsLooking for Java exercises to test your Java skills, then explore our topic-wise Java practice exercises? Here you will get 25 plus practice problems that help to upscale your Java skills. As we know Java is one of the most popular languages because of its robust and secure nature. But, programmers
7 min read
Java Quiz | Level Up Your Java SkillsThe best way to scale up your coding skills is by practicing the exercise. And if you are a Java programmer looking to test your Java skills and knowledge? Then, this Java quiz is designed to challenge your understanding of Java programming concepts and assess your excellence in the language. In thi
1 min read
Top 50 Java Project Ideas For Beginners and Advanced [Update 2025]Java is one of the most popular and versatile programming languages, known for its reliability, security, and platform independence. Developed by James Gosling in 1982, Java is widely used across industries like big data, mobile development, finance, and e-commerce.Building Java projects is an excel
15+ min read