Java基础之序列化

0 transient : Java序列化中如果有些字段不想进行序列化 怎么办？

使用transient关键字修饰

阻止实例中那些用此关键词修饰的变量序列化； 当对象被反序列化时，被transient修饰的变量值不会持久化和恢复。

只能修饰变量，不能修饰类和方法

引言

序列化技术：将java对象序列化为二进制文件。大部分情况下，开发人员只需要了解被序列化的类需要实现Serializable接口。

• 使用ObjectInputStream 和 ObjectOutputStream 进行对象的读写。
• 对象序列化保存的是对象的“状态”。即是他的成员变量。对象序列化不会关注类中的静态变量。
• 当使用RMI，或在网络中传递对象时，都会用到对象序列化。
• 想要父类对象也序列化，就需要让父类也实现Serialization接口。
• Transient关键字的作用时控制变量的序列化。在变量声明前加上关键字。可以组织该变量被序列化到文件中。反序列化时，transient变量的值被设为初始值（int为0，对象型为null）。
• 在类中增加writeObject 和 readObject 方法可以实现自定义序列化策略
• 服务器端给客户端发送序列化对象数据，对象中有一些数据是敏感的，比如密码字符串等，希望对该密码字段在序列化时，进行加密，而客户端如果拥有解密的密钥，只有在客户端进行反序列化时，才可以对密码进行读取，这样可以一定程度保证序列化对象的数据安全。

0. 怎样实现java 的序列化

• 实现java.io.Serializable接口，即可以被序列化

• 通过ObjectOutputStream和ObjectInputStream对对象进行序列化及反序列化

• 虚拟机是否允许反序列化，不仅取决于类路径和功能代码是否一致，还有两个类的序列化 ID 是否一致（就是 private static final long serialVersionUID）

  import org.apache.commons.io.FileUtils;
  import org.apache.commons.io.IOUtils;
  import java.io.*;
  import java.util.Date;
  
  public class SerializableDemo {
  
      public static void main(String[] args) {
          //Initializes The Object
          User user = new User();
          user.setName("hollis");
          user.setGender("male");
          user.setAge(23);
          user.setBirthday(new Date());
          System.out.println(user);
  
          //Write Obj to File
          ObjectOutputStream oos = null;
          try {
              oos = new ObjectOutputStream(new FileOutputStream("tempFile"));
              oos.writeObject(user);
          } catch (IOException e) {
              e.printStackTrace();
          } finally {
              IOUtils.closeQuietly(oos);
          }
  
          //Read Obj from File
          File file = new File("tempFile");
          ObjectInputStream ois = null;
          try {
              ois = new ObjectInputStream(new FileInputStream(file));
              User newUser = (User) ois.readObject();
              System.out.println(newUser);
          } catch (IOException e) {
              e.printStackTrace();
          } catch (ClassNotFoundException e) {
              e.printStackTrace();
          } finally {
              IOUtils.closeQuietly(ois);
              try {
                  FileUtils.forceDelete(file);
              } catch (IOException e) {
                  e.printStackTrace();
              }
          }
  
      }
  }
  //output 
  //User{name='hollis', age=23, gender=male, birthday=Tue Feb 02 17:37:38 CST 2016}
  //User{name='hollis', age=23, gender=null, birthday=Tue Feb 02 17:37:38 CST 2016}
  

  package com.hollis;
  import java.io.Serializable;
  import java.util.Date;
  
  /**
   * Created by hollis on 16/2/2.
   */
  public class User implements Serializable{
      private String name;
      private int age;
      private Date birthday;
      private transient String gender;
      private static final long serialVersionUID = -6849794470754667710L;
  
      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 Date getBirthday() {
          return birthday;
      }
  
      public void setBirthday(Date birthday) {
          this.birthday = birthday;
      }
  
      public String getGender() {
          return gender;
      }
  
      public void setGender(String gender) {
          this.gender = gender;
      }
  
      @Override
      public String toString() {
          return "User{" +
                  "name='" + name + '\'' +
                  ", age=" + age +
                  ", gender=" + gender +
                  ", birthday=" + birthday +
                  '}';
      }
  }
  

1. 序列化ID的问题

一个是固定的 1L，一个是随机生成一个不重复的 long 类型数据（实际上是使用 JDK 工具生成）

如果没有特殊需求，就是用默认的 1L 就可以，这样可以确保代码一致时反序列化成功。那么随机生成的序列化 ID 有什么作用呢，有些时候，通过改变序列化 ID 可以用来限制某些用户的使用。

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

