认识Java序列化

我的个人博客，认识Java序列化

引言

将 Java 对象序列化为二进制文件的 Java 序列化技术是 Java 系列技术中一个较为重要的技术点，在大部分情况下，开发人员只需要了解被序列化的类需要实现 Serializable 接口，使用 ObjectInputStream 和 ObjectOutputStream 进行对象的读写。然而在有些情况下，光知道这些还远远不够，文章列举了笔者遇到的一些真实情境，它们与 Java 序列化相关，通过分析情境出现的原因，使读者轻松牢记 Java 序列化中的一些高级认识。

文章结构

本文将逐一的介绍几个情境，顺序如下面的列表。

• 序列化 ID 的问题
• 静态变量序列化
• 父类的序列化与 Transient 关键字
• 序列化存储规则
• 序列化实现深克隆

序列化工具类

public class JdkSerializationUtil {

    private static final int DEFAULT_BUFFER_SIZE = 2048;

    private static final byte[] DEFAULT_VALUE = new byte[0];

    public static byte[] serialize(Object data) {
        if (Objects.isNull(data)) {
            return DEFAULT_VALUE;
        }
        if (!(data instanceof Serializable)) {
            throw new IllegalArgumentException(data.getClass().getSimpleName() + " requires implements Serializable");
        }
        // 这个括号在JDK1.7之前是没有的，是1.7的新特性。
        // 括号里的内容支持包括流以及任何可关闭的资源，数据流会在 try 执行完毕后自动被关闭，而不用我们手动关闭了
        try (
                ByteArrayOutputStream bos = new ByteArrayOutputStream(DEFAULT_BUFFER_SIZE);
                ObjectOutputStream oos = new ObjectOutputStream(bos)) {

            oos.writeObject(data);
            oos.flush();

            return bos.toByteArray();
        } catch (IOException e) {
            throw new RuntimeException("Failed to serialize Object[" + data.getClass().getSimpleName() + "]", e);
        }
    }

    public static <T> T deserialize(byte[] data, Class<T> clazz) {
        if (data == null && data.length == 0) {
            return null;
        }
        try (
                ByteArrayInputStream bis = new ByteArrayInputStream(data);
                ObjectInputStream ois = new ObjectInputStream(bis);) {
            return (T) ois.readObject();
        } catch (Exception e) {
            throw new RuntimeException("Failed to deserialize the byte array for " + clazz.getSimpleName(), e);
        }
    }
}

序列化 ID 问题

情境：两个客户端 A 和 B 试图通过网络传递对象数据，A 端将对象 C 序列化为二进制数据再传给 B，B 反序列化得到 C。

问题：C 对象的全类路径假设为 com.inout.Test，在 A 和 B 端都有这么一个类文件，功能代码完全一致。也都实现了 Serializable 接口，但是反序列化时总是提示不成功。

解决：虚拟机是否允许反序列化，不仅取决于类路径和功能代码是否一致，一个非常重要的一点是两个类的序列化 ID 是否一致（就是 private static final long serialVersionUID = 1L）。

序列化 ID 在 Eclipse 下提供了两种生成策略，一个是固定的 1L，一个是随机生成一个不重复的 long 类型数据（实际上是使用 JDK 工具生成），在这里有一个建议，如果没有特殊需求，就是用默认的 1L 就可以，这样可以确保代码一致时反序列化成功。那么随机生成的序列化 ID 有什么作用呢，有些时候，通过改变序列化 ID 可以用来限制某些用户的使用。

静态变量序列化

静态变量序列化问题代码：

public class StaticVariableTest implements Serializable {

    private static final long serialVersionUID = 1L;

    public static int staticVar = 5;

    private int age;

    public static void main( String[] args ) {

        StaticVariableTest test = new StaticVariableTest();
        test.age = 20;

        byte[] data = JdkSerializationUtil.serialize(test);

        // 序列化后修改为10
        StaticVariableTest.staticVar = 10;

        StaticVariableTest test2 = JdkSerializationUtil.deserialize(data, StaticVariableTest.class);
        System.out.println(test2.staticVar);
    }
}

这个 System.out.println(test2.staticVar) 语句输出的是 10 还是 5 呢？

最后的输出是 10，对于无法理解的读者认为，打印的 staticVar 是从读取的对象里获得的，应该是保存时的状态才对。之所以打印 10 的原因在于序列化时，并不保存静态变量，这其实比较容易理解，序列化保存的是对象的状态，静态变量属于类的状态，因此 序列化并不保存静态变量。

父类的序列化与 Transient 关键字

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

解决：要想将父类对象也序列化，就需要让父类也实现Serializable 接口。如果父类不实现的话的，就 需要有默认的无参的构造函数。在父类无参构造函数中对变量进行初始化，否则的话，父类变量值都是默认声明的值，如 int 型的默认是 0，string 型的默认是 null。

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

代码如下：

public class SuperUser {

    private static final long serialVersionUID = 1L;

    private int age;

    public int getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "SuperUser{" +
                "age=" + age +
                '}';
    }

}

public class User extends SuperUser implements Serializable {

    private static final long serialVersionUID = 1L;

    private String name;

    private transient String sex;

    public String getName() {
        return name;
    }

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

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", sex='" + sex + '\'' +
                "} " + super.toString();
    }
}

public class SuperTest {

    public static void main(String[] args) throws Exception {

        User user = new User();
        user.setName("lisi");
        user.setAge(30);
        user.setSex("男");

        User user2 = JdkSerializationUtil.deserialize(JdkSerializationUtil.serialize(user), User.class);
        System.out.println(user2);
    }
}

输出的结果为：

User{name='lisi', sex='null'} SuperUser{age=0}

