序列化与反序列化

叁歲伎倆 2022-05-30 12:26 591阅读 0赞

我们知道，和new创建对象，反射创建对象，序列化创建对象也是我们常用的一种对象创建方式，下面就详细的说一说序列化与反序列化。

# 一.序列化简述 #

## 为什么需要序列化与反序列化? ##

程序运行时，只要需要，对象可以一直存在，并且我们可以随时访问对象的一些状态信息，如果程序终止，那么对象是肯定不会存在的，但是有时候，我们需要再程序终止时保存对象的状态信息，之后程序再次运行时可以重新恢复到之前的状态。  
　　如，玩家玩游戏退出时，需要保存玩家的状态信息（如等级、装备等等），之后玩家再此登入时，必须要恢复这些状态信息。  
　　我们可以通过数据库手段来达到这个保存状态的目的，在Java中，我们有更简便的方法进行处理，那就是序列化与反序列化。序列化是一种对象持久化的手段，反序列化与序列化相反，其是通过序列化后的信息重新组装成对象。序列化与反序列化普遍应用在网络传输、RMI等场景中。

使用Java对象序列化，在保存对象时，会把其状态保存为一组字节，在未来，再将这些字节组装成对象。必须注意地是，对象序列化保存的是对象的”状态”，即它的成员变量。**由此可知，对象序列化不会关注类中的静态变量。**

除了在持久化对象时会用到对象序列化之外，当使用RMI(远程方法调用)，或在网络中传递对象时，都会用到对象序列化。Java序列化API为处理对象序列化提供了一个标准机制，该API简单易用。

**列化类结构图**  
下面展示了与序列化相关的类的结构图  
![这里写图片描述][70]  
**说明：虚线框的表示接口类型，实线框表示具体的类。**

--------------------

**序列化关键字说明**  
与序列化相关的关键字如下  
![这里写图片描述][70 1]  
说明：  
1. 关键字transient，用来修饰字段，表示此字段在默认序列化过程中不会被处理，但是可以采用另外的手段进行处理。  
2. 关键字serialVersionUID，表示序列化版本号，当两个类的序列化ID一致时允许反序列化，默认可以采用编译器提供的值1L。

--------------------

**序列化方法说明**  
与序列化相关的方法如下  
![这里写图片描述][70 2]  
说明：writeObject与readObject方法分别在ObjectOutput接口与ObjectInput接口中声明，在ObjectOutputStream与ObjectInputStream中实现。

# 二.序列化使用 #

## 2.1如何对Java对象进行序列化与反序列化 ##

在Java中，只要一个类实现了java.io.Serializable接口，那么它就可以被序列化。这里先来一段代码：  
**code 1 创建一个User类，用于序列化及反序列化**

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 +
                    '}';
        }
    }

code 2 对User进行序列化及反序列化的Demo

package com.hollis;
    import org.apache.commons.io.FileUtils;
    import org.apache.commons.io.IOUtils;
    import java.io.*;
    import java.util.Date;
    
    /** * Created by hollis on 16/2/2. */
    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
            //写入到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}

--------------------

#### 序列化及反序列化相关知识 ####

1、在Java中，只要一个类实现了java.io.Serializable接口，那么它就可以被序列化。

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

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

4、序列化并不保存静态变量。

5、要想将父类对象也序列化，就需要让父类也实现Serializable 接口。

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

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

## 2.2 ，ArrayList的序列化 ##

在介绍ArrayList序列化之前，先来考虑一个问题：

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

带着这个问题，我们来看java.util.ArrayList的源码

//code 3
    
    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;
    }

笔者省略了其他成员变量，从上面的代码中可以知道ArrayList实现了java.io.Serializable接口，那么我们就可以对它进行序列化及反序列化。因为elementData是transient的，所以我们认为这个成员变量不会被序列化而保留下来。我们写一个Demo，验证一下我们的想法：

//code 4
    
    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]

**了解ArrayList的人都知道，ArrayList底层是通过数组实现的。**那么数组elementData其实就是用来保存列表中的元素的。通过该属性的声明方式我们知道，他是无法通过序列化持久化下来的。那么为什么code 4的结果却通过序列化和反序列化把List中的元素保留下来了呢？

--------------------

**writeObject和readObject方法**

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

这里先给出结论:

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

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

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

来看一下这两个方法的具体实现：

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

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

--------------------

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

**why transient**

ArrayList实际上是动态数组，每次在放满以后自动增长设定的长度值，如果数组自动增长长度设为100，而实际只放了一个元素，那就会序列化99个null元素。为了保证在序列化的时候不会将这么多null同时进行序列化，ArrayList把元素数组设置为transient。

