JDK 序列化， 碰到serialVersionUID 不一致问题，怎么处理？

JDK 序列化， 碰到serialVersionUID 不一致问题，怎么处理？

空无 小哈学Java 文章源自JAVA秀-https://www.javaxiu.com/31528.html

点击上方蓝色“小哈学Java”，选择“设为星标”回复“资源”获取独家整理的学习资料！

公司有个子服务较多，交互频繁的系统，有一些需要共享传输的对象，它们通过 JDK 序列化（Java Object Serialization）后进行交互；但是由于一些不可描述的历史原因，这些对象存在多个版本，每个版本中的属性不一致，且未设置 serialVersionUID。文章源自JAVA秀-https://www.javaxiu.com/31528.html

这阵子在做梳理/统一代码的工作，打算统一这些对象的版本和固定 serialVersionUID，但是由于服务较多，上线发版时会有一段新老版本共存的时期，所以得考虑这些对象序列化的兼容问题，新的对象反序列化一定得兼容老的对象文章源自JAVA秀-https://www.javaxiu.com/31528.html

Java Object Serialization

Java对象序列化（Serialization）是指将Java中的对象转为字节流，从而可以方便的存储或在网络中传输，反序列化（Deserialization）是指将字节流转位Java对象文章源自JAVA秀-https://www.javaxiu.com/31528.html

一般情况下，Java Object Serialization指的是利用JDK自带的功能对对象进行序列化/反序列化，而不是使用其他的序列化库进行（反）序列化文章源自JAVA秀-https://www.javaxiu.com/31528.html

JDK 序列化中，要求对象必须实现java.io.Serializable接口，基本使用方式如下：文章源自JAVA秀-https://www.javaxiu.com/31528.html

Serialization

// Serialize today's date to a file.FileOutputStream f = new FileOutputStream("tmp");ObjectOutput s = new ObjectOutputStream(f);s.writeObject("Today");s.writeObject(new Date());s.flush();

Deserialization

// Deserialize a string and date from a file.FileInputStream in = new FileInputStream("tmp");ObjectInputStream s = new ObjectInputStream(in);String today = (String)s.readObject();Date date = (Date)s.readObject();

serialVersionUID

private static final long serialVersionUID = 1L;

Java Object Serialization 会使用对象中的 serialVersionUID 常量属性作为该对象的版本号，进行反序列化时会校验该版本号是否一致，如果不一致会导致序列化失败，抛出InvalidClassException异常文章源自JAVA秀-https://www.javaxiu.com/31528.html

默认情况下，JVM 为每一个实现了 Serializable 的接口的类生成一个 serialVersionUID（long），这个 ID 的计算规则是通过当前类信息（类名、属性等）去生成的，所以当属性有变更时这个serialVersionUID 也一定会发生变更文章源自JAVA秀-https://www.javaxiu.com/31528.html

这个 serialVersionUID 的生成，和所使用的JDK有关，不同的JDK可能会生成不一样的版本号，所以最好是手动生成一个，大多数 JAVA IDE 都会提供这个生成的功能文章源自JAVA秀-https://www.javaxiu.com/31528.html

而且考虑到实际业务场景，变更属性是常有的事，如果使用自动生成的版本号很容易造成 serialVersionUID 不一致的问题，导致反序列化失败文章源自JAVA秀-https://www.javaxiu.com/31528.html

serialVersionUID 不一致时的兼容处理

处理这个不一致也很简单，既然反序列化时使用 ObjectInputStream 来实现，那么这里自定义一个 CompatibleInputStream 继承 ObjectInputStream，然后重写 readClassDescriptor 方法即可文章源自JAVA秀-https://www.javaxiu.com/31528.html

当遇到目标数据 Class 版本号和本地 Class 版本号不一致时，默认使用本地版本的 Class文章源自JAVA秀-https://www.javaxiu.com/31528.html

public class CompatibleInputStream extends ObjectInputStream {    private static Logger logger = LoggerFactory.getLogger(CompatibleInputStream.class);    public CompatibleInputStream(InputStream in) throws IOException {        super(in);    }    @Override    protected ObjectStreamClass readClassDescriptor() throws IOException, ClassNotFoundException {        ObjectStreamClass resultClassDescriptor = super.readClassDescriptor(); // initially streams descriptor        Class localClass; // the class in the local JVM that this descriptor represents.        try {            localClass = Class.forName(resultClassDescriptor.getName());         } catch (ClassNotFoundException e) {            logger.error("No local class for " + resultClassDescriptor.getName(), e);            return resultClassDescriptor;        }        ObjectStreamClass localClassDescriptor = ObjectStreamClass.lookup(localClass);        if (localClassDescriptor != null) { // only if class implements serializable            final long localSUID = localClassDescriptor.getSerialVersionUID();            final long streamSUID = resultClassDescriptor.getSerialVersionUID();            if (streamSUID != localSUID) { // check for serialVersionUID mismatch.                final StringBuffer s = new StringBuffer("Overriding serialized class version mismatch: ");                s.append("local serialVersionUID = ").append(localSUID);                s.append(" stream serialVersionUID = ").append(streamSUID);                Exception e = new InvalidClassException(s.toString());                logger.error("Potentially Fatal Deserialization Operation.", e);                resultClassDescriptor = localClassDescriptor; // Use local class descriptor for deserialization            }        }        return resultClassDescriptor;    }}

以上关键代码摘自文章源自JAVA秀-https://www.javaxiu.com/31528.html

https://stackoverflow.com/a/1816711/6507948文章源自JAVA秀-https://www.javaxiu.com/31528.html

使用方式：文章源自JAVA秀-https://www.javaxiu.com/31528.html

// Deserialize a string and date from a file.FileInputStream in = new FileInputStream("tmp");//反序列化时使用上面的CompatibleInputStream即可ObjectInputStream s = new CompatibleInputStream(in);String today = (String)s.readObject();Date date = (Date)s.readObject();

来源 | https://juejin.cn/post/6961229793056686117文章源自JAVA秀-https://www.javaxiu.com/31528.html

1. 号称下一代监控系统，来看看它有多强！2. 漫画 | 如果面试时大家都说真话…3. 求求你们了，别再写满屏的 try catch 了！！4. 用 Dubbo 传输文件？被老板一顿揍最近面试BAT，整理一份面试资料《Java面试BATJ通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。获取方式：点“在看”，关注公众号并回复 Java 领取，更多内容陆续奉上。

文章有帮助的话，在看，转发吧。文章源自JAVA秀-https://www.javaxiu.com/31528.html

谢谢支持哟 (*^__^*)文章源自JAVA秀-https://www.javaxiu.com/31528.html