深入学习 Java 序列化

1、序列化是干什么的？

Java序列化是指把Java对象保存为二进制字节码的过程，Java反序列化是指把二进制码重新转换成Java对象的过程。

2、什么情况下需要序列化？

第一种情况是：一般情况下Java对象的声明周期都比Java虚拟机的要短，实际应用中我们希望在JVM停止运行之后能够持久化指定的对象，比如内存中的对象状态保存到一个文件中或者数据库中时候，这时候就需要把对象进行序列化之后保存。

第二种情况是：需要把Java对象通过网络进行传输的时候。因为数据只能够以二进制的形式在网络中进行传输，因此当把对象通过网络发送出去之前需要先序列化成二进制数据，在接收端读到二进制数据之后反序列化成Java对象。

3.系列化示例

对象序列化包括如下步骤：
　　1）创建一个对象输出流，它可以包装一个其他类型的目标输出流，如文件输出流；
　　2）通过对象输出流的writeObject()方法写对象。

　　对象反序列化的步骤如下：
　　1）创建一个对象输入流，它可以包装一个其他类型的源输入流，如文件输入流；
　　2）通过对象输入流的readObject()方法读取对象。

Person类，实现了Serializable接口，它包含三个字段：name，String类型；age，Integer类型；gender，Gender类型。另外，还重写该类的toString()方法，以方便打印Person实例中的内容。

public class Person implements Serializable {

    private String name = null;

    private Integer age = null;

    private Gender gender = null;

    public Person() {
        System.out.println("none-arg constructor");
    }

    public Person(String name, Integer age, Gender gender) {
        System.out.println("arg constructor");
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Gender getGender() {
        return gender;
    }

    public void setGender(Gender gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "[" + name + ", " + age + ", " + gender + "]";
    }
}

SimpleSerial，是一个简单的序列化程序，它先将一个Person对象保存到文件person.out中，然后再从该文件中读出被存储的Person对象，并打印该对象。

public class SimpleSerial {

    public static void main(String[] args) throws Exception {
        File file = new File("person.out");

        ObjectOutputStream oout = new ObjectOutputStream(new FileOutputStream(file));
        Person person = new Person("John", 101, Gender.MALE);
        oout.writeObject(person);
        oout.close();

        ObjectInputStream oin = new ObjectInputStream(new FileInputStream(file));
        Object newPerson = oin.readObject(); // 没有强制转换到Person类型
        oin.close();
        System.out.println(newPerson);
    }
}

上述程序的输出的结果为：

arg constructor
[John, 31, MALE]

此时必须注意的是，当重新读取被保存的Person对象时，并没有调用Person的任何构造器，看起来就像是直接使用字节将Person对象还原出来的。
当Person对象被保存到person.out文件中之后，我们可以在其它地方去读取该文件以还原对象，但必须确保该读取程序的CLASSPATH中包含有Person.class(哪怕在读取Person对象时并没有显示地使用Person类，如上例所示)，否则会抛出ClassNotFoundException。

4.Serializable的作用

为什么一个类实现了Serializable接口，它就可以被序列化呢？在上节的示例中，使用ObjectOutputStream来持久化对象，在该类中有如下代码：

private void writeObject0(Object obj, boolean unshared) throws IOException {

    if (obj instanceof String) {
        writeString((String) obj, unshared);
    } else if (cl.isArray()) {
        writeArray(obj, desc, unshared);
    } else if (obj instanceof Enum) {
        writeEnum((Enum) obj, desc, unshared);
    } else if (obj instanceof Serializable) {
        writeOrdinaryObject(obj, desc, unshared);
    } else {
        if (extendedDebugInfo) {
            throw new NotSerializableException(cl.getName() + "\n"
                    + debugInfoStack.toString());
        } else {
            throw new NotSerializableException(cl.getName());
        }
    }

}

从上述代码可知，如果被写对象的类型是String，或数组，或Enum，或Serializable，那么就可以对该对象进行序列化，否则将抛出NotSerializableException。

5. 默认序列化机制
如果仅仅只是让某个类实现Serializable接口，而没有其它任何处理的话，则就是使用默认序列化机制。使用默认机制，在序列化对象时，不仅会序列化当前对象本身，还会对该对象引用的其它对象也进行序列化，同样地，这些其它对象引用的另外对象也将被序列化，以此类推。所以，如果一个对象包含的成员变量是容器类对象，而这些容器所含有的元素也是容器类对象，那么这个序列化的过程就会较复杂，开销也较大。

5. 影响序列化
在现实应用中，有些时候不能使用默认序列化机制。比如，希望在序列化过程中忽略掉敏感数据，或者简化序列化过程。下面将介绍若干影响序列化的方法。

5.1 transient关键字
当某个字段被声明为transient后，默认序列化机制就会忽略该字段。此处将Person类中的age字段声明为transient，如下所示，

public class Person implements Serializable {

transient private Integer age = null;

}

再执行SimpleSerial应用程序，会有如下输出：

arg constructor
[John, null, MALE]

可见，age字段未被序列化。

5.2 writeObject()方法与readObject()方法
对于上述已被声明为transitive的字段age，除了将transitive关键字去掉之外，是否还有其它方法能使它再次可被序列化？方法之一就是在Person类中添加两个方法：writeObject()与readObject()，如下所示：

public class Person implements Serializable {

transient private Integer age = null;