package com.inout; 
 
import java.io.Serializable; 
 
public class A implements Serializable { 
 
    private static final long serialVersionUID = 1L; 
 
    private String name; 
    
    public String getName() 
    { 
        return name; 
    } 
    
    public void setName(String name) 
    { 
        this.name = name; 
    } 
} 
 
package com.inout; 
 
import java.io.Serializable; 
 
public class A implements Serializable { 
 
    private static final long serialVersionUID = 2L; 
    
    private String name; 
    
    public String getName() 
    { 
        return name; 
    } 
    
    public void setName(String name) 
    { 
        this.name = name; 
    } 
}

2. 序列化

2.1 如何自定义序列化和反序列化策略？

// ArrayList源码
public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    private static final long serialVersionUID = 8683452581122892189L;
    transient Object[] elementData; // non-private to simplify nested class access
    private int size;
}

因为elementData是transient的，所以我们认为这个成员变量不会被序列化而保留下来.

public static void main(String[] args) throws IOException, ClassNotFoundException {
        List<String> stringList = new ArrayList<String>();
        stringList.add("hello");
        stringList.add("world");
        stringList.add("hollis");
        stringList.add("chuang");
        System.out.println("init StringList" + stringList);
        ObjectOutputStream objectOutputStream = new ObjectOutputStream(new FileOutputStream("stringlist"));
        objectOutputStream.writeObject(stringList);

        IOUtils.close(objectOutputStream);
        File file = new File("stringlist");
        ObjectInputStream objectInputStream = new ObjectInputStream(new FileInputStream(file));
        List<String> newStringList = (List<String>)objectInputStream.readObject();
        IOUtils.close(objectInputStream);
        if(file.exists()){
            file.delete();
        }
        System.out.println("new StringList" + newStringList);
    }
//init StringList[hello, world, hollis, chuang]
//new StringList[hello, world, hollis, chuang]

为什么本段DEMO的结果却通过序列化和反序列化把List中的元素保留下来了呢？

2.1.1 ArrayList 中writeObject和readObject方法

在ArrayList中定义了俩个方法： writeObject和readObject。

这里先给出结论:

在序列化过程中，如果被序列化的类中定义了writeObject 和 readObject 方法，虚拟机会试图调用对象类里的 writeObject 和 readObject 方法，进行用户自定义的序列化和反序列化。

如果没有这样的方法，则默认调用是 ObjectOutputStream 的 defaultWriteObject 方法以及 ObjectInputStream 的 defaultReadObject 方法。

用户自定义的 writeObject 和 readObject 方法可以允许用户控制序列化的过程，比如可以在序列化的过程中动态改变序列化的数值。

再看ArrayList中自定义的writeObject和readObject：

private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        elementData = EMPTY_ELEMENTDATA;

        // Read in size, and any hidden stuff
        s.defaultReadObject();

        // Read in capacity
        s.readInt(); // ignored

        if (size > 0) {
            // be like clone(), allocate array based upon size not capacity
            ensureCapacityInternal(size);

            Object[] a = elementData;
            // Read in all elements in the proper order.
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }

