Serialversionuid why

Stack Overflow for Teams — Collaborate and share knowledge with a private group. Create a free Team What is Teams? Collectives on Stack Overflow.

Learn more. Ask Question. Asked 13 years ago. Active 3 months ago. Viewed 1. Eclipse issues warnings when a serialVersionUID is missing. Find a good practise about serialversionUID; dzone. Add a comment. Active Oldest Votes. Serializable are probably about as good an explanation as you'll get: The serialization runtime associates with each serializable class a version number, called a serialVersionUID , which is used during deserialization to verify that the sender and receiver of a serialized object have loaded classes for that object that are compatible with respect to serialization.

Jon Skeet Jon Skeet 1. So, what you are saying essentially is that if a user did not understand all the above material, said user aught not bother worrying about serialization? I believe you answered the "how?

The why is in the second paragraph: if you don't explicitly specify serialVersionUID, a value is generated automatically - but that's brittle because it's compiler implementation dependent. JohnMerlino: Well I wouldn't expect it to say you need one - but it may be suggesting one in order to help you serialize exceptions correctly.

If you're not going to serialize them, you really don't need the constant. JohnMerlino, to answer the why part of you question: Exception implements Serializable and eclipse warns that you have not set an serialVersionUID, which would be a good idea if you wan't to serialize the class to avoid the problems that JonSkeet's post outlines. Show 18 more comments. MetroidFan MetroidFan 28k 16 16 gold badges 61 61 silver badges 79 79 bronze badges. I'd say that if you're not using serialization for permanent storage, you should use SuppressWarnings rather than adding a value.

It clutters the class less, and it preserves the abiity of the serialVersionUID mechanism to protect you from incompatible changes. I don't see how adding one line SuppressWarnings annotation as opposed to another line serializable id "clutters the class less". And if you're not using serialization for permanent storage, why wouldn't you just use "1"? You would not care about the autogenerated ID in that case anyways. Using SuppressWarnings documents the intent better if you don't wish to use the class for permanent storage.

Changing the actual serialVersionUID is a last resort, a counsel of despair. I would say, jvm generated serial id, should be fine. Show 7 more comments. Praveen Kumar Verma 2, 2 2 gold badges 13 13 silver badges 29 29 bronze badges. Scott Bale Scott Bale Yup, in case if the newer version changes any public member to protected, the default SerializableVersionUID will be different and will raise an InvalidClassExceptions.

It is worth noting that Joshua Bloch advices that for every Serializable class it's worth specifying the serial version uid. Quote from chapter Regardless of what serialized form you choose, declare an explicit serial version UID in every serializable class you write. This eliminates the serial version UID as a potential source of incompatibility Item There is also a small performance benefit. If no serial version UID is provided, an expensive computation is required to generate one at runtime.

Seems relevant. If the poster said "i'm serializing this thing and But the questioner also wants to know why he might not want to be warned. The questioner obviously cares about why there should be an UID. So simply telling him to ignore the warn should be downvoted. Alexander Torstling Alexander Torstling Adding or removing non-transient fields doesn't make the class serialization-incompatible.

There is therefore no reason to 'bump it' on such changes. EJP: Huh? Adding data definitely changes the serialization data in my world.

AlexanderTorstling Read what I wrote. I didn't say it doesn't 'change the serialization data'. I said it 'doesn't make the class serialization-incompatible'. It isn't the same thing. You need to read the Versioning chapter of the Object Serialization Specification.

EJP: I realize that adding a non-transient field doesn't necessarily mean that you make the class serialization-incompatible, but it is a structural change which alters the serialized data and you usually want to bump the version when doing so unless you handle backwards compatibility, which I also explained later in the post. What is your point exactly? My point remains exactly what I said. Adding or removing non-transient fields doesn't make the class Serialization-incompatible.

You therefore don't need to bump the serialVersionUID every time you do so. The javadocs for Serializable say : the default serialVersionUID computation is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected InvalidClassException s during deserialization.

Therefore, you must declare serialVersionUID because it give us more control. Jens Bannmann 4, 5 5 gold badges 47 47 silver badges 74 74 bronze badges. Thalaivar Thalaivar Vinothbabu but serialVersionUID is static so static variables cannot be serialized. The one thing not mentioned in this answer is that you may cause unintended consequences by blindly including serialVersionUID without knowing why.

