How To Serialize Object Inwards Coffee - Serialization Example

Serialization is i of the of import but confusing concept inwards Java. Even experienced Java developer care to implement Serialization correctly. The Serialiation mechamism is provided yesteryear Java to salve in addition to restore state of an object programatically. Java provides ii classes Serializable in addition to Externalizable inwards java.io parcel to facilitate this process, both are marker interface i.e. an interface without whatsoever methods. Serializing an Object inwards Java agency converting into a wire format so that you lot tin terminate either persists its state inwards a file locally or transfer it to around other customer via the network, thus it locomote yesteryear away an extrememly of import concept inwards distributed applications running across several JVMs. There are other features inwards Java e.g. Remote Method Invocation (RMI) or HttpSession inwards Servlet API which mandates the participating object should impelment Serializable interface because they may live transffered in addition to saved across the network.

In this article, I receive got tried to explicate the concept in addition to procedure of Serialization yesteryear taking a unproblematic instance of a full general role object inwards Java. We receive got a shape called Shoe, which represents a Shoe, receive got instance variable to correspond id, color, in addition to size in addition to staic variable to correspond brand. I receive got included both transient in addition to static variable to seek that those fields are non saved during Serialization process.

You tin terminate also read Head First Java to larn to a greater extent than nearly subtle details of Serialization inwards Java. They receive got covered the serilization theme merely right, neither also much exceptional nor small explanation. I receive got learned a lot of useful details from there.

I receive got also explained the opposite procedure of Serialization to restore the state of object i.e. de-serialization in addition to why SerialVersionUID is of import for whatsoever serializable class. Once nosotros restore the object nosotros impress it's state to compare values earlier serialization. This volition laissez passer on you lot clear thought nearly how you lot tin terminate salve in addition to restore objects inwards Java.

Java Program to Serialize an Object using Serializable interface

Here is our Java programme to demonstrate how to serialize in addition to de-serialize an object inwards Java. This programme contains ii classes Shoe in addition to SerializationDemo, the kickoff shape is our POJO, nosotros volition exercise object of this shape in addition to serialieze it. The minute shape is our application shape which contains the main() method, all the code to exercise object, saving it, in addition to lastly restoring it written within primary method.

