Updated June 20, 2023
Introduction to 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, an actual Java object is created in memory from a byte stream. Such a mechanism persists in the object. The byte stream so created from serialization does not depend on any platform. Any other platform can deserialize the object serialized on one platform without issue.
Thus, the entire process of serialization and deserialization is JVM-independent. To serialize a class object, you must implement the java.io.Serializable interface. Serializable in Java is a marker interface. It has no fields or methods to implement. This process makes a class serializable, resembling an Opt-In process.
Serialization in Java is implemented by the two classes ObjectInputStream and ObjectOutputStream. All that is required is to have a wrapper over them so they can be saved to a file or sent over a network.
Concept of Serialization in Java
The class ObjectOutputStream, a serialization class mentioned in the above section, contains several writing methods for writing various data types, but one method is the most popular.
public final void writeObject( Object x ) throws IOException
You can use the above method 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 needed is to cast it to a relevant data type.
Two conditions must be met for a successful serialization of a class.
- io. The class must implement a serializable interface.
- All fields of the class must be serializable. If even one field is not serializable, it should be marked transient.
If someone needs to check if a class is serializable, the simple solution is to check if the class implements the java.io.Serializable method; if it does, then it is serializable. If it’s 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.
Methods
If the class contains these methods, they are used for serialization in Java.
1. Method of Serialization in Java
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. |
2. 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. |
Example of Serialization in Java
An example in Java is provided here to demonstrate how serialization works in Java. We created an Employee class to study some features, and the code is provided below. This employee class implements the Serializable interface.
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 finishes executing, it will create a file named employee.ser. This program does not provide a guaranteed output, rather it is for explanatory purposes only, and the objective is to understand its use and to work.
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("https://cdn.educba.com/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("https://cdn.educba.com/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);
}
}
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 readObject () return value is always cast to an Employee reference.
- When the object was serialized, the SSN field had an initial value of 114433, which was not sent to the output stream. Because of the same, the deserialized Employee SSN field object is 0.
Conclusion
Above, we introduced serialization concepts and provided examples. Let’s understand the need for serialization in 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. The method may not be perfect, but it accomplishes the task.
- Persistence: If you want to store the state of an operation in a database, you first serialize it to a byte array and then store the byte array in the database for retrieval later.
- Deep Copy: If creating a replica of an object is challenging and writing a specialized clone class is difficult, then the goal can be achieved by serializing the object and then de-serializing it into another object.
- Cross JVM Synchronization: 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 basic concept, different methods of serialization in java with example. You may also look at the following articles to learn more –