养成良好习惯,显式声明UID

简介:

我们编写一个实现了Serializable接口(序列化标志接口)的类, Eclipse马上就会给一个黄色警告:需要增加一个Serial Version ID。为什么要增加?它是怎么计算出来的?有什么用?本章就来解释该问题。

类实现Serializable接口的目的是为了可持久化,比如网络传输或本地存储,为系统的分布和异构部署提供先决支持条件。若没有序列化,现在我们熟悉的远程调用、对象数据库都不可能存在,我们来看一个简单的序列化类:

复制代码
 1 public class Person implements Serializable{      
 2     private String name;
 3 
 4     public String getName() {
 5         return name;
 6     }
 7 
 8     public void setName(String name) {
 9         this.name = name;
10     }  
11     
12 } 
复制代码

这是一个简单JavaBean,实现了Serializable接口,可以在网络上传输,也可以本地存储然后读取。这里我们以Java消息服务(Java Message Service)方式传递该对象(即通过网络传递一个对象),定义在消息队列中的数据类型为ObjectMessage,首先定义一个消息的生产者(Producer),代码如下:

复制代码
1 public class Producer {  
2     public static void main(String[] args) throws Exception {  
3           Person person = new Person();  
4           person.setName("混世魔王");6           //序列化,保存到磁盘上  
7           SerializationUtils.writeObject(person);  
8     }  
9 } 
复制代码

这里引入了一个工具类SerializationUtils,其作用是对一个类进行序列化和反序列化,并存储到硬盘上(模拟网络传输),其代码如下:

复制代码
 1 import java.io.FileInputStream;
 2 import java.io.FileOutputStream;
 3 import java.io.ObjectInput;
 4 import java.io.ObjectInputStream;
 5 import java.io.ObjectOutputStream;
 6 import java.io.Serializable;
 7 
 8 public class SerializationUtils {  
 9     private static String FILE_NAME = "c:/obj.bin";  
10     // 序列化  
11     public static void writeObject(Serializable s) {  
12        try {  
13            ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream(FILE_NAME));  
14            oos.writeObject(s);  
15            oos.close();  
16        } catch (Exception e) {  
17            e.printStackTrace();  
18        }  
19    }  
20      
21    public static Object readObject(){  
22        Object obj=null;  
23        // 反序列化  
24        try {  
25            ObjectInput input = new ObjectInputStream(new FileInputStream(FILE_NAME));  
26            obj = input.readObject();  
27            input.close();  
28        } catch (Exception e) {  
29            e.printStackTrace();  
30        }  
31        return obj;  
32    }  
33 } 
复制代码

通过对象序列化过程,把一个对象从内存块转化为可传输的数据流,然后通过网络发送到消息消费者(Consumer)那里,并进行反序列化,生成实例对象,代码如下:.

复制代码
1 public class Consumer {  
2     public static void main(String[] args) throws Exception {  
3           // 反序列化  
4           Person p = (Person) SerializationUtils.readObject();  
5           System.out.println("name="+p.getName());
6     }  
7 } 
复制代码

这是一个反序列化过程,也就是对象数据流转换为一个实例对象的过程,其运行后的输出结果为:混世魔王。这太easy了,是的,这就是序列化和反序列化典型的demo。但此处隐藏着一个问题:如果消息的生产者和消息的消费者所参考的类(Person类)有差异,会出现何种神奇事件?比如:消息生产者中的Person类增加了一个年龄属性,而消费者没有增加该属性。为啥没有增加?!因为这是个分布式部署的应用,你甚至都不知道这个应用部署在何处,特别是通过广播(broadcast)方式发送消息的情况,漏掉一两个订阅者也是很正常的。

这个时候给Person.java类增加一个age属性.

复制代码
 1 import java.io.Serializable;
 2 
 3 public class Person implements Serializable{      
 4     private String name;
 5     private int age;
 6     
 7     public int getAge() {
 8         return age;
 9     }
10 
11     public void setAge(int age) {
12         this.age = age;
13     }
14 
15     public String getName() {
16         return name;
17     }
18 
19     public void setName(String name) {
20         this.name = name;
21     }  
22 } 
复制代码

直接运行Consumer.java 会抛出 java.io.InvalidClassException异常

复制代码
 1 java.io.InvalidClassException: com.summerchill.staticproxy.Person; local class incompatible: stream classdesc serialVersionUID = 7107224374967840269, local class serialVersionUID = -6034120172421752969
 2     at java.io.ObjectStreamClass.initNonProxy(Unknown Source)
 3     at java.io.ObjectInputStream.readNonProxyDesc(Unknown Source)
 4     at java.io.ObjectInputStream.readClassDesc(Unknown Source)
 5     at java.io.ObjectInputStream.readOrdinaryObject(Unknown Source)
 6     at java.io.ObjectInputStream.readObject0(Unknown Source)
 7     at java.io.ObjectInputStream.readObject(Unknown Source)
 8     at com.summerchill.staticproxy.SerializationUtils.readObject(SerializationUtils.java:28)
 9     at com.summerchill.staticproxy.Consumer.main(Consumer.java:6)
10 Exception in thread "main" java.lang.NullPointerException
11     at com.summerchill.staticproxy.Consumer.main(Consumer.java:7)
复制代码