序列化存储规则

存储规则问题代码如下：

public class SaveRuleTest implements Serializable {

    private static final long serialVersionUID = 1L;

    private int i;

    public static void main(String[] args) throws Exception {
        mutiSave();
        System.out.println("=========");
        mutiSave2();
    }

    public static void mutiSave() throws Exception {
        ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("result"));

        SaveRuleTest test = new SaveRuleTest();
        // 试图将对象两次写入文件
        oos.writeObject(test);
        oos.flush();
        System.out.println(new File("result").length());

        oos.writeObject(test);
        oos.close();

        System.out.println(new File("result").length());


        ObjectInputStream ois = new ObjectInputStream(new FileInputStream(
                "result"));
        // 从文件依次读出两个文件
        SaveRuleTest t1 = (SaveRuleTest) ois.readObject();
        SaveRuleTest t2 = (SaveRuleTest) ois.readObject();
        ois.close();

        // 判断两个引用是否指向同一个对象
        System.out.println(t1 == t2);
    }

    public static void mutiSave2() throws Exception {
        ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("result1"));

        SaveRuleTest test = new SaveRuleTest();
        test.i = 1;
        // 试图将对象两次写入文件
        oos.writeObject(test);
        oos.flush();
        System.out.println(new File("result1").length());

        test.i = 2;
        oos.writeObject(test);
        oos.close();

        System.out.println(new File("result1").length());

        ObjectInputStream ois = new ObjectInputStream(new FileInputStream(
                "result1"));
        // 从文件依次读出两个文件
        SaveRuleTest t1 = (SaveRuleTest) ois.readObject();
        SaveRuleTest t2 = (SaveRuleTest) ois.readObject();
        ois.close();

        // 判断两个引用是否指向同一个对象
        System.out.println(t1 == t2);
        System.out.println(t1.i);
        System.out.println(t2.i);
    }
}

程序运行结果为：

62
67
true
=========
62
67
true
1
1

mutiSave()方法执行结果，我们看到，第二次写入对象时文件只增加了 5 字节，并且两个对象是相等的，这是为什么呢？

解答：Java 序列化机制为了节省磁盘空间，具有特定的存储规则，当写入文件的为同一对象时，并不会再将对象的内容进行存储，而只是再次存储一份引用，上面增加的 5 字节的存储空间就是新增引用和一些控制信息的空间。反序列化时，恢复引用关系，使得 t1 和 t2 指向唯一的对象，二者相等，输出 true。该存储规则极大的节省了存储空间。

mutiSave2()的目的是希望将 test 对象两次保存到 result.obj 文件中，写入一次以后修改对象属性值再次保存第二次，然后从 result.obj 中再依次读出两个对象，输出这两个对象的 i 属性值。案例代码的目的原本是希望一次性传输对象修改前后的状态。

结果两个输出的都是 1， 原因就是第一次写入对象以后，第二次再试图写的时候，虚拟机根据引用关系知道已经有一个相同对象已经写入文件，因此只保存第二次写的引用，所以读取时，都是第一次保存的对象。读者在使用一个文件多次 writeObject 需要特别注意这个问题。

序列化实现深拷贝

public class Teacher implements Serializable {

    private static final long serialVersionUID = -6635991328204468281L;

    private String name;

    public String getName() {
        return name;
    }

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

    @Override
    public String toString() {
        return "Teacher{" +
                "name='" + name + '\'' +
                '}';
    }
}

public class Student implements Serializable, Cloneable {

    private static final long serialVersionUID = 1L;

    private String name;

    private int age;

    private Teacher teacher;

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

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

    public Teacher getTeacher() {
        return teacher;
    }

    public void setTeacher(Teacher teacher) {
        this.teacher = teacher;
    }

    @Override
    protected Object clone() throws CloneNotSupportedException {
        return super.clone();
    }

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", teacher=" + teacher +
                '}';
    }
}

public class CloneTest {

    public static void main(String[] args) throws Exception {

        Teacher teacher = new Teacher();
        teacher.setName("tom");

        Student student = new Student();
        student.setName("zhangsan");
        student.setAge(20);
        student.setTeacher(teacher);

        System.out.println("student:" + student);

        // 浅拷贝
        Student student1 = (Student) student.clone();
        student1.getTeacher().setName("nick");
        System.out.println("student:" + student);
        System.out.println("student1:" + student1);

        // 深拷贝
        Student student2 = JdkSerializationUtil.deserialize(JdkSerializationUtil.serialize(student), Student.class);
        student2.getTeacher().setName("james");

        System.out.println("student:" + student);
        System.out.println("student2:" + student2);
    }
}

输出结果为：

student:Student{name='zhangsan', age=20, teacher=Teacher{name='tom'}}
student:Student{name='zhangsan', age=20, teacher=Teacher{name='nick'}}
student1:Student{name='zhangsan', age=20, teacher=Teacher{name='nick'}}
student:Student{name='zhangsan', age=20, teacher=Teacher{name='nick'}}
student2:Student{name='zhangsan', age=20, teacher=Teacher{name='james'}}

从上面的执行结果我们可以总结出：

浅拷贝（浅复制、浅克隆）：
被复制对象的所有变量都含有与原来的对象相同的值，而所有的对其他对象的引用仍然指向原来的对象。
换言之，浅拷贝仅仅复制所拷贝的对象，而不复制它所引用的对象。

深拷贝（深复制、深克隆）：
被复制对象的所有变量都含有与原来的对象相同的值，除去那些引用其他对象的变量。
那些引用其他对象的变量将指向被复制过的新对象，而不再是原有的那些被引用的对象。
换言之，深拷贝把要复制的对象所引用的对象都复制了一遍