Java


JAVA.CLASS.SER.UIDU : Unexpected Serial Version Field (Java)

Summary

A serialVersionUID field is defined where it is not expected.

Serialization allows one to dump an object into a file and recover (deserialize) it later. For this to work, Java requires the class of the object to implement the java.io.Serializable interface. Moreover, all instance non-transient fields of the class must be serializable themselves. For inner non-static classes, also the outer class must be serializable. In order to distinguish dumps of objects for distinct versions of the same class, it is required that serializable classes define a static field containing the serial version of the class.

Properties

Class Name Unexpected Serial Version Field (Java)
Significance reliability
Mnemonic JAVA.CLASS.SER.UIDU
Categories
CWE CWE:913 Improper Control of Dynamically-Managed Code Resources
Availability Available for Java only.
Enabling Checks for this warning class are enabled by default. To disable them, add the following WARNING_FILTER rule to the project configuration file.
WARNING_FILTER += discard class="Unexpected Serial Version Field (Java)"

Resolution

Guarantee that all instance non-transient fields of a serializable class are themselves serializable. Make inner serializable classes have a serializable outer class, or make them static. Add a long serialVersionUID field to serializable classes.

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.