**why writeObject and readObject**

前面说过，为了防止一个包含大量空对象的数组被序列化，为了优化存储，所以，ArrayList使用transient来声明elementData。 但是，作为一个集合，在序列化过程中还必须保证其中的元素可以被持久化下来，所以，通过重写writeObject 和 readObject方法的方式把其中的元素保留下来。

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

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

--------------------

至此，我们先试着来回答刚刚提出的问题：

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

答：可以通过在被序列化的类中增加writeObject 和 readObject方法。那么问题又来了：

虽然ArrayList中写了writeObject 和 readObject 方法，但是这两个方法并没有显示的被调用啊。

那么如果一个类中包含writeObject 和 readObject 方法，那么这两个方法是怎么被调用的呢?

--------------------

**ObjectOutputStream**

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

为了节省篇幅，这里给出ObjectOutputStream的writeObject的调用栈：

Created with Raphaël 2.1.2writeObjectwriteObject0writeOrdinaryObjectwriteSerialDatainvokeWriteObject

这里看一下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();
            }
        }

其中writeObjectMethod.invoke(obj, new Object\[\]\{ out \});是关键，通过反射的方式调用writeObjectMethod方法。官方是这么解释这个writeObjectMethod的：

class-defined writeObject method, or null if none

在我们的例子中，这个方法就是我们在ArrayList中定义的writeObject方法。通过反射的方式被调用了。

--------------------

至此，我们先试着来回答刚刚提出的问题：

**如果一个类中包含writeObject 和 readObject 方法，那么这两个方法是怎么被调用的?**

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

--------------------

至此，我们已经介绍完了ArrayList的序列化方式。那么，不知道有没有人提出这样的疑问：

Serializable明明就是一个空的接口，它是怎么保证只有实现了该接口的方法才能进行序列化与反序列化的呢？

Serializable接口的定义：

public interface Serializable {
    }

读者可以尝试把code1中的继承Serializable的代码去掉，再执行code 2，会抛出java.io.NotSerializableException。

其实这个问题也很好回答，我们再回到刚刚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.3 ，Externalizable ##

除了使用Serializable接口进行序列化以外，还可以使用Externalizable接口来进行序列化。

**Externalizable定义**

//Externalizable的定义如下　　
    
    public interface Externalizable extends java.io.Serializable { 
        void writeExternal(ObjectOutput out) throws IOException;
        void readExternal(ObjectInput in) throws IOException, ClassNotFoundException;
    }

说明：Externalizable实现了Serializable接口，并且添加了两个方法writeExternal与readExternal，需要序列化的类需要实现Externalizable接口，并且重写接口中定义的两个方法。

**使用说明**

首先将序列化的类实现Externalizable接口并且重写writeExternal与readExternal方法，并在这两个方法中实现处理逻辑。我们定义Person类如下