private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException{
        // Write out element count, and any hidden stuff
        int expectedModCount = modCount;
        s.defaultWriteObject();

        // Write out size as capacity for behavioural compatibility with clone()
        s.writeInt(size);

        // Write out all elements in the proper order.
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

2.1.2 那么为什么ArrayList要用这种方式来实现序列化呢？

• why transient?

  ArrayList实际上是动态数组，每次在放满以后自动增长设定的长度值，如果数组自动增长长度设为100，而实际只放了一个元素，那就会序列化99个null元素。

  为了保证在序列化的时候不会将这么多null同时进行序列化，ArrayList把元素数组设置为transient。

• why writeObejct and readObject?

  前面说过，为了防止一个包含大量空对象的数组被序列化，为了优化存储，所以，ArrayList使用transient来声明elementData。

  但是，作为一个集合，在序列化过程中还必须保证其中的元素可以被持久化下来，所以，通过重写writeObject 和 readObject方法的方式把其中的元素保留下来。

  • writeObject方法把elementData数组中的元素遍历的保存到输出流（ObjectOutputStream）中。

  • readObject方法从输入流（ObjectInputStream）中读出对象并保存赋值到elementData数组中。

2.1.3 所以如何自定义序列化和反序列化策略？

可以通过在被序列化的类中增加writeObject 和 readObject方法。

2.2 writeObject 和 readObject是如何被调用的？

2.2.1 ObjectOutputStream

对象的序列化过程通过ObjectOutputStream和ObjectInputputStream来实现的，那么带着刚刚的问题，我们来分析一下ArrayList中的writeObject 和 readObject 方法到底是如何被调用的呢？

ObjectOutputStream的writeObject的调用栈：

writeObject ---> writeObject0 --->writeOrdinaryObject--->writeSerialData--->invokeWriteObject

这里看下invokeWriteObject：

void invokeWriteObject(Object obj, ObjectOutputStream out)
        throws IOException, UnsupportedOperationException
    {
        if (writeObjectMethod != null) {
            try {
                writeObjectMethod.invoke(obj, new Object[]{ out });
            } catch (InvocationTargetException ex) {
                Throwable th = ex.getTargetException();
                if (th instanceof IOException) {
                    throw (IOException) th;
                } else {
                    throwMiscException(th);
                }
            } catch (IllegalAccessException ex) {
                // should not occur, as access checks have been suppressed
                throw new InternalError(ex);
            }
        } else {
            throw new UnsupportedOperationException();
        }
    }

2.2.2 所以是如何被调用的？

在使用ObjectOutputStream的writeObject方法和ObjectInputStream的readObject方法时，会通过反射的方式调用。

2.3 如何保证实现了该接口才可以序列化/反序列化？

再回到刚刚ObjectOutputStream的writeObject的调用栈：

writeObject ---> writeObject0 --->writeOrdinaryObject--->writeSerialData--->invokeWriteObject

writeObject0有这样一段代码

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());
                }
            }

在进行序列化操作时，会判断要被序列化的类是否是Enum、Array和Serializable类型，如果不是则直接抛出NotSerializableException。

2.5 静态变量序列化

code2.5-1 静态变量序列化问题代码

public class Test implements Serializable {
 
    private static final long serialVersionUID = 1L;
 
    public static int staticVar = 5;
 
    public static void main(String[] args) {
        try {
            //初始时staticVar为5
            ObjectOutputStream out = new ObjectOutputStream(
                    new FileOutputStream("result.obj"));
            out.writeObject(new Test());
            out.close();
 
            //序列化后修改为10
            Test.staticVar = 10;
 
            ObjectInputStream oin = new ObjectInputStream(new FileInputStream(
                    "result.obj"));
            Test t = (Test) oin.readObject();
            oin.close();
             
            //再读取，通过t.staticVar打印新的值
            System.out.println(t.staticVar);
             
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

将对象序列化后，修改静态变量的数值，再将序列化对象读取出来，然后通过读取出来的对象获得静态变量的数值并打印出来。依照2.5-1，这个 System.out.println(t.staticVar) 语句输出的是 10 还是 5 呢？

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

3. 父类序列化与Transient关键字

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

解决：

​ 要想将父类对象也序列化，就需要让父类也实现****Serializable 接口。如果父类不实现的话的，就 需要有默认的无参的构造函数。在父类没有实现 Serializable 接口时，虚拟机是不会序列化父对象的，而一个 Java 对象的构造必须先有父对象，才有子对象，反序列化也不例外。所以反序列化时，为了构造父对象，只能调用父类的无参构造函数作为默认的父对象。

​ 因此当我们取父对象的变量值时，它的值是调用父类无参构造函数后的值。如果你考虑到这种序列化的情况，在父类无参构造函数中对变量进行初始化，否则的话，父类变量值都是默认声明的值，如 int 型的默认是 0，string 型的默认是 null。

使用案例：

​ 我们熟悉使用 Transient 关键字可以使得字段不被序列化，那么还有别的方法吗？根据父类对象序列化的规则，我们可以将不需要被序列化的字段抽取出来放到父类中，子类实现 Serializable 接口，父类不实现，根据父类序列化规则，父类的字段数据将不被序列化，形成类图如图 所示。

​ 图 2. 案例程序类图

attr1、attr2、attr3、attr5 都不会被序列化，放在父类中的好处在于当有另外一个 Child 类时，attr1、attr2、attr3 依然不会被序列化，不用重复抒写 transient，代码简洁

上图中可以看出，attr1、attr2、attr3、attr5 都不会被序列化，放在父类中的好处在于当有另外一个 Child 类时，attr1、attr2、attr3 依然不会被序列化，不用重复抒写 transient，代码简洁。

4. 对敏感字段加密

5. 序列化的存储规则

参考

Java 序列化的高级认识