serialVersionUID的作用

Java类中的serialVersionUID

原文 https://www.cnblogs.com/duanxz/p/3511695.html

以下为转载的部分内容，有删改

serialVersionUID的作用

serialVersionUID适用于Java的序列化机制。简单来说，Java的序列化机制是通过判断类的serialVersionUID来验证版本一致性的。在进行反序列化时，JVM会把传来的字节流中的serialVersionUID与本地相应实体类的serialVersionUID进行比较，如果相同就认为是一致的，可以进行反序列化，否则就会出现序列化版本不一致的异常，即InvalidCastException。

序列化过程

序列化操作的时候系统会把当前类的serialVersionUID写入到序列化文件中，当反序列化时系统会去检测文件中的serialVersionUID，判断它是否与当前类的serialVersionUID一致，如果一致就说明序列化类的版本与当前类版本是一样的，可以反序列化成功，否则失败。

serialVersionUID显式的生成方式

• 默认的1L，如：

  private static final long serialVersionUID = 1L;
  

• 根据类名、接口名、成员方法及属性等来生成一个64位的哈希字段，比如：

  private static final long serialVersionUID = xxxxL;
  

当实现java.io.Serializable接口的类没有显式地定义一个serialVersionUID变量时候，Java序列化机制会根据编译的Class自动生成一个serialVersionUID作序列化版本比较用，这种情况下，如果Class文件(类名，方法明等)没有发生变化(增加空格，换行，增加注释等等)，就算再编译多次，serialVersionUID也不会变化的。

如果我们不希望通过编译来强制划分软件版本，即实现序列化接口的实体能够兼容先前版本，就需要显式地定义一个名为serialVersionUID，类型为long的变量，不修改这个变量值的序列化实体都可以相互进行串行化和反串行化。

序列化的几种常见情况

1. 序列化实体类

package Serialization;

import java.io.Serializable;

public class Person implements Serializable {
    private static final long serialVersionUID = 1L;
    private int id;
    private String name;

    public Person(int id, String name){
        this.id = id;
        this.name = name;
    }

    @Override
    public String toString() {
        return "Person: " + id + " " + name;
    }
}

序列化

package Serialization;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;

public class SerialTest {
    public static void main(String[] args) throws IOException {
        Person person = new Person(6, "abc");
        System.out.println("Person Serial " + person);

        FileOutputStream fos;
        ObjectOutputStream oos = null;
        try {
            fos = new FileOutputStream("./src/Serialization/person.txt");
            oos = new ObjectOutputStream(fos);
            oos.writeObject(person);
            oos.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (oos != null) oos.close();
        }
    }
}

反序列

package Serialization;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.ObjectInputStream;

public class DeserialTest {
    public static void main(String[] args) throws IOException {
        FileInputStream fis;
        ObjectInputStream ois = null;
        try {
            fis = new FileInputStream("./src/Serialization/person.txt");
            ois = new ObjectInputStream(fis);
            Person person = (Person) ois.readObject();
            System.out.println("Person Deserial " + person);
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        } finally {
            if (ois != null) ois.close();
        }
    }
}

1.1 情况一

假设Person类序列化之后，从A端传输到B端，然后在B端进行反序列化。在序列化Person和反序列化Person的时候，A端和B端都需要存在一个相同的类。如果两处的serialVersionUID不一致，会产生什么错误呢?

利用上面的代码做个试验来验证，先执行测试类SerialTest，生成序列化文件，代表A端序列化后的文件，然后修改serialVersion值，再执行测试类DeserialTest，代表B端使用不同serialVersion的类去反序列化，结果报错：

java.io.InvalidClassException: Serialization.Person; local class incompatible: stream classdesc serialVersionUID = 1, local class serialVersionUID = 2
	at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:699)
	at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1885)
	at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1751)
	at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:2042)
	at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1573)
	at java.io.ObjectInputStream.readObject(ObjectInputStream.java:431)
	at Serialization.DeserialTest.main(DeserialTest.java:19)

1.2 情况二

假设两处serialVersionUID一致，如果A端增加一个字段，然后序列化，而B端不变，然后反序列化，会是什么情况呢?

新增age属性，执行SerialTest，生成序列化文件，代表A端。删除age，反序列化，代表B端，最后的结果为：执行序列化，反序列化正常，但是A端增加的字段丢失(被B端忽略)。

package Serialization;

import java.io.Serializable;