在这种序列化和反序列化的类不一致的情形下,反序列化时会报一个InvalidClassException异常,原因是序列化和反序列化所对应的类版本发生了变化,JVM不能把数据流转换为实例对象。接着刨根问底:JVM是根据什么来判断一个类版本的呢?

好问题,通过SerialVersionUID,也叫做流标识符(Stream Unique Identifier),即类的版本定义的,它可以显式声明也可以隐式声明。显式声明格式如下:

1 private static final long serialVersionUID = XXXXXL; 

而隐式声明则是我不声明,你编译器在编译的时候帮我生成。生成的依据是通过包名、类名、继承关系、非私有的方法和属性,以及参数、返回值等诸多因子计算得出的,极度复杂,基本上计算出来的这个值是唯一的。

serialVersionUID如何生成已经说明了,我们再来看看serialVersionUID的作用。JVM在反序列化时,会比较数据流中的serialVersionUID与类的serialVersionUID是否相同,如果相同,则认为类没有发生改变,可以把数据流load为实例对象;如果不相同,对不起,我JVM不干了,抛个异常InvalidClassException给你瞧瞧。这是一个非常好的校验机制,可以保证一个对象即使在网络或磁盘中“滚过”一次,仍能做到“出淤泥而不染”,完美地实现类的一致性。

但是,有时候我们需要一点特例场景,例如:我的类改变不大,JVM是否可以把我以前的对象反序列化过来?就是依靠显式声明serialVersionUID,向JVM撒谎说“我的类版本没有变更”,如此,我们编写的类就实现了向上兼容。我们修改一下上面的Person类,代码如下:

复制代码
 1 public class Person implements Serializable{      
 2     private static final long serialVersionUID = -6034120172421752969L;
 3     private String name;
 4 
 5     public String getName() {
 6         return name;
 7     }
 8 
 9     public void setName(String name) {
10         this.name = name;
11     }  
12 } 
复制代码

Person.java类上加上了serialVersionUID之后再进行序列化的Producer.java和反序列化的Consumer.java之后

是不会抛出InvalidClassException异常的.

刚开始生产者和消费者持有的Person类版本一致,都是V1.0,某天生产者的Person类版本变更了,增加了一个“年龄”属性,升级为V2.0,而由于种种原因(比如程序员疏忽、升级时间窗口不同等)消费端的Person还保持为V1.0版本,代码如下:

复制代码
 1 public class Person implements Serializable{      
 2     private static final long serialVersionUID = -6034120172421752969L;
 3     private String name;
 4     private int age;
 5     public int getAge() {
 6         return age;
 7     }
 8 
 9     public void setAge(int age) {
10         this.age = age;
11     }
12 
13     public String getName() {
14         return name;
15     }
16 
17     public void setName(String name) {
18         this.name = name;
19     }  
20 } 
复制代码

此时虽然生产者和消费者对应的类版本不同,但是显式声明的serialVersionUID相同,反序列化也是可以运行的,所带来的业务问题就是消费端不能读取到新增的业务属性(age属性)而已。

通过此例,我们的反序列化实现了版本向上兼容的功能,使用V1.0版本的应用访问了一个V2.0版本的对象,这无疑提高了代码的健壮性。我们在编写序列化类代码时,随手加上serialVersionUID字段,也不会给我们带来太多的工作量,但它却可以在关键时候发挥异乎寻常的作用。

注意 显式声明serialVersionUID可以避免对象不一致,但尽量不要以这种方式向JVM“撒谎”。

 


本文转自SummerChill博客园博客,原文链接:http://www.cnblogs.com/DreamDrive/p/5412931.html,如需转载请自行联系原作者

相关文章
|
1月前
|
存储 安全 编译器
【C++入门(下篇)】C++引用,内联函数,auto关键字的学习
【C++入门(下篇)】C++引用,内联函数,auto关键字的学习
【C++入门(下篇)】C++引用,内联函数,auto关键字的学习
|
3月前
|
C语言 C++ 开发者
C/C++陷阱——变量名和函数名的冲突问题
C/C++陷阱——变量名和函数名的冲突问题
|
9月前
|
编译器 C语言 C++
【C++学习】C++入门 | 引用 | 引用的底层原理 | auto关键字 | 范围for(语法糖)
【C++学习】C++入门 | 引用 | 引用的底层原理 | auto关键字 | 范围for(语法糖)
96 0
|
6月前
|
Go
Go语言type关键字终于被玩明白了 类型别名的秘密都在这里
Go语言type关键字终于被玩明白了 类型别名的秘密都在这里
43 0
|
10月前
|
JavaScript 前端开发 Java
程序员如何给变量起名字
程序员如何给变量起名字
|
存储 安全 编译器
【C++入门必备知识:|引用| +|auto关键字| + |范围for|】
引用不是新定义一个变量,而是给已经存在的变量取别名,编译器不会为引用变量开辟内存空间,它和它引用的变量共用同一块内存区间。
93 0
函数的“定义”和‘声明’并不是同一回事
函数的“定义”和‘声明’并不是同一回事
52 0
常量对象可以更改
常量对象可以更改
64 0
编码基本功:类成员要加前缀,这样可以避免同名变量
编码基本功:类成员要加前缀,这样可以避免同名变量
33 0
补充上一篇,严格模式下不同场景下函数参数名的区别
补充上一篇,严格模式下不同场景下函数参数名的区别
50 0