package com.hust.grid.leesf.serializable;
    
    import java.io.Externalizable;
    import java.io.IOException;
    import java.io.ObjectInput;
    import java.io.ObjectOutput;
    
    public class Person implements Externalizable { 
        /** * */
        private static final long serialVersionUID = 1L;
        private String name;
        private String gender;
        private int age;
        private transient Person friend;
    
        public Person() {
    
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public String getGender() {
            return gender;
        }
    
        public void setGender(String gender) {
            this.gender = gender;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public Person getFriend() {
            return friend;
        }
    
        public void setFriend(Person friend) {
            this.friend = friend;
        }
    
        @Override
        public String toString() {
            return "name = " + name + ", gender = " + gender + ", age = " + age
                    + ", friend info is [" + friend + "]";
        }
    
        @Override
        public void writeExternal(ObjectOutput out) throws IOException {
            out.writeUTF(name);
            out.writeUTF(gender);
            out.writeInt(age);
            out.writeObject(friend);
        }
    
        @Override
        public void readExternal(ObjectInput in) throws IOException,
                ClassNotFoundException {
            name = in.readUTF();
            gender = in.readUTF();
            age = in.readInt();
            friend = (Person) in.readObject();        
        }    
    }

说明：Person类实现了Externalizable接口，重写了writeExternal与readExternal方法，并且实现了用户自定义序列化与反序列化逻辑。测试类代码不变，运行结果如下：

name = leesf, gender = man, age = 24, friend info is [name = dyd, gender = woman, age = 24, friend info is [null]]
    name = leesf, gender = man, age = 24, friend info is [name = dyd, gender = woman, age = 24, friend info is [null]]

说明：从结果可知，成功进行了序列化与反序列化过程。值得注意的是，我们必须要给Person类提供一个无参构造器，才能正确完成序列化与反序列化过程。否则会抛出如下异常

package com.hust.grid.leesf.serializable;
    
    import java.io.Externalizable;
    import java.io.IOException;
    import java.io.ObjectInput;
    import java.io.ObjectOutput;
    
    public class Person implements Externalizable { 
        /** * */
        private static final long serialVersionUID = 1L;
        private String name;
        private String gender;
        private int age;
        private transient Person friend;
    
        public Person(String name) {
            this.name = name;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public String getGender() {
            return gender;
        }
    
        public void setGender(String gender) {
            this.gender = gender;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public Person getFriend() {
            return friend;
        }
    
        public void setFriend(Person friend) {
            this.friend = friend;
        }
    
        @Override
        public String toString() {
            return "name = " + name + ", gender = " + gender + ", age = " + age
                    + ", friend info is [" + friend + "]";
        }
    
        @Override
        public void writeExternal(ObjectOutput out) throws IOException {
            out.writeUTF(name);
            out.writeUTF(gender);
            out.writeInt(age);
            out.writeObject(friend);
        }
    
        @Override
        public void readExternal(ObjectInput in) throws IOException,
                ClassNotFoundException {
            name = in.readUTF();
            gender = in.readUTF();
            age = in.readInt();
            friend = (Person) in.readObject();        
        }    
    }

说明：提供一个参数的构造函数，没有无参构造函数，修改测试类代码如下

package com.hust.grid.leesf.serializable;
    
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.FileOutputStream;
    import java.io.ObjectInputStream;
    import java.io.ObjectOutputStream;
    
    public class SerializableDemo {
        public static void main(String[] args) throws Exception {
            Person leesf = new Person("leesf");
            Person dyd = new Person("dyd");
            leesf.setAge(24);
            leesf.setGender("man");
            leesf.setName("leesf");
    
            dyd.setAge(24);
            dyd.setGender("woman");
            dyd.setName("dyd"); 
    
            leesf.setFriend(dyd);
            dyd.setFriend(null);
    
            File file = new File("test");
            ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream(file));
            oos.writeObject(leesf);
            oos.flush();
            oos.close();
            System.out.println(leesf);
    
            ObjectInputStream ois = new ObjectInputStream(new FileInputStream(file));
            leesf = (Person) ois.readObject();
            ois.close(); 
            System.out.println(leesf); 
        }
    }

运行结果如下

name = leesf, gender = man, age = 24, friend info is [name = dyd, gender = woman, age = 24, friend info is [null]]
    Exception in thread "main" java.io.InvalidClassException: com.hust.grid.leesf.serializable.Person; no valid constructor
        at java.io.ObjectStreamClass$ExceptionInfo.newInvalidClassException(ObjectStreamClass.java:150)
        at java.io.ObjectStreamClass.checkDeserialize(ObjectStreamClass.java:768)
        at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1775)
        at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1351)
        at java.io.ObjectInputStream.readObject(ObjectInputStream.java:371)
        at com.hust.grid.leesf.serializable.SerializableDemo.main(SerializableDemo.java:32)

说明：在反序列化的过程抛出了异常，可以看出是Person类没有合法的构造器，合法的构造器就是指无参构造器。当提供了无参构造器之后，就可以正确运行。  
　  
　如果Person类实现了Externalizable接口，并且在Person类中添加了writeObject与readObject方法，那么在进行序列化与反序列化时，是以Externalizable接口中定义的两个方法进行序列化与反序列化的。

# 3.总结 #

1、如果一个类想被序列化，需要实现Serializable接口。否则将抛出NotSerializableException异常，这是因为，在序列化操作过程中会对类型进行检查，要求被序列化的类必须属于Enum、Array和Serializable类型其中的任何一种。

2、在变量声明前加上该关键字，可以阻止该变量被序列化到文件中。

3、在类中增加writeObject 和 readObject 方法可以实现自定义序列化策略

主要转载自：  
[http://www.hollischuang.com/archives/1140][http_www.hollischuang.com_archives_1140]

参考自：  
[http://www.cnblogs.com/leesf456/p/5328466.html][http_www.cnblogs.com_leesf456_p_5328466.html]

[70]: /images/20220530/0d9ecaf36df841a88d40b61d5cbe74af.png
[70 1]: /images/20220530/ee06977c210a4a68a16bdcc0ea518e63.png
[70 2]: /images/20220530/ad6bc5ae02bf4d449546dd3755b4e7d1.png
[http_www.hollischuang.com_archives_1140]: http://www.hollischuang.com/archives/1140
[http_www.cnblogs.com_leesf456_p_5328466.html]: http://www.cnblogs.com/leesf456/p/5328466.html