public class Person implements Serializable {
    private static final long serialVersionUID = 1L;
    private int id;
    private String name;
    private int age;

    public Person(int id, String name, int age){
        this.id = id;
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person: " + id + " " + name + " " + age;
    }
}

package Serialization;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;

public class SerialTest {
    public static void main(String[] args) throws IOException {
        Person person = new Person(6, "abc", 12);
        System.out.println("Person Serial " + person);

        FileOutputStream fos;
        ObjectOutputStream oos = null;
        try {
            fos = new FileOutputStream("./src/Serialization/person.txt");
            oos = new ObjectOutputStream(fos);
            oos.writeObject(person);
            oos.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (oos != null) oos.close();
        }
    }
}

1.3 情况三

假设两处serialVersionUID一致，如果B端减少一个字段，A端不变，会是什么情况呢?

序列化，反序列化正常，B端字段少于A端，A端多的字段值丢失(被B端忽略)。

package Serialization;

import java.io.Serializable;

public class Person implements Serializable {
    private static final long serialVersionUID = 1L;
    private int id;

    public Person(int id){
        this.id = id;
    }

    @Override
    public String toString() {
        return "Person: " + id;
    }
}

1.4 情况四

假设两处serialVersionUID一致，如果B端增加一个字段，A端不变，会是什么情况呢？
验证过程如下，先执行SerialTest，然后在实体类Person增加一个字段age，如下所示，再执行测试类DeserialTest，结果是序列化，反序列化正常，B端新增加的int类型字段被赋予了默认值0。。

package Serialization;

import java.io.Serializable;

public class Person implements Serializable {
    private static final long serialVersionUID = 1L;
    private int id;
    private String name;
    private int age;

    public Person(int id, String name, int age){
        this.id = id;
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person: " + id + " " + name + " " + age;
    }
}

1.5 总结

2. 静态变量序列化

package Serialization;

import java.io.*;

public class StaticVarSerialTest implements Serializable {
    private static final long serialVersionUID = 1L;
    public static int count = 5;

    public static void main(String[] args) throws IOException {
        ObjectOutputStream oos = null;
        ObjectInputStream ois = null;
        try {
            //初始时count为5
            oos = new ObjectOutputStream(
                new FileOutputStream("./src/Serialization/result.obj"));
            oos.writeObject(new StaticVarSerialTest());

            //序列化后修改为10
            StaticVarSerialTest.count = 10;

            ois = new ObjectInputStream(
                new FileInputStream("./src/Serialization/result.obj"));
            StaticVarSerialTest var = (StaticVarSerialTest) ois.readObject();

            System.out.println(var.count);
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        } finally {
            if (oos != null) oos.close();
            if (ois != null) ois.close();
        }
    }
}

上面代码的main方法，将对象序列化后，修改静态变量的数值，再将序列化对象读取出来，然后通过读取出来的对象获得静态变量的数值并打印出来，这个System.out.println(variable.count)语句输出的是 10 还是 5 呢？

最后的输出是 10，之所以打印 10 的原因在于序列化时，并不保存静态变量，这其实比较容易理解，序列化保存的是对象的状态，静态变量属于类的状态，因此 序列化并不保存静态变量。

3. 父类的序列化

情境：一个子类实现了 Serializable 接口，它的父类都没有实现 Serializable 接口，序列化该子类对象，然后反序列化后输出父类定义的某变量的数值，该变量数值与序列化时的数值不同。

解决：要想将父类对象也序列化，就需要让父类也实现Serializable 接口。

如果父类不实现的话的，就需要提供默认的无参的构造函数。在父类没有实现 Serializable 接口时，虚拟机是不会序列化父对象的，而一个 Java 对象的构造必须先有父对象，才有子对象，反序列化也不例外。所以反序列化时，为了构造父对象，只能调用父类的无参构造函数作为默认的父对象。因此当我们取父对象的变量值时，它的值是调用父类无参构造函数后的值。

如果你考虑到这种序列化的情况，在父类无参构造函数中对变量进行初始化，否则的话，父类变量值都是默认声明的值，如 int 型的默认是 0，string 型的默认是null。

4. transient关键字

transient 关键字的作用是控制变量的序列化，在变量声明前加上该关键字，可以阻止该变量被序列化到文件中，在被反序列化后，transient 变量的值被设为初始值，如 int 型的是 0，对象型的是 null。

References

https://www.cnblogs.com/duanxz/p/3511695.html