    private void writeObject(ObjectOutputStream out) throws IOException {
        out.defaultWriteObject();
        out.writeInt(age);
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        age = in.readInt();
    }
}

在writeObject()方法中会先调用ObjectOutputStream中的defaultWriteObject()方法，该方法会执行默认的序列化机制，如5.1节所述，此时会忽略掉age字段。然后再调用writeInt()方法显示地将age字段写入到ObjectOutputStream中。readObject()的作用则是针对对象的读取，其原理与writeObject()方法相同。
再次执行SimpleSerial应用程序，则又会有如下输出：

arg constructor
[John, 31, MALE]

必须注意地是，writeObject()与readObject()都是private方法，那么它们是如何被调用的呢？毫无疑问，是使用反射。详情可见ObjectOutputStream中的writeSerialData方法，以及ObjectInputStream中的readSerialData方法。

5.3 Externalizable接口
无论是使用transient关键字，还是使用writeObject()和readObject()方法，其实都是基于Serializable接口的序列化。JDK中提供了另一个序列化接口--Externalizable，使用该接口之后，之前基于Serializable接口的序列化机制就将失效。此时将Person类修改成如下，

public class Person implements Externalizable {

    private String name = null;

    transient private Integer age = null;

    private Gender gender = null;

    public Person() {
        System.out.println("none-arg constructor");
    }

