Welcome!

Java IoT Authors: Roger Strukhoff, Elizabeth White, Liz McMillan, Sematext Blog, Craig Lowell

Related Topics: Java IoT

Java IoT: Article

Java Serialization

Lesson 7, Java Basics

In lessons 5 and 6 of this series, you've learned how to use some of the Java streams to read or write bytes, characters or numeric data. This lesson is about reading or writing entire Java objects into streams.

Let's say your application uses a class that looks like this:

class Employee {
 String lName;
 String fName;
 double salary;
 java.util.Date hireDate;
 String address;
}

Now consider the following scenario: a program HeadQuarterEmpProcessor creates an instance of the object Employee. The values of its attributes (object's state) have to be saved in a file or some other stream. Later on, another program called BranchEmpProcessor needs to recreate the instance of this object Employee in memory.

We could have done it by using one of the streams like DataOutputStream, FileWriter or others. In this case both programs would need to know a format of the saved file (data types, order of the attributes and delimiters). Luckily, Java offers a more elegant way called object serialization, which greatly simplifies the process of objects exchange.

To send the entire object to a stream a program can use the class java.io.ObjectOutputStream, while the class java.io.ObjectInputStream knows how to get an object from a stream. To serialize an object means to convert it into a set of bytes and send it to a stream. To deserialize and object means to read these bytes from a stream and recreate the instance of the received object.

How to Make a Class Serializable

To make a class serializable, just declare that this class implements the interface Serializable:

class Employee implements java.io.Serializable {
 String lName;
 String fName;
 double salary;
 java.util.Date hireDate;
 String address;
}

The good news is that Serializable interface does not force you to implement any methods, that's why modification of the class Employee was minimal.

All attributes of the class Employee must have either primitive data types, or represent objects that are also serializable.

How to Serialize an Object

To serialize an object into a stream perform the following actions:

  • Open one of the output streams, for example FileOutputStream
  • Chain it with the ObjectOutputStream
  • Call the method writeObject() providing the instance of a Serializable object as an argument.
  • Close the streams

    The following example performs all these steps and creates a snapshot of the object Employee in the file called NewEmployee.ser

    import java.io.*;
    import java.util.Date;
    
    public class HeadQuarterEmpProcessor {
    
     public static void main(String[] args) {
    	Employee emp = new Employee();
    	emp.lName = "John";
    	emp.fName = "Smith"; 
    	emp.salary = 50000;
          emp.address = "12 main street";
          emp.hireDate = new Date(); 
        
          FileOutputStream fOut=null;
          ObjectOutputStream oOut=null;
    	   
          try{
           fOut= new FileOutputStream("c:\\NewEmployee.ser");
    	 oOut = new ObjectOutputStream(fOut);
    	 oOut.writeObject(emp);  //serializing employee
    	 System.out.println(
            "An employee is serialized into c:\\NewEmployee.ser");
          }catch(IOException e){
    	  e.printStackTrace(); 
          }finally{
      	  try {
    	    oOut.flush();
    	    oOut.close();
    	    fOut.close();
    	  } catch (IOException e1) {
    	   e1.printStackTrace();
    	  }
    	}
        }
    }
    

    If you do not want to serialize sensitive information such as salary, declare this variable using the keyword transient:

    transient double salary;

    The values of static and transient member variables are not serialized.

    How to Deserialize an Object

    To deserialize an object, perform the following steps:

  • Open an input stream
  • Chain it with the ObjectInputStream
  • Call the method readObject() and cast the returned object to the class that is being deserialized.
  • Close the streams

    The next example reads our file NewEmployee.ser and recreates the instance of the object Employee:

    import java.io.*;
    
    public class BranchEmpProcessor {
    
      public static void main(String[] args) {
       FileInputStream fIn=null;
       ObjectInputStream oIn=null;
    	   
       try{
        fIn= new FileInputStream("c:\\NewEmployee.ser");
        oIn = new ObjectInputStream(fIn);
       
        //de-serializing employee
        Employee emp = (Employee) oIn.readObject();
    				 
        System.out.println("Deserialized " + emp.fName + " " 
                     + emp.lName + " from NewEmployee.ser ");
       }catch(IOException e){
    	  e.printStackTrace(); 
       }catch(ClassNotFoundException e){
            e.printStackTrace(); 
       }finally{
    	try {
            oIn.close();
    	  fIn.close();
    	} catch (IOException e1) {
    	  e1.printStackTrace();
    	}
       }
     }
    }
    

    The class BranchEmpProcessor will produce the following output:

    Deserialized Smith John from NewEmployee.ser

    Please note that we did not explicitly created an instance of the object Employee - JVM did it for us. Make sure that definition of the class Employee is available to JVM that reads the stream. In distributed applications it usually runs on a remote machine.

    During the process of deserialization all transient variables will be initialized with default values according to their type, for example, integer variables will have the value of zero.

    Interface Externalizable

    The method writeObject() sends all attributes of an object into a stream. This could lead to unnecessary large object footprint, especially if you need to serialize the values only of some of the instance variables. Java provides Externalizable interface that gives you more control over what is being serialized and it can produce smaller object footprint.

    Externalizable interface is a subclass of Serializable.

    This interface defines 2 methods: readExternal() and writeExternal() and you have to implement these methods in the class that will be serialized (Employee). In these methods you'll have to write code that reads/writes only the values of the attributes you are interested in. Programs that perform serialization and deserialization have to write and read these attributes in the same sequence.

    The following class Employee2 serializes only the values of the last name and salary.

    import java.io.ObjectOutput;
    import java.io.ObjectInput;
    class Employee2 implements Externalizable {
     String lName;
     String fName;
     double salary; 
     java.util.Date hireDate;
     String address;
     
      public void writeExternal(ObjectOutput stream)
      				 throws java.io.IOException {
      // Serializing only salary and last name  
       stream.writeDouble(salary); 
       stream.writeUTF(lName);  // String encoded in UTF-8 format
      }
    
     public void readExternal(ObjectInput stream)
     				 throws java.io.IOException {
          salary = stream.readDouble();  
    	  lName  = stream.readUTF();
     }
    
    }
    

    The class HeadQuaterEmpProcessor2 shows how to externalize the object Employee2:

    import java.io.*;
    import java.util.Date;
    
    public class HeadQuarterEmpProcessor2 {
    
    	public static void main(String[] args) {
    		Employee2 emp = new Employee2();
    		emp.fName = "John";
    		emp.lName = "Smith"; 
    		emp.salary = 50000;
    	    emp.address = "12 main street";
    	    emp.hireDate = new Date(); 
        
    	   FileOutputStream fOut=null;
    	   ObjectOutputStream oOut=null;
    	   
    	   try{
    	     fOut= new FileOutputStream("c:\\NewEmployee2.ser");
    	     oOut = new ObjectOutputStream(fOut);
    	     emp.writeExternal(oOut);  //serializing employee
    	     System.out.println(
                "An employee is serialized into c:\\NewEmployee2.ser");
    
    	   }catch(IOException e){
    	   	  e.printStackTrace(); 
    	   }finally{
    		try {
    			oOut.flush();
    			oOut.close();
    			fOut.close();
    		} catch (IOException e1) {
    			e1.printStackTrace();
    		}
    	   }
    	}
    }
    

    Unlike with Serializable interface, we had to write a little more code to implement Externalizable interface, but the size of the file NewEmployee2.ser is only 21 bytes, whereas the file NewEmployee.ser has 207 bytes. First of all, we serialized the values of only two attributes, and the other reason is that files created using Externalizable interface contain data only, while files created by default Java serialization contain class metadata that include attribute names.

    The next code snippet shows you how to recreate an externalized object:

    fIn= new FileInputStream("c:\\NewEmployee2.ser");
    oIn = new ObjectInputStream(fIn);
    
    Employee2 emp = new Employee2();
    emp.readExternal(oIn);
    

    Serialization in the Real World

    In some types of applications you have to write the code to serialize objects, but in many cases serialization is performed behind the scenes by various server-side containers. These are some of the typical uses of serialization:

  • To persist data for future use.
  • To send data to a remote computer using such client/server Java technologies as RMI or socket programming.
  • To "flatten" an object into array of bytes in memory.
  • To exchange data between applets and servlets.
  • To store user session in Web applications.
  • To activate/passivate enterprise java beans.
  • To send objects between the servers in a cluster.

    When you use serialization in time-critical applications, for example real-time stock trading systems, the size of the serialized objects should be minimal. Keep in mind that variables with longer names produce larger footprints during serialization, and this may substantially slow down your application. Think of a high volume of trade orders that is being serialized. I remember working on the application where a class TradeOrder had about a hundred member variables. After renaming the variables into meaningless v1, v2, and so on, the size of one TradeOrder instance was reduced by a thousand bytes. And we are talking about serializing of thousands orders over the network!

    If performance is your primary goal, use Externalizable interface instead of Serializable. Yes, you'll have to write code to serialize each attribute, but this may speed up serialization process substantially.

    While applets can connect to a remote computer using socket or RMI programming (these technologies will be explained in the future lessons of this series), HTTP protocol and such Java classes as URL and URLConnection simplify network programming. With an HTTP protocol, applets can receive or send not only a text, but also binary objects using Java Serialization.

    When an EJB container decides to passivate (unload from memory) so-called stateful session bean, JVM persists its state in a safe place (usually on a disk). Later on, when this bean will be activated again, all its variables will be automatically deserialized by the EJB container.

    While it may not be too difficult for JVM to convert a primitive integer variable into four bytes for serialization, it's not as simple in case of classes containing variables with references to other objects. The process of converting such complex object into a sequence of bytes is called marshalling and the process of reconstructing of the objects from these bytes is called unmarshalling and Java does this job for you.

    Even though we have not learned yet how to create Web applications, I still want to mention that objects used for tracking of the user sessions should be serializable, otherwise you may not be able to deploy these application in a cluster of servers.

    Java serialization is a simple but powerful feature of the language, and you definitely will have a chance to use it in your applications.

  • More Stories By Yakov Fain

    Yakov Fain is a Java Champion and a co-founder of the IT consultancy Farata Systems and the product company SuranceBay. He wrote a thousand blogs (http://yakovfain.com) and several books about software development. Yakov authored and co-authored such books as "Angular 2 Development with TypeScript", "Java 24-Hour Trainer", and "Enterprise Web Development". His Twitter tag is @yfain

    Comments (9) View Comments

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


    Most Recent Comments
    ndhai 06/17/08 09:17:58 AM EDT

    I have some pb with a test following:

    package com.lecam;

    import java.io.*;

    public class testFile implements java.io.Externalizable{

    byte one_byte = 1;
    int one_int = 1024;

    public testFile() {
    }

    public void writeExternal(ObjectOutput stream) throws java.io.IOException {
    stream.writeByte(one_byte);
    stream.writeInt(one_int);
    }

    public void readExternal(ObjectInput stream) throws java.io.IOException {
    one_byte = stream.readByte();
    one_int = stream.readInt();
    }

    public static void main(String args1[]) {
    System.out.print("Writing...");
    try {
    testFile SubFile = new testFile();
    FileOutputStream fos = new FileOutputStream("c:\\test.bin");
    ObjectOutputStream oos = new ObjectOutputStream(fos);
    SubFile.writeExternal(oos);
    oos.flush();
    oos.close();
    fos.close();
    } catch (java.io.IOException e) {
    e.printStackTrace();
    } catch(Exception e) {
    e.printStackTrace();
    }

    System.out.print("Reading...");
    try {
    FileInputStream fis = new FileInputStream("c:\\test.bin");
    ObjectInputStream ois = new ObjectInputStream(fis);
    testFile tFile = new testFile();
    tFile.readExternal(ois);
    System.out.println("SubFile : ");
    System.out.println("byte : "+(tFile.one_byte));
    System.out.println("int : "+ (tFile.one_int));
    ois.close();
    fis.close();
    } catch (java.io.IOException e) {
    e.printStackTrace();
    } catch(Exception e) {
    e.printStackTrace();
    }
    System.out.print("END...");
    }
    }

    question: the test.bin file should be 5 bytes (one byte + one int = 1 + 4 = 5 bytes)
    but it is 11 bytes! I don't know why!
    thanks

    Sreerag 08/07/07 01:47:30 PM EDT

    You have explained it in a simple, nice manner. Thanks a lot !

    Sreerag K M 08/07/07 01:45:49 PM EDT

    The presentation is so nice, simple. Thanks a lot

    Josh 04/14/04 05:25:12 PM EDT

    Ravi,

    If you serialize an externalizeable object, it''s readExternal or writeExternal methods will automatically get called. So, the scenario you mention should never happen. When you implement Externalizable, you take control of the serialization completely, so the transient modifier will not have an effect on fields in the Externalizable object.

    Ravi 04/14/04 03:19:03 PM EDT

    Excellent article. I had a concern with transient data serialization when we do a serialization with externalizable interface. I mean when I implement a class with externalizable and do a normal serialization without being used its readExternal or writeExternal calls, then the Transient data is still get serialized.
    Can anyone update me on this point?

    Josh 04/14/04 07:19:06 AM EDT

    Good article. As the previous comment indicates, using Java serialization can introduce some problems when the objects are read in by a different version of the software. I don''t recommend using Java serialization for ''durable'' persistence for this reason. Using Externalizable can help, but for complex applications this encourages the programmer to blend the persistence and other, unrelated aspects into the same object, which is not the best design. I would recommend delegating the Externalizable implementation into another object in this case.

    Mathieu 03/31/04 03:04:31 AM EST

    Very Good introductory material. However I would like to add a paragraph on class version management.
    Upon a change of the code of your class if you try to read an old serialized data, you may experience error. Externalize interface is for now the safe way to prevent yourself from that.

    java-user 03/29/04 11:15:31 AM EST

    Excellent article. Liked real-world experiences shared by author.

    andre 03/26/04 05:01:30 PM EST

    Awesome! Did not know about the alternative to Serializable which exposes your application.

    @ThingsExpo Stories
    Personalization has long been the holy grail of marketing. Simply stated, communicate the most relevant offer to the right person and you will increase sales. To achieve this, you must understand the individual. Consequently, digital marketers developed many ways to gather and leverage customer information to deliver targeted experiences. In his session at @ThingsExpo, Lou Casal, Founder and Principal Consultant at Practicala, discussed how the Internet of Things (IoT) has accelerated our abil...
    SYS-CON Events announced today that 910Telecom will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Housed in the classic Denver Gas & Electric Building, 910 15th St., 910Telecom is a carrier-neutral telecom hotel located in the heart of Denver. Adjacent to CenturyLink, AT&T, and Denver Main, 910Telecom offers connectivity to all major carriers, Internet service providers, Internet backbones and ...
    With so much going on in this space you could be forgiven for thinking you were always working with yesterday’s technologies. So much change, so quickly. What do you do if you have to build a solution from the ground up that is expected to live in the field for at least 5-10 years? This is the challenge we faced when we looked to refresh our existing 10-year-old custom hardware stack to measure the fullness of trash cans and compactors.
    The emerging Internet of Everything creates tremendous new opportunities for customer engagement and business model innovation. However, enterprises must overcome a number of critical challenges to bring these new solutions to market. In his session at @ThingsExpo, Michael Martin, CTO/CIO at nfrastructure, outlined these key challenges and recommended approaches for overcoming them to achieve speed and agility in the design, development and implementation of Internet of Everything solutions wi...
    19th Cloud Expo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterpri...
    Is the ongoing quest for agility in the data center forcing you to evaluate how to be a part of infrastructure automation efforts? As organizations evolve toward bimodal IT operations, they are embracing new service delivery models and leveraging virtualization to increase infrastructure agility. Therefore, the network must evolve in parallel to become equally agile. Read this essential piece of Gartner research for recommendations on achieving greater agility.
    Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more business becomes digital the more stakeholders are interested in this data including how it relates to business. Some of these people have never used a monitoring tool before. They have a question on their mind like “How is my application doing” but no id...
    SYS-CON Events announced today that Venafi, the Immune System for the Internet™ and the leading provider of Next Generation Trust Protection, will exhibit at @DevOpsSummit at 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Venafi is the Immune System for the Internet™ that protects the foundation of all cybersecurity – cryptographic keys and digital certificates – so they can’t be misused by bad guys in attacks...
    Pulzze Systems was happy to participate in such a premier event and thankful to be receiving the winning investment and global network support from G-Startup Worldwide. It is an exciting time for Pulzze to showcase the effectiveness of innovative technologies and enable them to make the world smarter and better. The reputable contest is held to identify promising startups around the globe that are assured to change the world through their innovative products and disruptive technologies. There w...
    SYS-CON Events announced today Telecom Reseller has been named “Media Sponsor” of SYS-CON's 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
    Smart Cities are here to stay, but for their promise to be delivered, the data they produce must not be put in new siloes. In his session at @ThingsExpo, Mathias Herberts, Co-founder and CTO of Cityzen Data, will deep dive into best practices that will ensure a successful smart city journey.
    The 19th International Cloud Expo has announced that its Call for Papers is open. Cloud Expo, to be held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, brings together Cloud Computing, Big Data, Internet of Things, DevOps, Digital Transformation, Microservices and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportuni...
    DevOps at Cloud Expo, taking place Nov 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long dev...
    In today's uber-connected, consumer-centric, cloud-enabled, insights-driven, multi-device, global world, the focus of solutions has shifted from the product that is sold to the person who is buying the product or service. Enterprises have rebranded their business around the consumers of their products. The buyer is the person and the focus is not on the offering. The person is connected through multiple devices, wearables, at home, on the road, and in multiple locations, sometimes simultaneously...
    Internet of @ThingsExpo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devices - comp...
    For basic one-to-one voice or video calling solutions, WebRTC has proven to be a very powerful technology. Although WebRTC’s core functionality is to provide secure, real-time p2p media streaming, leveraging native platform features and server-side components brings up new communication capabilities for web and native mobile applications, allowing for advanced multi-user use cases such as video broadcasting, conferencing, and media recording.
    Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, will discuss the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
    Amazon has gradually rolled out parts of its IoT offerings in the last year, but these are just the tip of the iceberg. In addition to optimizing their back-end AWS offerings, Amazon is laying the ground work to be a major force in IoT – especially in the connected home and office. Amazon is extending its reach by building on its dominant Cloud IoT platform, its Dash Button strategy, recently announced Replenishment Services, the Echo/Alexa voice recognition control platform, the 6-7 strategic...
    Akana has announced the availability of version 8 of its API Management solution. The Akana Platform provides an end-to-end API Management solution for designing, implementing, securing, managing, monitoring, and publishing APIs. It is available as a SaaS platform, on-premises, and as a hybrid deployment. Version 8 introduces a lot of new functionality, all aimed at offering customers the richest API Management capabilities in a way that is easier than ever for API and app developers to use.
    Cloud computing is being adopted in one form or another by 94% of enterprises today. Tens of billions of new devices are being connected to The Internet of Things. And Big Data is driving this bus. An exponential increase is expected in the amount of information being processed, managed, analyzed, and acted upon by enterprise IT. This amazing is not part of some distant future - it is happening today. One report shows a 650% increase in enterprise data by 2020. Other estimates are even higher....