ObjectStreamClass: Peeking at a Java Object's Serialization

ObjectStreamClass can be a useful class to analyze the serialization characteristics of a serialized class loaded in the JVM. This post looks at some of the information this class provides about a loaded serialized class.

ObjectStreamClass provides two static methods for lookup of a class: lookup(class) and lookupAny(Class). The first, lookup(Class), will only return an instance of ObjectStreamClass when the provided class is serializable and returns null if the provided class is not serializable. The second, lookupAny(Class) returns an instance of ObjectStreamClass for the provided class regardless of whether it's serializable or not.

Once an instance of ObjectStreamClass is provided via the static "lookup" methods, that instance can be queried for class name, for serial version UID, and for serializable fields.

To demonstrate use of ObjectStreamClass, I first list the code listings for two simple classes that will be part of the demonstration. One class, Person, is Serializable, but has a transient field. The other class, UnserializablePerson, is nearly identical, but it is not Serializable.

Person.java

view plainprint?

1. package dustin.examples.serialization;  
2.   
3. import java.io.Serializable;  
4.   
5. /** 
6.  * Person class intended for demonstration of ObjectStreamClass. 
7.  *  
8.  * @author Dustin 
9.  */  
10. public class Person implements Serializable  
11. {  
12.    private final String lastName;  
13.    private final String firstName;  
14.    transient private final String fullName;  
15.   
16.    public Person(final String newLastName, final String newFirstName)  
17.    {  
18.       this.lastName = newLastName;  
19.       this.firstName = newFirstName;  
20.       this.fullName = this.firstName + " " + this.lastName;  
21.    }  
22.   
23.    public String getFirstName()  
24.    {  
25.       return this.firstName;  
26.    }  
27.   
28.    public String getLastName()  
29.    {  
30.       return this.lastName;  
31.    }  
32.   
33.    public String getFullName()  
34.    {  
35.       return this.fullName;  
36.    }  
37.   
38.    @Override  
39.    public String toString()  
40.    {  
41.       return this.fullName;  
42.    }  
43. }  

package dustin.examples.serialization;

import java.io.Serializable;

/**
 * Person class intended for demonstration of ObjectStreamClass.
 * 
 * @author Dustin
 */
public class Person implements Serializable
{
   private final String lastName;
   private final String firstName;
   transient private final String fullName;

   public Person(final String newLastName, final String newFirstName)
   {
      this.lastName = newLastName;
      this.firstName = newFirstName;
      this.fullName = this.firstName + " " + this.lastName;
   }

   public String getFirstName()
   {
      return this.firstName;
   }

   public String getLastName()
   {
      return this.lastName;
   }

   public String getFullName()
   {
      return this.fullName;
   }

   @Override
   public String toString()
   {
      return this.fullName;
   }
}

UnserializablePerson.java

view plainprint?

1. package dustin.examples.serialization;  
2.   
3. /** 
4.  * Person class intended for demonstration of ObjectStreamClass. 
5.  *  
6.  * @author Dustin 
7.  */  
8. public class UnserializablePerson  
9. {  
10.    private final String lastName;  
11.    private final String firstName;  
12.    private final String fullName;  
13.   
14.    public UnserializablePerson(final String newLastName, final String newFirstName)  
15.    {  
16.       this.lastName = newLastName;  
17.       this.firstName = newFirstName;  
18.       this.fullName = this.firstName + " " + this.lastName;  
19.    }  
20.   
21.    public String getFirstName()  
22.    {  
23.       return this.firstName;  
24.    }  
25.   
26.    public String getLastName()  
27.    {  
28.       return this.lastName;  
29.    }  
30.   
31.    public String getFullName()  
32.    {  
33.       return this.fullName;  
34.    }  
35.   
36.    @Override  
37.    public String toString()  
38.    {  
39.       return this.fullName;  
40.    }  
41. }  

package dustin.examples.serialization;

/**
 * Person class intended for demonstration of ObjectStreamClass.
 * 
 * @author Dustin
 */
public class UnserializablePerson
{
   private final String lastName;
   private final String firstName;
   private final String fullName;

   public UnserializablePerson(final String newLastName, final String newFirstName)
   {
      this.lastName = newLastName;
      this.firstName = newFirstName;
      this.fullName = this.firstName + " " + this.lastName;
   }

   public String getFirstName()
   {
      return this.firstName;
   }

   public String getLastName()
   {
      return this.lastName;
   }

   public String getFullName()
   {
      return this.fullName;
   }

   @Override
   public String toString()
   {
      return this.fullName;
   }
}

With two classes in place to run use in conjunction with ObjectStreamClass, it's now time to look at a simple demonstration application that shows use of ObjectStreamClass.

ObjectStreamClassDemo.java

view plainprint?