import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import java.util.logging.Logger;  /**  * Simple instance of Serialization inwards Java. We kickoff exercise a Shoe object, so  * serializes it in addition to lastly restored it yesteryear using de-serialization.  *  * @author Javin Paul  */ public class Pattern {      public static void main(String args[]) throws IOException, ClassNotFoundException {         Shoe whiteNikeShoe = new Shoe("Nike", 1000, 9, "WHITE", true);         System.out.println("Before Serialization");         whiteNikeShoe.print();          // serializing shoe object         writeShoe(whiteNikeShoe);          // creating around other Shoe amongst unlike brand         Shoe blackAdidasShoe = new Shoe("Adidas", 2000, 8, "Black", true);                           // deserializing shoe object         whiteNikeShoe = (Shoe) readShoe();          System.out.println("After DeSerialization");         whiteNikeShoe.print();     }      private static void writeShoe(Serializable shoe) throws IOException {         ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream(new File("shoe.ser")));         oos.writeObject(shoe);         oos.close();     }      private static Object readShoe() throws IOException, ClassNotFoundException {         ObjectInputStream ois = new ObjectInputStream(new FileInputStream(new File("shoe.ser")));         Object obj = ois.readObject();         return obj;     }  }  class Shoe implements Serializable {      // static terminal variable     private static final long serialVersionUID = 40L;     private static final Logger logger = Logger.getLogger(Shoe.class.getName());      // static variable but non final     private static String _brand;      // instance variable     private int _id;     private int _size;     private String _color;      // transient variable     private transient boolean _isRunningShoe;      // non serializable field     Thread _thread;      public Shoe(String brand, int id, int size, String color, boolean isRunningShoe) {         System.out.println("Inside Constructor");         _brand = brand;         _id = id;         _size = size;         _color = color;         _isRunningShoe = isRunningShoe;      }      public String brand() {         return _brand;     }      public int id() {         return _id;     }      public int size() {         return _size;     }      public String color() {         return _color;     }      public void print() {         System.out.println("SerialVersionUID (final static field) : " + serialVersionUID);         System.out.println("logger ((final static field) : " + logger);         System.out.println("_brand (static field) : " + _brand);         System.out.println("_id (instance variable) : " + _id);         System.out.println("_size (instance variable) : " + _size);         System.out.println("_color (instance variable) : " + _color);         System.out.println("_isRunningShoed (transient variable) : " + _isRunningShoe);         System.out.println("_thread (non-serializable field) : " + _thread);      }  }  Output Inside Constructor Before Serialization SerialVersionUID (final static field) : forty logger ((final static field) : java.util.logging.Logger@42aab87f _brand (static field) : Nike _id (instance variable) : k _size (instance variable) : ix _color (instance variable) : WHITE _isRunningShoed (transient variable) : true _thread (non-serializable field) : null Inside Constructor After DeSerialization SerialVersionUID (final static field) : forty logger ((final static field) : java.util.logging.Logger@42aab87f _brand (static field) : Adidas _id (instance variable) : k _size (instance variable) : ix _color (instance variable) : WHITE _isRunningShoed (transient variable) : false _thread (non-serializable field) : null
 

Influenza A virus subtype H5N1 motion-picture present is worth a K word, so hither is a diagram which explains the serialization in addition to deserializtion procedure from a 10K feet view:

Observation in addition to Explanation

Now let's sweat to empathize what happened when nosotros serialize an instance of Shoe in addition to afterward when nosotros de-serialized it. I receive got created unlike types of variable inwards this shape to present that whether their value is persisted or restored during Serialization or not. In Shoe class, nosotros receive got ii static terminal fields, SerialVersionUID, in addition to Logger; their values are non persisted but because they are static. They are also initialized at the fourth dimension of shape loading, so they are fine. Also, because they are final, at that spot is no danger of somebody changing their value.

The SerialVersionUID is really of import patch for a serializable shape in addition to you lot should ever define it. If you lot don't define so JVM volition calculate this value yesteryear reading construction of shape e.g. let out of instance variable, their types etc. This means, adjacent fourth dimension you lot add together around other instance variable or you lot rmeove one-time one, you lot run a endangerment of getting a unlike SerialVersionUID in addition to if that happens you lot won't live able to restore object saved yesteryear previous version of your program.

This has genuinely happend to us when i of the developer accidently removed the SerialVersionUID from i of the user preferences shape in addition to when user download in addition to run the novel version of our Java application, his preferences was all gone. He was a trader in addition to for them their preferences agency a lot, it was difficult fourth dimension to console in addition to pacify him earlier nosotros reverted dorsum his GUI to previous version in addition to restored his preferences. I am sure, you lot would never desire to upset your clients in addition to user.

Serialization is total of such details in addition to I highly recommend to read Joshua Bloch suggest on Effective Java related to Serialization earlier implementing it inwards your existent globe project. Those are invaluable slice of advice in addition to key to successfully in addition to correcly implment Serliazable inwards anything other than a demo programme similar this one.

Now let's come upward to a simple, non-final static variable, its value is also non persisted during Serialization, that's why you lot run across _brand=Nike earlier Serialization in addition to _brand=Adidas after. Do you lot know why it happened? because when nosotros created around other instance of Shoe for Adidas, nosotros reset value of this variable to "Adidas", in addition to since the constructor is non called during deserialization, in addition to shape is non loaded again, its value remains "Adidas". It could receive got been null if de-serialization would receive got taken house at around other JVM instance.

Now let's run across our 3 instance variables _id, _size, in addition to _color, their values are persisted during serialization in addition to restored during de-serialization. This is why nosotros run across right values for these 3 fields. Next is our transient variable isRunningShoe, this is tricky one, value of a transient variable is non stored during Serialization in addition to that's why the value of isRunningShoe is wrong after de-serialization.

It was true earlier but it became false after de-serialization. You would non receive got noticed this had that boolean variable was initialized every bit false, in addition to you lot would receive got thought that value of the transient variable was saved in addition to restored, which is non true. So beware of default values during Serialization, variables similar static in addition to transient volition live initialized to their default value after de-serialization.

Last is our non-serializable instance variable _thread, which holds the instance of java.lang.Thread, which doesn't implement the Serializable interface. It's genuinely interesting that default Serialization process doesn't complain nearly this variable, this tin terminate also live tricky to empathize if don't pay plenty attention. The argue was that variable didn't concord whatsoever value.

Now merely initialize that variable every bit Thread _thread = novel Thread() in addition to re-run the programme again. This time,will acquire the next Exception :

Exception in thread "main" java.io.NotSerializableException: java.lang.Thread  at java.io.ObjectOutputStream.writeObject0(Unknown Source)  at java.io.ObjectOutputStream.defaultWriteFields(Unknown Source)  at java.io.ObjectOutputStream.writeSerialData(Unknown Source)  at java.io.ObjectOutputStream.writeOrdinaryObject(Unknown Source)  at java.io.ObjectOutputStream.writeObject0(Unknown Source)  at java.io.ObjectOutputStream.writeObject(Unknown Source)  at SerializationDemo.writeShoe(HelloHP.java:42)  at SerializationDemo.main(HelloHP.java:28)

Because Thread doesn't implement Serializable interface, you lot tin terminate non serialize it. This is a really mutual work during maintenance of a legacy Java project. Suppose you lot receive got a Serializable shape Employee, in addition to afterward i developer introduced around other instance variable Department, which is non Serializable. Do you lot know what volition happen? The Employee tin terminate non live serialized anymore.

That's why I recommend putting Serialization alert inwards the source file of a Serializable classes, reminding them nearly non adding whatsoever variable which is non serializable or making it transient if they genuinely require it. You tin terminate see Java Coding Guidelines for to a greater extent than coding best pracitces spell writing Java application. It contains 75 recommendations for reliable in addition to secure Java programs.

In short, nosotros tin terminate tell that :

• The value of static variable is non persisted during Serialization.
• Thetransient variables are non persisted every bit well.
• Any NonSerializable field, which is non static or transient volition interruption Serialization procedure yesteryear throwing ava.io.NotSerializableException.
• The constructor of serializable shape is non called during Serialization.

That's all nearly how to searialize an object inwards Java using Serializable interface. We receive got seen both saving in addition to restoring object using serialization in addition to de-serialization in addition to also explored around key concepts related to how serialization plant inwards Java. For example, transient in addition to static variables are non saved during serialization, if you lot declare static variable, gear upward certain it's non final, in addition to to shout out upward that constructor is non called during de-serialization process.

All these concepts are really of import to implement serialization correctly inwards your pgoram. You tin terminate farther read Effective Java yesteryear Joshua Bloch to empathize effective serialization e.g. amongst custom binary formats.  All the items related to Serialization inwards this majority is must read for whatsoever serious Java developer.


Other Java serialization tutorials you lot may similar to explore

• What Every Java developer should knwo nearly Serialization (read)
• Difference betwixt Serializable in addition to Externalizable inwards Java? (answer)
• Why should you lot utilisation SerialVersionUID inwards Java? (answer)
• Google Protocol Buffer - a fast choice of serialization inwards Java? (tutorial)
• Difference betwixt transient in addition to volatile variable inwards Java? (answer)
• How to utilisation transient variable inwards Serializable class? (answer)

Further Learning
Complete Java Masterclass
Java Fundamentals: The Java Language
Java In-Depth: Become a Complete Java Engineer!

Share this post