Tom Anderson's comment on MetroidFan's answer addresses this: "I'd say that if you're not using serialization for permanent storage, you should use SuppressWarnings rather than adding a value. It clutters the class less, and it preserves the ability of the serialVersionUID mechanism to protect you from incompatible changes. The fully-qualified class name is that. It is a version indicator. Gray k 22 22 gold badges silver badges bronze badges.

Rupesh Rupesh 2, 1 1 gold badge 24 24 silver badges 42 42 bronze badges. Please explain what difference it makes. So different numbering schemes of different classes and libraries can't interfere in any way. Or did you imply code-generating libraries? The thing I always found crazy was that the algorithm to derive serialVersionUID when none is explicitly declared is based on package, name, attributes but ALSO methods Show 2 more comments.

First I need to explain what serialization is. There are some rules for serialization. An object is serializable only if its class or its superclass implements the Serializable interface An object is serializable itself implements the Serializable interface even if its superclass is not.

InvalidClassException in runtime All primitive types are serializable. Static fields with static modifier are not serialized. Where we need serialVersionID: During the deserialization to verify that sender and receiver are compatible with respect to serialization. Let's try this with an example. FileOutputStream; import java. IOException; import java. FileInputStream; import java. Not to execute the Writer class and you will get the exception.

Exception in thread "main" java. InvalidClassException: com. JegsVala JegsVala 1, 17 17 silver badges 26 26 bronze badges. You can encounter this situation when you are communicating with a server that has updated its 3rd party libs, but you the client did not yer done this. Paul Brinkley 6, 3 3 gold badges 22 22 silver badges 33 33 bronze badges. If you're not going to serialize the objects, why are they Serializable? It isn't mentioned anywhere in the Java Language Specification.

It's mentioned in the Object Versioning Specification. Here is the link to the Java 8 Object Versioning Specification. I think you're right that composition over inhneritance makes more sense, particularly when you're discussing classes such as ArrayList. However, many frameworks require people to extend from abstract superclasses which are serializable such as Struts 1. I think you're right, it would be nice if the warning were ignored in certain cases like if you were extending from an abstract serializable class — piepera.

Surely if you add a class as a member, rather than inheriting from it, you would have to write a wrapper method for EVERY method of the member class that you wished to use, which would make it unfeasible in a large number of situations But I suppose that this case is a sign of a design mistake - the users of your class e. What I don't like about delegation is the need to hold a reference to the delegate. And every reference means more memory. In other words, when the Class object for a dynamic proxy class is passed to the static lookup method of ObjectStreamClass, the returned ObjectStreamClass instance will have the following properties:.

When an ObjectStreamClass instance that does not represent a dynamic proxy class is written to the stream, it writes the class name and serialVersionUID , flags, and the number of fields. Depending on the class, additional information may be written:. The special static serializable field, serialPersistentFields , is an array of ObjectStreamField components that is used to override the default serializable fields. The getName method returns the name of the serializable field.

The getTypeString method returns the type signature of the field. The isPrimitive method returns true if the field is of primitive type, or false otherwise. The isUnshared method returns true if values of the field should be written as "unshared" objects, or false otherwise. The getOffset method returns the offset of the field's value within instance data of the class defining the field. The setOffset method allows ObjectStreamField subclasses to modify the offset value returned by the getOffset method.

The compareTo method compares ObjectStreamFields for use in sorting. Execute the Writer class, and it will create a file in the given path. This means the Employee class has changed in terms of serialization. You can try to revert to the old id and see — it will work. Published at DZone with permission of Krishantha Dinesh.

See the original article here. Thanks for visiting DZone today,. Edit Profile. Sign Out View Profile. Over 2 million developers have joined DZone.

Let's dive into seralVersionUIDs, why they are important to serialization and deserialization, and consider some best practices for their use.

Like Join the DZone community and get the full member experience. Join For Free. Let's try this with an example. The path name should be changed as needed : package com. FileOutputStream; import java. IOException; import java. FileInputStream; import java.