Millal on vaja muuta serialVersionUID välja väärtust?

serialVersionUID väärtus tuleks muuta, kui serialiseeritava klassi struktuuris tehakse mitteühilduvaid muudatusi. See tähendab, et muudatused rikuvad serialiseeritud andmete formaadi tagasisaadavust:

Sellised muudatused hõlmavad:

• väljade eemaldamist
• väljade tüübi muutmist
• static või transient modifikaatorite muutmist väljadele
• klasside hierarhia muutmist (lisamine või eemaldamine superklassidest)
• standardsete serialiseerimismeetodite (readObject, writeObject, readResolve, writeReplace) muutmist või eemaldamist

serialVersionUID muutmine näitab selgelt JVM-ile, et laaditavad serialiseeritud andmed kuuluvad vana klassi versioonile ja ei ole ühilduvad praegusega, vältides InvalidClassException. Kui serialVersionUID ei muutu, arvab JVM klassi versioonid ühilduvaks, mis võib põhjustada deserialiseerimisel vale käitumise või vigu struktuuride mittevastavuse tõttu:

Mõned muudatused ei nõua tavaliselt serialVersionUID muutmist (kui need ei mõjuta standardseid serialiseerimismeetodeid):

• uute väljade lisamine (kui need ei ole märgitud final)
• meetodite lisamine või eemaldamine
• juurdepääsmodifikaatorite muutmine väljadele (välja arvatud static ja transient)

Soovitatav on selgelt määrata serialVersionUID serialiseeritavates klassides. See võimaldab kontrollida versioonide ühilduvust. Kui see väli puudub, genereerib JVM selle klassi omaduste põhjal, mis võib põhjustada ühilduvuse probleeme väikeste muudatuste korral, mis siiski muudavad ID genereerimise algoritmi:

Näide:

public class MySerializableClass implements java.io.Serializable {
    private static final long serialVersionUID = 1L; // algväärtus
    private String someField;

    // ... teised väljad ja meetodid
}

Kui klassi muudatused on mitteühilduvad, tuleks serialVersionUID väärtus muuta, näiteks kasutades serialver tööriista genereeritud väärtust või suurendades (2L).