详解Java编程中对象的序列化
1. 什么是java对象序列化
java平台允许我们在内存中创建可复用的java对象,但一般情况下,只有当jvm处于运行时,这些对象才可能存在,即,这些对象的生命周期不会比jvm的生命周期更长。但在现实应用中,就可能要求在jvm停止运行之后能够保存(持久化)指定的对象,并在将来重新读取被保存的对象。java对象序列化就能够帮助我们实现该功能。
使用java对象序列化,在保存对象时,会把其状态保存为一组字节,在未来,再将这些字节组装成对象。必须注意地是,对象序列化保存的是对象的"状态",即它的成员变量。由此可知,对象序列化不会关注类中的静态变量。
除了在持久化对象时会用到对象序列化之外,当使用rmi(远程方法调用),或在网络中传递对象时,都会用到对象序列化。java序列化api为处理对象序列化提供了一个标准机制,该api简单易用,在本文的后续章节中将会陆续讲到。
2. 简单示例
在java中,只要一个类实现了java.io.serializable接口,那么它就可以被序列化。此处将创建一个可序列化的类person,本文中的所有示例将围绕着该类或其修改版。
gender类,是一个枚举类型,表示性别
public enum gender { male, female }
如果熟悉java枚举类型的话,应该知道每个枚举类型都会默认继承类java.lang.enum,而该类实现了serializable接口,所以枚举类型对象都是默认可以被序列化的。
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。
3. 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。
4. 默认序列化机制
如果仅仅只是让某个类实现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的单例对象,如下所示:
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; } private object readresolve() throws objectstreamexception { return instanceholder.instatnce; } ... }
再次执行本节的simpleserial应用后将如下输出:
arg constructor [john, 31, male] true
无论是实现serializable接口,或是externalizable接口,当从i/o流中读取对象时,readresolve()方法都会被调用到。实际上就是用readresolve()中返回的对象直接替换在反序列化过程中创建的对象。
6.一些高级用法
该说的都在注释中说完了。直接给程序吧。
package test.javapuzzler.p5; import java.io.*; import java.io.objectinputstream.getfield; import java.io.objectoutputstream.putfield; // 一个类实现serializable来表明自己可以被序列化; // 有一点需要特别注意的是: // 如果子类实现了serializable,而父类没有,则父类不会被序列化; public class serializableobject implements serializable { // 生成的序列化版本号会因为编译环境,声明的类名,成员名称和数量的变化而不同; // 也就是说这个版本号一定程度上记录着类的定义性的信息,如果类的定义变化了,最好重新生成版本号; // 如果新的代码使用了旧的版本号,则在反序列化的时候,可以兼容读取旧类的字节码而不会报错; private static final long serialversionuid = 9038542591452547920l; public string name; public string password; // 如果你不希望某个非静态成员被序列化,可以用transient来修饰它; public transient int age; // 静态成员不会被序列化,因为序列化保存的是实例的状态信息,而静态成员是类的状态信息; public static int version = 1; public serializableobject(string name, string password) { this.name = name; this.password = password; } // 每个类可以写一个writeobject方法,这个方法将会负责该类自身的序列化过程; // 比如对于敏感信息如password,可以加密之后再序列化; // 这个过程需要用到putfield,它可以指定哪些域会被序列化,怎么序列化(比如加密); // 如果没有定义这个方法,将会调用objectoutputstream 的 defaultwriteobject; // 你可以注释掉readobject方法,然后运行测试用例来测试密码是否被加密; private void writeobject(objectoutputstream out) throws ioexception { putfield putfields = out.putfields(); putfields.put("name", name); // 模拟加密密码 putfields.put("password", "thepassword:" + password); out.writefields(); } // 每个类可以写一个readobject方法,该方法负责该类自身的反序列化过程; // 比如对序列化时加密后的密码解密; // 这个过程需要用到getfield,他可以具体地读取每个域;或执行解密动作等等; // 如果没有定义这个方法,将会调用objectinputstream 的 defaultreadobject; private void readobject(objectinputstream in) throws classnotfoundexception, ioexception { getfield readfields = in.readfields(); // 读取到成员的值之后,直接赋给该域,即完成该域的反序列化; name = (string) readfields.get("name", "defaultname"); // 模拟解密密码 string encpassword = (string) readfields.get("password", "thepassword:defaultvalue"); password = encpassword.split(":")[1]; } // 序列化 // 主要用到objectoutputstream; public void save() throws ioexception { fileoutputstream fout = new fileoutputstream("e:\\obj"); objectoutputstream oout = new objectoutputstream(fout); oout.writeobject(this); oout.close(); fout.close(); } // 反序列化 // 主要用到objectinputstream public static serializableobject load() throws ioexception, classnotfoundexception { fileinputstream fin = new fileinputstream("e:\\obj"); objectinputstream oin = new objectinputstream(fin); object o = oin.readobject(); return (serializableobject) o; } @override public string tostring() { return "name: " + name + ", password: " + password; } // 测试用例 public static void main(string[] args) throws ioexception, classnotfoundexception { serializableobject so = new serializableobject( "http://blog.csdn.net/sunxing007", "123456"); so.save(); system.out.println(so); system.out.println(serializableobject.load()); } }
序列化会对单例模式不利, 因为可以通过反序列化而破坏单例. 这个时候就要请出readresolve这个方法了. 比如下面的程序:
public class dog extends exception { //private static final long serialversionuid = -7156412195888553079l; public static final dog instance = new dog(); private dog() { } public string tostring() { return "woof"; } // 通过readresolve, 保证反序列化的时候能完全自主地处理返回对象. private object readresolve(){ return instance; } public static void main(string[] args) throws ioexception, classnotfoundexception{ dog d = dog.instance; bytearrayoutputstream bro = new bytearrayoutputstream(); objectoutputstream oout = new objectoutputstream(bro); oout.writeobject(d); objectinputstream oin = new objectinputstream(new bytearrayinputstream(bro.tobytearray())); dog d1 = (dog)oin.readobject(); system.out.println(d1==d); } }
上一篇: 各种API 博客分类: API
下一篇: 各种API 博客分类: API