1. package dustin.examples.serialization;  
2.   
3. import static java.lang.System.out;  
4.   
5. import java.io.ObjectStreamClass;  
6. import java.io.ObjectStreamField;  
7.   
8. /** 
9.  * Demonstrates use of ObjectStreamDemo. 
10.  *  
11.  * @author Dustin 
12.  */  
13. public class ObjectStreamClassDemo  
14. {  
15.    /** 
16.     * Displays class name, serial version UID, and serializable fields as 
17.     * indicated by the provided instance of ObjectStreamClass. 
18.     *  
19.     * @param serializedClass  
20.     */  
21.    public static void displaySerializedClassInformation(  
22.       final ObjectStreamClass serializedClass)  
23.    {  
24.       final String serializedClassName = serializedClass.getName();  
25.       out.println("Class Name: " + serializedClassName);  
26.       final long serializedVersionUid = serializedClass.getSerialVersionUID();  
27.       out.println("serialversionuid: " + serializedVersionUid);  
28.       final ObjectStreamField[] fields = serializedClass.getFields();  
29.       out.println("Serialized Fields:");  
30.       for (final ObjectStreamField field : fields)  
31.       {  
32.          out.println("\t" + field.getTypeString() + " " + field.getName());  
33.       }  
34.    }  
35.   
36.    /** 
37.     * Main function that demonstrates use of ObjectStreamDemo. 
38.     *  
39.     * @param arguments Command line arguments; none expected. 
40.     */  
41.    public static void main(String[] arguments)  
42.    {  
43.       // Example 1: ObjectStreamClass.lookup(Class) on a Serializable class  
44.       out.println("\n=== ObjectStreamClass.lookup(Serializable) ===");  
45.       final ObjectStreamClass serializedClass = ObjectStreamClass.lookup(Person.class);  
46.       displaySerializedClassInformation(serializedClass);  
47.   
48.       // Example 2: ObjectStreamClass.lookup(Class) on a class that is not  
49.       //            Serializable (which will result in a NullPointerException  
50.       //            when trying to access null returned from 'lookup'  
51.       out.println("\n=== ObjectStreamClass.lookup(Unserializable) ===");  
52.       try  
53.       {  
54.          final ObjectStreamClass unserializedClass =  
55.             ObjectStreamClass.lookup(UnserializablePerson.class);  
56.          displaySerializedClassInformation(unserializedClass);  
57.       }  
58.       catch (NullPointerException npe)  
59.       {  
60.          out.println("NullPointerException: Unable to lookup unserializable class with ObjectStreamClass.lookup.");  
61.       }  
62.   
63.       // Example 3: ObjectStreamClass.lookupAny(Class) works without the  
64.       //            NullPointerException, but only provides name of the class as  
65.       //            Serial Version UID and serialized fields do not apply in the  
66.       //            case of a class that is not serializable.  
67.       out.println("\n=== ObjectStreamClass.lookupAny(Unserializable) ===");  
68.       final ObjectStreamClass unserializedClass =  
69.           ObjectStreamClass.lookupAny(UnserializablePerson.class);  
70.       displaySerializedClassInformation(unserializedClass);  
71.    }  
72. }  

package dustin.examples.serialization;

import static java.lang.System.out;

import java.io.ObjectStreamClass;
import java.io.ObjectStreamField;

/**
 * Demonstrates use of ObjectStreamDemo.
 * 
 * @author Dustin
 */
public class ObjectStreamClassDemo
{
   /**
    * Displays class name, serial version UID, and serializable fields as
    * indicated by the provided instance of ObjectStreamClass.
    * 
    * @param serializedClass 
    */
   public static void displaySerializedClassInformation(
      final ObjectStreamClass serializedClass)
   {
      final String serializedClassName = serializedClass.getName();
      out.println("Class Name: " + serializedClassName);
      final long serializedVersionUid = serializedClass.getSerialVersionUID();
      out.println("serialversionuid: " + serializedVersionUid);
      final ObjectStreamField[] fields = serializedClass.getFields();
      out.println("Serialized Fields:");
      for (final ObjectStreamField field : fields)
      {
         out.println("\t" + field.getTypeString() + " " + field.getName());
      }
   }

   /**
    * Main function that demonstrates use of ObjectStreamDemo.
    * 
    * @param arguments Command line arguments; none expected.
    */
   public static void main(String[] arguments)
   {
      // Example 1: ObjectStreamClass.lookup(Class) on a Serializable class
      out.println("\n=== ObjectStreamClass.lookup(Serializable) ===");
      final ObjectStreamClass serializedClass = ObjectStreamClass.lookup(Person.class);
      displaySerializedClassInformation(serializedClass);

      // Example 2: ObjectStreamClass.lookup(Class) on a class that is not
      //            Serializable (which will result in a NullPointerException
      //            when trying to access null returned from 'lookup'
      out.println("\n=== ObjectStreamClass.lookup(Unserializable) ===");
      try
      {
         final ObjectStreamClass unserializedClass =
            ObjectStreamClass.lookup(UnserializablePerson.class);
         displaySerializedClassInformation(unserializedClass);
      }
      catch (NullPointerException npe)
      {
         out.println("NullPointerException: Unable to lookup unserializable class with ObjectStreamClass.lookup.");
      }

      // Example 3: ObjectStreamClass.lookupAny(Class) works without the
      //            NullPointerException, but only provides name of the class as
      //            Serial Version UID and serialized fields do not apply in the
      //            case of a class that is not serializable.
      out.println("\n=== ObjectStreamClass.lookupAny(Unserializable) ===");
      final ObjectStreamClass unserializedClass =
          ObjectStreamClass.lookupAny(UnserializablePerson.class);
      displaySerializedClassInformation(unserializedClass);
   }
}

The comments in the source code above indicate what is being demonstrated. The output from running this class is shown in the next screen snapshot.

When the output shown above is correlated with the code before it, we can make several observations related to ObjectStreamClass. These include the fact that the transient field of a serializable class is not returned as one of the serializable fields. We also see that ObjectStreamClass.lookup(Class) method returns null if the class provided to it is not serializable. ObjectStreamClass.lookupAny(Class) returns an instance of ObjectStreamClass for classes that are not serializable, but only the class's name is available in that case.

The code above showed a Serial Version UID for Person.java of 1940442894442614965. When serialver is run on the command line, the same Serial Version UID is generated and displayed.

What's nice about the ability to programatically calculate the same Serial Version UID as would be calculated by the serialver tool that comes with the Oracle JDK is that one could explicitly add the same Serial Version UID to generated code as would be implicitly added anyway. Any JVM-friendly script or tool (such as one written in Groovy) that needs to know the implicit Serial Version UID of a class could use ObjectStreamClass to obtain that Serial Version UID.