迹忆客 专注技术分享

本文介绍如何在 Java 中使用 SerialVersionUID。

Java 中的 SerialVersionUID

SerialVersionUID 用于序列化。 序列化是将对象转换为字节流以存储数据并将其发送到某个地方的过程，反序列化是相反的过程。

在序列化过程中，Java运行时会给每个Serialized类关联一个版本号； 该数字称为 SerialVersionUID。

SerialVersionUID 用于验证序列化数据的发送者和接收者是否已加载该数据的类并且在序列化方面兼容。

例如，如果接收方为对象加载了一个类，其 SerialVersionUID 与相应发送方的类不同，它将抛出 InvalidClassException。

我们可以为 Serialized 类声明我们自己的 SerialVersionUID。 SerialVersionUID 将被声明为 Static Final 和 Long 类型。

查看语法：

private static final long serialVersionUID = 10L;

让我们尝试一个使用 SerialVersionUID 实现序列化和反序列化的示例。 参见示例：

package jiyik;

import java.io.*;
import java.util.logging.Logger;

public class Example implements java.io.Serializable {

    //The Default serial version uid
    private static final long serialVersionUID = 4L;
    //random name
    private static final String File_Name = "ExampleClassBytes.ser";
    private static final Logger logger_File = Logger.getLogger("");
    //Few data fields Which will be able to serialize
    private static String Static_Variable;
    private int Integer_Variable;

    //Few data fields Which will not be able to serialize
    transient private String Transient_Variable = "this is a transient instance field";
    private Thread Thread_Class;

    private static Object readIn() throws IOException, ClassNotFoundException {
        ObjectInputStream Object_Input_Stream = new ObjectInputStream(new FileInputStream(new File(File_Name)));
        return Object_Input_Stream.readObject();
    }

    private static void writeOut(java.io.Serializable object) throws IOException {
        ObjectOutputStream Object_Output_Stream = new ObjectOutputStream(new FileOutputStream(new File(File_Name)));
        Object_Output_Stream.writeObject(object);
        Object_Output_Stream.close();
    }

    @Override public String toString() {
        return "Example Class:- final static fileName is: " + File_Name + ", final static logger is: " + logger_File
              + ", the non-final static staticVariable is: " + Static_Variable + ", the instance intVariable is: " + Integer_Variable
              + ", the transient instance Variable is: " + Transient_Variable + ", the non-serializable instance field threadClass is : " + Thread_Class;
    }

    public static void main(String[] args) throws IOException, ClassNotFoundException {
        //Serialization

        Example Demo = new Example();
        Demo.Integer_Variable = 1;
        Static_Variable = "this is the static variable";
        writeOut(Demo);
        System.out.println("Example Class to be saved: " + Demo);

        //De-serialization

        System.out.println("Example Class deserialized: " + readIn());
    }
}

如果 Serialized 类未显式声明 SerialVersionUID，则运行时将根据方面计算该类的默认 SerialVersionUID。 现在让我们看看上面代码的输出。

Example Class to be saved: Example Class:- final static fileName is: ExampleClassBytes.ser, final static logger is: java.util.logging.LogManager$RootLogger@27973e9b, the non-final static staticVariable is: this is the static variable, the instance intVariable is: 1, the transient instance Variable is: this is a transient instance field, the non-serializable instance field threadClass is : null
Example Class deserialized: Example Class:- final static fileName is: ExampleClassBytes.ser, final static logger is: java.util.logging.LogManager$RootLogger@27973e9b, the non-final static staticVariable is: this is the static variable, the instance intVariable is: 1, the transient instance Variable is: null, the non-serializable instance field threadClass is : null

基于上述场景，关于 SerialVersionUID 的一些要点：

1. 序列化期间静态和瞬态字段会被忽略，反序列化后瞬态和非静态最终字段将变为空。
2. 对于序列化，我们需要处理 IOException，对于反序列化，我们需要处理 IOException 和 ClassNotFoundException。 这意味着反序列化的类类型应该位于类路径中。
3. 方法 ObjectInputStream.readObject() 和 ObjectOutputStream.writeObject(object) 用于序列化和反序列化操作。
4. 序列化和反序列化可用于克隆和复制对象，这比常规克隆操作相对慢。
5. 未初始化、不可序列化和非瞬态实例是可以容忍的。
6. 在修改实现java.io.Serialized的类时，我们必须小心，因为如果一个类不包含SerialVersionUID，那么编译器将生成SerialVersionUID。
7. 计算 SerialVersionUID 不仅基于字段，还基于其他方面，如构造函数、实现子句等。这意味着我们应该显式声明 SerialVersionUID，这也将保持向后兼容性。