Java 序列化和反序列化（一）Serializable 使用场景

Java 序列化和反序列化（一）Serializable 使用场景

以下为 Java 序列化系列文章：

1. Java 序列化和反序列化（一）Serializable 使用场景

 2. Java 序列化和反序列化（二）Serializable 源码分析 - 1

3. Java 序列化和反序列化（三）Serializable 源码分析 - 2

将 Java 对象序列化为二进制文件的 Java 序列化技术是 Java 系列技术中一个较为重要的技术点，在大部分情况下，开发人员只需要了解被序列化的类需要实现 Serializable 接口，使用 ObjectInputStream 和 ObjectOutputStream 进行对象的读写。

众所周知，Java 原生的序列化方法可以分为两种，下面介绍一下这两个接口的用法：

实现 Serializable 接口：可以自定义 writeObject、readObject、writeReplace、readResolve 方法，会通过反射调用。
实现 Externalizable 接口：需要实现 writeExternal 和 readExternal 方法。

1. 最简单的使用：Serializable 接口

情境： Java 的序列化使用起来很简单，实现 Serializable 接口即可，实际由 ObjectOutputStream、ObjectInputStream 完成对这个标记接口的处理。

Code-1. Java 序列化 Serializable 接口

@Test

public void testSerializable() throws IOException, ClassNotFoundException {

    ByteArrayOutputStream baos = new ByteArrayOutputStream();

    ObjectOutputStream oos = new ObjectOutputStream(baos);

    User user1 = new User();

    user1.setName("binarylei");

    oos.writeObject(user1);

    byte[] bytes = baos.toByteArray();

    System.out.println(bytes.length);               // length=89

    ByteArrayInputStream bais = new ByteArrayInputStream(bytes);

    ObjectInputStream ois = new ObjectInputStream(bais);

    User user2 = (User) ois.readObject();

    Assert.assertEquals(user1.getName(), user2.getName());  // 反序列化后保存了 User.name 信息

    Assert.assertNotEquals(user1, user2);                   // 反序列化后不是同一个对象

    oos.close();

    ois.close();

}

class User implements Serializable {

    private String name;

    // getter setter

}

总结： 如果不实现 Serializable 接口会发生什么事情呢？如果 User 不实现 Serializable 接口而直接序列化会抛出 NotSerializableException 异常。

java.io.NotSerializableException: com.github.binarylei.io.User

  at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1184)

  at java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:348)

2. 序列化 ID 的问题

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

问题： 在 A 和 B 端都有这么一个类文件，功能代码完全一致。也都实现了 Serializable 接口，但是反序列化时总是提示不成功。

解决： 虚拟机是否允许反序列化，不仅取决于类路径和功能代码是否一致，一个非常重要的一点是两个类的序列化 ID 是否一致（就是 private static final long serialVersionUID = 1L）。Code-2 中，虽然两个类的功能代码完全一致，但是序列化 ID 不同，他们无法相互序列化和反序列化。

Code-2. 相同功能代码不同序列化 ID 的类对比

public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    private String name;

} 

public class User implements Serializable {

    private static final long serialVersionUID = 2L;

    private String name;

}

3. 静态字段不会序列化

序列化时不保存静态变量，这是因为序列化保存的是对象的状态，静态变量属于类的状态，因此序列化并不保存静态变量。

Code-3. 静态字段不会序列化

class User implements Serializable {

    public static String staticVar;  // 不会序列化

    private String name;

}

4. 屏蔽字段：transient

transient 关键字有两个特性：

如果你不想让对象中的某个成员被序列化可以在定义它的时候加上 transient 关键字进行修饰，这样，在对象被序列化时其就不会被序列化。
transient 修饰过的成员反序列化后将赋予默认值，即 0 或 null。下面的 User 在反序列化后 password=null。

Code-4. transient 修辞的字段不会序列化

class User implements Serializable {

    public static String staticVar;   // 不会序列化

    public String name;

    public transient String password; // 不会序列化

}

5. 父类的序列化

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

解决： 要想将父类对象也序列化，就需要让父类也实现 Serializable 接口。如果父类不实现的话的，就需要有默认的无参的构造函数。在父类没有实现 Serializable 接口时，虚拟机是不会序列化父对象的，而一个 Java 对象的构造必须先有父对象，才有子对象，反序列化也不例外。所以反序列化时，为了构造父对象，只能调用父类的无参构造函数作为默认的父对象。因此当我们取父对象的变量值时，它的值是调用父类无参构造函数后的值。如果你考虑到这种序列化的情况，在父类无参构造函数中对变量进行初始化，否则的话，父类变量值都是默认声明的值，如 int 型的默认是 0，string 型的默认是 null。

6. 自定义序列化：readObject 和 writeObject

情境： 服务器端给客户端发送序列化对象数据，对象中有一些数据是敏感的，比如密码字符串等，希望对该密码字段在序列化时，进行加密，而客户端如果拥有解密的密钥，只有在客户端进行反序列化时，才可以对密码进行读取，这样可以一定程度保证序列化对象的数据安全。

解决：在序列化过程中，虚拟机会试图调用对象类里的 writeObject 和 readObject 方法，进行用户自定义的序列化和反序列化，如果没有这样的方法，则默认调用是 ObjectOutputStream 的 defaultWriteObject 方法以及 ObjectInputStream 的 defaultReadObject 方法。用户自定义的 writeObject 和 readObject 方法可以允许用户控制序列化的过程，比如可以在序列化的过程中动态改变序列化的数值。基于这个原理，可以在实际应用中得到使用，用于敏感字段的加密工作，Code-6 展示了这个过程。

Code-6. 使用 writeObject 和 readObject 对敏感字段加密代码

