Serialization in Java With Examples

Serialization in Java

Serialization in Java is a mechanism that converts an object’s state into a byte stream. Deserialization is its reverse process. Through deserialization, from a byte stream, actual Java object is created in the memory. Such mechanism persists the object.

The byte stream so created from serialization does not depend on any platform. The object serialized on one platform can be deserialized on any other platform without any issue. Thus, the entire process of serialization and deserialization is JVM independent.

If a class object is to be serialized, then one needs to implement the java.io.Serializable interface. Serializable in java is a marker interface. It has no fields or methods to implement. A class is made serializable by this process which looks like an Opt-In process.

Serialization in Java is implemented by the two classes ObjectInputStream and ObjectOutputStream.

All that is required is a wrapper over them so that it can be saved to file or can be sent over a network.

The concept of Serialization in Java

The class ObjectOutputStream which is serialization class as mentioned in above section contains several write methods for writing various data types, but one method is most popular

public final void writeObject(Object x) throws IOException

The above method can be used to serialize an Object. This method also sends it to the output stream. In the same way, ObjectInputStream class contains the method for object deserializing

public final Object readObject() throws IOException, ClassNotFoundException

The deserialization method retrieves the object from a stream and deserializes the same. The return value is again an object, so all that is needed is to cast it to relevant data type.

For a class to be serialized successfully, there are two conditions that must be met −

• io. Serializable interface must be implemented by the class.
• All fields of the class must be serializable. If even one field is not serializable, then it should be marked transient.

If someone needs to check if a class is serializable or not, the simple solution is to check if the class implements the java.io.Serializable method, if it does then it is serializable if it not then it’s not.

One should notice that when serializing an object to a file, the standard practice is to give the file a .ser extension.

Method Of Serialization in Java

If these methods are present in the class, they are used for serialization in Java purposes.

Method	Description
public final void writeObject(Object obj) throws IOException {}	This will write the specified object to the ObjectOutputStream.
public void flush() throws IOException {}	This will flush the current output stream.
public void close() throws IOException {}	This will close the current output stream.

Method Of Deserialization in Java

Method	Description
public final Object readObject() throws IOException, ClassNotFoundException{}	This will read an object from the input stream.
public void close() throws IOException {}	This will close ObjectInputStream.

Examples Of Serialization in Java

In this section, we have discussed Serialization in Java with examples.

An example in Java is provided here to demonstrate how serialization works in Java. We create an Employee class to study some features and the code for same is provided below. This employee class implements the Serializable interface.

Java Course 50 Online Courses | 240+ Hours | Verifiable Certificate of Completion | Lifetime Access Watch The Course Preview

public class Employee implements java.io.Serializable {
public String name;
public String address;
public transient int SSN;
public int number;
public void mailCheck() {
System.out.println("Mailing a letter to " + name + " " + address);
}
}

When this program will be done with executing, a file named employee.ser would be created. This program does not provide a guaranteed output, rather it is for explanatory purpose only and the objective is to understand its use and working.

import java.io.*;
public class SerializeDemo {
public static void main(String [] args) {
Employee e = new Employee();
e.name = "Rahul Jain";
e.address = "epip, Bangalore";
e.SSN = 114433;
e.number = 131;
try {
FileOutputStream fileOut =
new FileOutputStream("/tmp/employee.ser");
ObjectOutputStream out = new ObjectOutputStream(fileOut);
out.writeObject(e);
out.close();
fileOut.close();
System.out.printf("Serialized data saved in /tmp/employee.ser");
} catch (IOException i) {
i.printStackTrace();
}
}
}

The below described DeserializeDemo program deserializes the above Employee object created in the Serialize Demo program.

import java.io.*;
public class DeserializeDemo {
public static void main(String [] args) {
Employee e = null;
try {
FileInputStream fileIn = new FileInputStream("/tmp/employee.ser");
ObjectInputStream in = new ObjectInputStream(fileIn);
e = (Employee) in.readObject();
in.close();
fileIn.close();
} catch (IOException i) {
i.printStackTrace();
return;
} catch (ClassNotFoundException c) {
System.out.println("Employee class is not found");
c.printStackTrace();
return;
}
System.out.println("Deserialized Employee...");
System.out.println("Name: " + e.name);
System.out.println("Address: " + e.address);
System.out.println("SSN: " + e.SSN);
System.out.println("Number: " + e.number);
}
}

The above code will produce the following result −

Output

Deserialized Employee…

Name: Rahul Jain

Address: epip, Bangalore

SSN: 0

Number:131

Some important points related to the program above are provided below  −

• The try/catch block above tries to catch a ClassNotFoundException. This is declared by the readObject() method.
• A JVM can deserialize an object, only if it finds the bytecode for the class.
• If the JVM does not find a class during the deserialization, it will throw ClassNotFoundException.
• the return value of readObject() is always cast to an Employee reference.
• SSN field value was 114433 initially when the object was serialized, but as this value was not sent to the output stream. Because of the same, the deserialized Employee SSN field object is 0.

Conclusion: Serialization in Java

Above, we introduced serialization concepts and provided examples. Let’s understand the need for serialization as our concluding remarks.

• Communication: If two machines that are running the same code need to communicate the easy way out is that one machine should build an object containing information that it would transmit, and then serialize that object before sending it to the other machine. Not a great method, but gets the job done.
• Persistence: If the state of operation is to be stored in a database, it is first serialized to a byte array and then stored in the database for retrieval at a later point of time.
• Deep Copy: If an exactreplica of an Object needs to be created and writing specialized clone class is too much hard work, then by only serializing the object and then de-serializing it to another object will achieve the goal.
• Cross JVM Synchronization: different JVMs running on different machines and architectures can be synchronized.

Recommended Articles

This has been a guide to Serialization in Java. Here we have discussed the Different methods of Serialization in Java with examples. You may also look at the following article to learn more –

1. Java Developer Interview Questions
2. Java List vs Array List
3. Uses of JavaScript