Serializable 之 SerialVersionUID
本文不讲基本概念问题,如有需要 请另行查阅其他资料
最近在开发过程中遇到了InvalidClassException,也是基础不牢的缘故,导致不能快速的发现本质问题,进行有效的处理。于是侥幸的处理完这个问题之后,就想着好好的深入研究一下(也不算很深入,只是阅读了一下源码)。
正文
在Java中,存在Serializable接口,对它的实现 无需override什么方法,JVM会在底层帮你实现(其实也不是很低层,也在Java中,但是不在本文讨论范围内),不过需要关注的是一个属性 – serialVersionUID(简称SUID),本文将对这个属性进行简单的讲解。
场景
- 定义:class Something implement Serializable – 未定义serialVersionUID
- 操作:
- output: 实例化Something对象,并持久化至文件中 – ObjectOutputStream.writeObject(Something)
- input: 从文件中读取Something对象 – ObjectInputStream.readObject(byte[])
- 异常:
- 如果在output操作进行之后,对Something进行了部分的修改,然后再进行Input操作,将会抛出一个异常:InvalidClassException(“local class incompatible: stream classdesc serialVersionUID = $suid, local class serialVersionUID = ${osc.getSerialVersionUID()}”);
相关知识介绍
ObjectStreamClass
Serialization’s descriptor for classes. It contains the name and serialVersionUID of the class. The ObjectStreamClass for a specific class loaded in this Java VM can be found/created using the lookup method.
原文中可以理解成:每个Class(对象)在序列化时,都会伴随着这样一个关联的ObjectStreamClass对象,该对象中记录了Class的名字和serialVersionUID。
问题及源码
所有源码都进行了裁剪,如愿查看全部,请自行查阅
由于serialVersionUID属性 是Optional,那ObjectStreamClass是如何获取到Class的serialVersionUID?
/**
* Returns explicit serial version UID value declared by given class, or
* null if none.
*/
private static Long getDeclaredSUID(Class<?> cl) {
try {
// 反射,获取SUID属性,并严格检查static final
Field f = cl.getDeclaredField("serialVersionUID");
int mask = Modifier.STATIC | Modifier.FINAL;
// 这块的逻辑不是很清楚,但是debug的结果发现,一般是mask = 26,f.getModifiers() = 24
if ((f.getModifiers() & mask) == mask) {
f.setAccessible(true