@Test

public void testEncryptionPassword() throws Exception {

    ObjectOutputStream out = new ObjectOutputStream(

            new FileOutputStream("result.obj"));

    out.writeObject(new User("binarylei", "password"));

    out.close();

    ObjectInputStream oin = new ObjectInputStream(

            new FileInputStream("result.obj"));

    User t = (User) oin.readObject();

    Assert.assertEquals("password", t.getPassword());

    oin.close();

}

class User implements Serializable {

    private String name;

    private String password;

    private void writeObject(ObjectOutputStream out) throws Exception {

        ObjectOutputStream.PutField putFields = out.putFields();

        putFields.put("password", password + "-1");

        out.writeFields();

    }

    private void readObject(ObjectInputStream in) throws Exception {

        ObjectInputStream.GetField readFields = in.readFields();

        String encryptionPassword = (String) readFields.get("password", "");

        // 模拟解密

        password = encryptionPassword.substring(0, encryptionPassword.indexOf('-'));

    }

}

在 Code-6 的 writeObject 方法中，对密码进行了加密，在 readObject 中则对 password 进行解密，只有拥有密钥的客户端，才可以正确的解析出密码，确保了数据的安全。

7. 写入时替换对象：writeReplace

Serializable 还有两个标记接口方法可以实现序列化对象的替换，即 writeReplace 和 readResolve；

writeObject 序列化时会调用 writeReplace 方法将当前对象替换成另一个对象并将其写入流中，此时如果有自定义的 writeObject 也不会生效了；
反序列化时不是用 readResolve 恢复，readResolve 并不是用来恢复 writeReplace 的。

Code-7. 使用 writeReplace 替换对象

@Test

public void testWriteReplace() throws Exception {

    ObjectOutputStream out = new ObjectOutputStream(

            new FileOutputStream("result.obj"));

    User user = new User("binarylei", "password");

    out.writeObject(user);  // 序列化时直接调用 writeReplace，此时如果有自定义的 writeObject 也无效

    out.close();

    ObjectInputStream oin = new ObjectInputStream(

            new FileInputStream("result.obj"));

    List t = (List) oin.readObject();     // 反序列化的对象为 List

    Assert.assertEquals(user.getName(), t.get(0));

    Assert.assertEquals(user.getPassword(), t.get(1));

    oin.close();

}

private static class User implements Serializable {

    private String name;

    private String password;

    private Object writeReplace() throws ObjectStreamException {

        List<Object> list = new ArrayList<>();

        list.add(name);

        list.add(password);

        return list;

    }

}

8. 保护性恢复对象：readResolve

readResolve 会在 readObject 调用之后自动调用，它最主要的目的就是对反序列化的对象进行修改后返回。

Code-8. 使用 readResolve 实现单例

@Test

public void testWriteReplace() throws Exception {

    ObjectOutputStream out = new ObjectOutputStream(

            new FileOutputStream("result.obj"));

    out.writeObject(Brand.NIKE);

    out.close();

    ObjectInputStream oin = new ObjectInputStream(

            new FileInputStream("result.obj"));

    Assert.assertEquals(Brand.NIKE, oin.readObject());

    oin.close();

}

private static class Brand implements Serializable {

    private int val;

    // 两个枚举值

    public static final Brand NIKE = new Brand(0);

    public static final Brand ADDIDAS = new Brand(1);

    private Object readResolve() throws ObjectStreamException {

        return val == 0 ? NIKE : ADDIDAS;

    }

}

9. 自定义序列化接口：Externalizable

不像 Serializable 接口只是一个标记接口，里面的接口方法都是可选的（可实现可不实现，如果不实现则启用其自动序列化功能），而 Externalizable 接口不是一个标记接口，它强制你自己动手实现串行化和反串行化算法。

public interface Externalizable extends java.io.Serializable {

    void writeExternal(ObjectOutput out) throws IOException; // 串行化

    void readExternal(ObjectInput in) throws IOException, ClassNotFoundException; // 反串行化

}

10. 序列化存储规则

情境： 问题代码如 Code-10 所示。

Code-10. 存储规则问题代码

@Test

public void test() throws Exception {

    ByteArrayOutputStream baos = new ByteArrayOutputStream();

    ObjectOutputStream oos = new ObjectOutputStream(baos);

    User user1 = new User();

    user1.setName("binarylei");

    oos.writeObject(user1);

    int length1 = baos.toByteArray().length;

    oos.writeObject(user1);

    int length2 = baos.toByteArray().length;

    Assert.assertEquals(5, length2 - length1);  // 同一个对象写两次，长度只增加了 5

    oos.close();

    ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());

    ObjectInputStream ois = new ObjectInputStream(bais);

    User user2 = (User) ois.readObject();

    User user3 = (User) ois.readObject();

    Assert.assertEquals(user1.getName(), user2.getName());

    Assert.assertEquals(user2, user3);  // user2和user3是一个对象

    ois.close();

}

Code-10 中对同一对象两次写入文件，打印出写入一次对象后的存储大小和写入两次后的存储大小，然后从文件中反序列化出两个对象，比较这两个对象是否为同一对象。一般的思维是，两次写入对象，文件大小会变为两倍的大小，反序列化时，由于从文件读取，生成了两个对象，判断相等时应该是输入 false 才对，但是最后结果为 true。

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

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

参考：

本文转载至 https://www.ibm.com/developerworks/cn/java/j-lo-serial/
《Java对象的序列化与反序列化》：http://www.importnew.com/17964.html
自定义序列化的方法(transient、writeReplace、readResolve、Externalizable)

每天用心记录一点点。内容也许不重要，但习惯很重要！