    public Person(String name, Integer age, Gender gender) {
        System.out.println("arg constructor");
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    private void writeObject(ObjectOutputStream out) throws IOException {
        out.defaultWriteObject();
        out.writeInt(age);
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        age = in.readInt();
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException {

    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {

    }

}

此时再执行SimpleSerial程序之后会得到如下结果：

arg constructor
none-arg constructor
[null, null, null]

从该结果，一方面可以看出Person对象中任何一个字段都没有被序列化。另一方面，如果细心的话，还可以发现这此次序列化过程调用了Person类的无参构造器。
    Externalizable继承于Serializable，当使用该接口时，序列化的细节需要由程序员去完成。如上所示的代码，由于writeExternal()与readExternal()方法未作任何处理，那么该序列化行为将不会保存/读取任何一个字段。这也就是为什么输出结果中所有字段的值均为空。
    另外，若使用Externalizable进行序列化，当读取对象时，会调用被序列化类的无参构造器去创建一个新的对象，然后再将被保存对象的字段的值分别填充到新对象中。这就是为什么在此次序列化过程中Person类的无参构造器会被调用。由于这个原因，实现Externalizable接口的类必须要提供一个无参的构造器，且它的访问权限为public。
    对上述Person类作进一步的修改，使其能够对name与age字段进行序列化，但要忽略掉gender字段，如下代码所示：

public class Person implements Externalizable {

    private String name = null;

    transient private Integer age = null;

    private Gender gender = null;

    public Person() {
        System.out.println("none-arg constructor");
    }

    public Person(String name, Integer age, Gender gender) {
        System.out.println("arg constructor");
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    private void writeObject(ObjectOutputStream out) throws IOException {
        out.defaultWriteObject();
        out.writeInt(age);
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        age = in.readInt();
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException {
        out.writeObject(name);
        out.writeInt(age);
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
        name = (String) in.readObject();
        age = in.readInt();
    }

}

执行SimpleSerial之后会有如下结果：

arg constructor
none-arg constructor
[John, 31, null]

5.4 readResolve()方法
当我们使用Singleton模式时，应该是期望某个类的实例应该是唯一的，但如果该类是可序列化的，那么情况可能会略有不同。此时对第2节使用的Person类进行修改，使其实现Singleton模式，如下所示：

public class Person implements Serializable {

    private static class InstanceHolder {
        private static final Person instatnce = new Person("John", 31, Gender.MALE);
    }

    public static Person getInstance() {
        return InstanceHolder.instatnce;
    }

    private String name = null;

    private Integer age = null;

    private Gender gender = null;

    private Person() {
        System.out.println("none-arg constructor");
    }

    private Person(String name, Integer age, Gender gender) {
        System.out.println("arg constructor");
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

}

同时要修改SimpleSerial应用，使得能够保存/获取上述单例对象，并进行对象相等性比较，如下代码所示：

public class SimpleSerial {

    public static void main(String[] args) throws Exception {
        File file = new File("person.out");
        ObjectOutputStream oout = new ObjectOutputStream(new FileOutputStream(file));
        oout.writeObject(Person.getInstance()); // 保存单例对象
        oout.close();

        ObjectInputStream oin = new ObjectInputStream(new FileInputStream(file));
        Object newPerson = oin.readObject();
        oin.close();
        System.out.println(newPerson);

        System.out.println(Person.getInstance() == newPerson); // 将获取的对象与Person类中的单例对象进行相等性比较
    }
}

执行上述应用程序后会得到如下结果：

arg constructor
[John, 31, MALE]
false

值得注意的是，从文件person.out中获取的Person对象与Person类中的单例对象并不相等。为了能在序列化过程仍能保持单例的特性，可以在Person类中添加一个readResolve()方法，在该方法中直接返回Person的单例对象，如下所示：

}

再次执行本节的SimpleSerial应用后将有如下输出：

arg constructor
[John, 31, MALE]
true

无论是实现Serializable接口，或是Externalizable接口，当从I/O流中读取对象时，readResolve()方法都会被调用到。实际上就是用readResolve()中返回的对象直接替换在反序列化过程中创建的对象，而被创建的对象则会被垃圾回收掉。

6.序列化版本号的作用

serialVersionUID: 字面意思上是序列化的版本号，凡是实现Serializable接口的类都有一个表示序列化版本标识符的静态变量

1 private static final long serialVersionUID

　　实现Serializable接口的类如果类中没有添加serialVersionUID，那么就会出现如下的警告提示

　　用鼠标点击就会弹出生成serialVersionUID的对话框，如下图所示：

　　serialVersionUID有两种生成方式：

　　采用这种方式生成的serialVersionUID是1L，例如：

1 private static final long serialVersionUID = 1L;

　　采用这种方式生成的serialVersionUID是根据类名，接口名，方法和属性等来生成的，例如：

1 private static final long serialVersionUID = 4603642343377807741L;

　　添加了之后就不会出现那个警告提示了，如下所示：

　　扯了那么多，那么serialVersionUID(序列化版本号)到底有什么用呢，我们用如下的例子来说明一下serialVersionUID的作用，看下面的代码：

 1 import java.io.File;
 2 import java.io.FileInputStream;
 3 import java.io.FileNotFoundException;
 4 import java.io.FileOutputStream;
 5 import java.io.IOException;
 6 import java.io.ObjectInputStream;
 7 import java.io.ObjectOutputStream;
 8 import java.io.Serializable;
 9 
10 public class TestSerialversionUID {
11 
12     public static void main(String[] args) throws Exception {
13         SerializeCustomer();// 序列化Customer对象
14         Customer customer = DeserializeCustomer();// 反序列Customer对象
15         System.out.println(customer);
16     }
17 
18     /**
19      * MethodName: SerializeCustomer 
20      * Description: 序列化Customer对象
21      * @author xudp
22      * @throws FileNotFoundException
23      * @throws IOException
24      */
25     private static void SerializeCustomer() throws FileNotFoundException,
26             IOException {
27         Customer customer = new Customer("gacl",25);
28         // ObjectOutputStream 对象输出流
29         ObjectOutputStream oo = new ObjectOutputStream(new FileOutputStream(
30                 new File("E:/Customer.txt")));
31         oo.writeObject(customer);
32         System.out.println("Customer对象序列化成功！");
33         oo.close();
34     }
35 
36     /**
37      * MethodName: DeserializeCustomer 
38      * Description: 反序列Customer对象
39      * @author xudp
40      * @return
41      * @throws Exception
42      * @throws IOException
43      */
44     private static Customer DeserializeCustomer() throws Exception, IOException {
45         ObjectInputStream ois = new ObjectInputStream(new FileInputStream(
46                 new File("E:/Customer.txt")));
47         Customer customer = (Customer) ois.readObject();
48         System.out.println("Customer对象反序列化成功！");
49         return customer;
50     }
51 }
52 
53 /**
54  * <p>ClassName: Customer<p>
55  * <p>Description: Customer实现了Serializable接口，可以被序列化<p>
56  * @author xudp
57  * @version 1.0 V
58  * @createTime 2014-6-9 下午04:20:17
59  */
60 class Customer implements Serializable {
61     //Customer类中没有定义serialVersionUID
62     private String name;
63     private int age;
64 
65     public Customer(String name, int age) {
66         this.name = name;
67         this.age = age;
68     }
69 
70     /*
71      * @MethodName toString
72      * @Description 重写Object类的toString()方法
73      * @author xudp
74      * @return string
75      * @see java.lang.Object#toString()
76      */
77     @Override
78     public String toString() {
79         return "name=" + name + ", age=" + age;
80     }
81 }

运行结果：

序列化和反序列化都成功了。

下面我们修改一下Customer类，添加多一个sex属性，如下：

 1 class Customer implements Serializable {
 2     //Customer类中没有定义serialVersionUID
 3     private String name;
 4     private int age;
 5 
 6     //新添加的sex属性
 7     private String sex;
 8     
 9     public Customer(String name, int age) {
10         this.name = name;
11         this.age = age;
12     }
13     
14     public Customer(String name, int age,String sex) {
15         this.name = name;
16         this.age = age;
17         this.sex = sex;
18     }
19 
20     /*
21      * @MethodName toString
22      * @Description 重写Object类的toString()方法
23      * @author xudp
24      * @return string
25      * @see java.lang.Object#toString()
26      */
27     @Override
28     public String toString() {
29         return "name=" + name + ", age=" + age;
30     }
31 }

　　然后执行反序列操作，此时就会抛出如下的异常信息：

1 Exception in thread "main" java.io.InvalidClassException: Customer; 
2 local class incompatible: 
3 stream classdesc serialVersionUID = -88175599799432325, 
4 local class serialVersionUID = -5182532647273106745

　　意思就是说，文件流中的class和classpath中的class，也就是修改过后的class，不兼容了，处于安全机制考虑，程序抛出了错误，并且拒绝载入。那么如果我们真的有需求要在序列化后添加一个字段或者方法呢？应该怎么办？那就是自己去指定serialVersionUID。在TestSerialversionUID例子中，没有指定Customer类的serialVersionUID的，那么java编译器会自动给这个class进行一个摘要算法，类似于指纹算法，只要这个文件多一个空格，得到的UID就会截然不同的，可以保证在这么多类中，这个编号是唯一的。所以，添加了一个字段后，由于没有显指定 serialVersionUID，编译器又为我们生成了一个UID，当然和前面保存在文件中的那个不会一样了，于是就出现了2个序列化版本号不一致的错误。因此，只要我们自己指定了serialVersionUID，就可以在序列化后，去添加一个字段，或者方法，而不会影响到后期的还原，还原后的对象照样可以使用，而且还多了方法或者属性可以用。

　　下面继续修改Customer类，给Customer指定一个serialVersionUID，修改后的代码如下：

 1 class Customer implements Serializable {
 2     /**
 3      * Customer类中定义的serialVersionUID(序列化版本号)
 4      */
 5     private static final long serialVersionUID = -5182532647273106745L;
 6     private String name;
 7     private int age;
 8 
 9     //新添加的sex属性
10     //private String sex;
11     
12     public Customer(String name, int age) {
13         this.name = name;
14         this.age = age;
15     }
16     
17     /*public Customer(String name, int age,String sex) {
18         this.name = name;
19         this.age = age;
20         this.sex = sex;
21     }*/
22 
23     /*
24      * @MethodName toString
25      * @Description 重写Object类的toString()方法
26      * @author xudp
27      * @return string
28      * @see java.lang.Object#toString()
29      */
30     @Override
31     public String toString() {
32         return "name=" + name + ", age=" + age;
33     }
34 }

　　重新执行序列化操作，将Customer对象序列化到本地硬盘的Customer.txt文件存储，然后修改Customer类，添加sex属性，修改后的Customer类代码如下：

 1 class Customer implements Serializable {
 2     /**
 3      * Customer类中定义的serialVersionUID(序列化版本号)
 4      */
 5     private static final long serialVersionUID = -5182532647273106745L;
 6     private String name;
 7     private int age;
 8 
 9     //新添加的sex属性
10     private String sex;
11     
12     public Customer(String name, int age) {
13         this.name = name;
14         this.age = age;
15     }
16     
17     public Customer(String name, int age,String sex) {
18         this.name = name;
19         this.age = age;
20         this.sex = sex;
21     }
22 
23     /*
24      * @MethodName toString
25      * @Description 重写Object类的toString()方法
26      * @author xudp
27      * @return string
28      * @see java.lang.Object#toString()
29      */
30     @Override
31     public String toString() {
32         return "name=" + name + ", age=" + age;
33     }
34 }

执行反序列操作，这次就可以反序列成功了，如下所示：

四、serialVersionUID的取值

　　serialVersionUID的取值是Java运行时环境根据类的内部细节自动生成的。如果对类的源代码作了修改，再重新编译，新生成的类文件的serialVersionUID的取值有可能也会发生变化。
　　类的serialVersionUID的默认值完全依赖于Java编译器的实现，对于同一个类，用不同的Java编译器编译，有可能会导致不同的 serialVersionUID，也有可能相同。为了提高serialVersionUID的独立性和确定性，强烈建议在一个可序列化类中显示的定义serialVersionUID，为它赋予明确的值。

　　显式地定义serialVersionUID有两种用途：
　　　　1、在某些场合，希望类的不同版本对序列化兼容，因此需要确保类的不同版本具有相同的serialVersionUID；
　　　　2、在某些场合，不希望类的不同版本对序列化兼容，因此需要确保类的不同版本具有不同的serialVersionUID。

posted @ 2018-07-27 10:36 小小蔡芽阅读(241) 评论(0) 编辑收藏举报

刷新页面返回顶部

小小蔡芽

深入学习 Java 序列化

四、serialVersionUID的取值

公告