serialVersionUID的作用

来源：互联网发布：阿里云数据库种类编辑：程序博客网时间：2024/06/05 14:09

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

serialVersionUID有两种显示的生成方式：
一是默认的1L，比如：private static final long serialVersionUID = 1L;
二是根据类名，接口名，成员方法及属性等来生成一个64位的哈希字段，比如：
private static final long serialVersionUID = xxxxL;

当一个类实现了Serializable接口，如果没有显示的定义serialVersionUID，Eclipse会提供相应的提醒面对这种情况，我们只需要在Eclipse中点击类中警告图标一下，Eclipse就会自动给定两种生成的方式。如果不想定义，在Eclipse的设置中也可以把它关掉的，设置如下：
Window ==>首选项==> Java ==>编译器==>错误/警告==>潜在的编程问题
将Serializable类没有serialVersionUID的警告改成忽略即可。

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

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

下面用代码说明一下的serialVersionUID在应用中常见的几种情况。

（1）序列化实体类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
importjava.io.Serializable;
publicclassPersonimplementsSerializable
{
    privatestaticfinallongserialVersionUID=1234567890L;
    publicintid;
    publicStringname;
 
    publicPerson(intid,Stringname)
    {
        this.id=id;
        this.name=name;
    }
 
    publicStringtoString()
    {
        return"Person: "+id+" "+name;
    }
}

（2）序列化功能：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
importjava.io.FileOutputStream;
importjava.io.IOException;
importjava.io.ObjectOutputStream;
 
publicclassSerialTest
{
 
    publicstaticvoidmain(String[]args)throwsIOException
    {
        Personperson=newPerson(1234,"wang");
        System.out.println("Person Serial"+person);
        FileOutputStreamfos=newFileOutputStream("Person.txt");
        ObjectOutputStreamoos=newObjectOutputStream(fos);
        oos.writeObject(person);
        oos.flush();
        oos.close();
    }
}

（3）反序列化功能：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
importjava.io.FileInputStream;
importjava.io.IOException;
importjava.io.ObjectInputStream;
publicclassDeserialTest
{
    publicstaticvoidmain(String[]args)throwsIOException,ClassNotFoundException
    {
        Personperson;
 
        FileInputStreamfis=newFileInputStream("Person.txt");
        ObjectInputStreamois=newObjectInputStream(fis);
        person=(Person)ois.readObject();
        ois.close();
        System.out.println("Person Deserial"+person);
    }
 
}

情况一：假设人类序列化之后，从甲端传输到乙端，然后在乙端进行反序列化在序列化人和反序列化人的时候，A端和乙端都需要存在一个相同的类。如果两处的serialVersionUID的不一致，会产生什么错误呢？
【答案】可以利用上面的代码做个试验来验证：
先执行测试类SerialTest，生成序列化文件，代表甲端序列化后的文件，然后修改serialVersion值，再执行测试类DeserialTest，代表乙端使用不同serialVersion的类去反序列化，结果报错：
线程中的异常“main”java.io.InvalidClassException：test.Person; 本地类不兼容：stream classdesc serialVersionUID = 1234567890，本地类serialVersionUID = 123456789
   在java.io.ObjectStreamClass.initNonProxy（ObjectStreamClass.java:560）
   java.io.ObjectInputStream.readNonProxyDesc（ObjectInputStream.java:1580）
   在java.io. ObjectInputStream.readClassDesc（ObjectInputStream.java:1493）
   在java.io.ObjectInputStream.readOrdinaryObject（ObjectInputStream.java：
   1729） java.io.ObjectInputStream.readObject0（ObjectInputStream.java:1326）
   在java.io.ObjectInputStream.readObject（ObjectInputStream.java:348）
   at test.DeserialTest.main（DeserialTest.java:15）

情况二：假设两处的serialVersionUID一致，如果阿端增加一个字段，然后序列化，而乙端不变，然后反序列化，会是什么情况呢？
【答案】新增公共年龄; 执行SerialTest，生成序列化文件，代表A端。删除public int age，反序列化，代表B端，最后的结果为：执行序列化，反序列化正常，但是A端增加的字段丢失（被B端忽略）。

情况三：假设两处的serialVersionUID一致，如果乙端减少一个字段，A端不变，会是什么情况呢？
【答案】序列化，反序列化正常，B端字段少于甲端，A端多的字段值丢失（被乙端忽略）。

情况四：假设两处的serialVersionUID一致，如果乙端增加一个字段，A端不变，会是什么情况呢？
验证过程如下：
先执行SerialTest，然后在实体类人增加一个字段年龄，如下所示，再执行测试类DeserialTest。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
importjava.io.Serializable;
publicclassPersonimplementsSerializable
{
    privatestaticfinallongserialVersionUID=123456789L;
    publicintid;
    publicStringname;
    publicintage;
 
    publicPerson(intid,Stringname)
    {
        this.id=id;
        this.name=name;
    }
 
    publicStringtoString()
    {
        return"Person: "+id+" "+name;
    }
}

相应的修改测试类DeserialTest，打印出年龄的值。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
importjava.io.FileOutputStream;
importjava.io.IOException;
importjava.io.ObjectOutputStream;
 
publicclassSerialTest
{
 
    publicstaticvoidmain(String[]args)throwsIOException
    {
        Personperson=newPerson(1234,"wang");
        System.out.println("Person Serial"+person+" age:"+person.age);
        FileOutputStreamfos=newFileOutputStream("Person.txt");
        ObjectOutputStreamoos=newObjectOutputStream(fos);
        oos.writeObject(person);
        oos.flush();
        oos.close();
    }
}

结果为：
Person Deserial Person：1234 wang age：0
说明序列化，反序列化正常，B端新增加的int字段被赋予了默认值0.
最后通过下面的图片，总结一下上面的几种情况。

声明：本文由金丝燕网原创编译，转载请保留链接：serialVersionUID作用，更多交流请加群：278721352

0 0