|
| 1 | +# serialVersionUID 有什么作用？该如何使用？ |
| 2 | + |
| 3 | +当一个对象实现 Serializable 接口时，多数 ide 会提示声明一个静态常量 serialVersionUID(版本标识），那 serialVersionUID 到底有什么作用呢？应该如何使用 serialVersionUID ？ |
| 4 | + |
| 5 | +serialVersionUID 是实现 Serializable 接口而来的，而 Serializable 则是应用于Java 对象序列化/反序列化。对象的序列化主要有两种用途: |
| 6 | + |
| 7 | +- 把对象序列化成字节码，保存到指定介质上(如磁盘等) |
| 8 | +- 用于网络传输 |
| 9 | + |
| 10 | +现在反过来说就是，serialVersionUID 会影响到上述所提到的两种行为。那到底会造成什么影响呢？ |
| 11 | + |
| 12 | +[java.io.Serializable](http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html) doc 文档，给出了一个相对详细解释: |
| 13 | + |
| 14 | + serialVersionUID 是 Java 为每个序列化类产生的版本标识，可用来保证在反序列时，发送方发送的和接受方接收的是可兼容的对象。如果接收方接收的类的 serialVersionUID 与发送方发送的 serialVersionUID 不一致，进行反序列时会抛出 InvalidClassException。序列化的类可显式声明 serialVersionUID 的值，如下: |
| 15 | + ``` |
| 16 | + ANY-ACCESS-MODIFIER static final long serialVersionUID = 1L; |
| 17 | + ``` |
| 18 | + |
| 19 | +文档上还建议将 serialVersionUID 置为 private。 |
| 20 | + |
| 21 | +举例说明如下: |
| 22 | +现在尝试通过将一个类 Person 序列化到磁盘和反序列化来说明 serialVersionUID 的作用: Person 类如下: |
| 23 | +``` |
| 24 | +public class Person implements Serializable { |
| 25 | +
|
| 26 | + private static final long serialVersionUID = 1L; |
| 27 | +
|
| 28 | + private String name; |
| 29 | + private Integer age; |
| 30 | + private String address; |
| 31 | +
|
| 32 | + public Person() { |
| 33 | + } |
| 34 | +
|
| 35 | + public Person(String name, Integer age, String address) { |
| 36 | + this.name = name; |
| 37 | + this.age = age; |
| 38 | + this.address = address; |
| 39 | + } |
| 40 | +
|
| 41 | +
|
| 42 | + @Override |
| 43 | + public String toString() { |
| 44 | + return "Person{" + |
| 45 | + "name='" + name + '\'' + |
| 46 | + ", age=" + age + |
| 47 | + ", address='" + address + '\'' + |
| 48 | + '}'; |
| 49 | + } |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +简单的测试一下： |
| 54 | +``` |
| 55 | +@Test |
| 56 | +public void testversion1L() throws Exception { |
| 57 | + File file = new File("person.out"); |
| 58 | + // 序列化 |
| 59 | + ObjectOutputStream oout = new ObjectOutputStream(new FileOutputStream(file)); |
| 60 | + Person person = new Person("John", 21, "广州"); |
| 61 | + oout.writeObject(person); |
| 62 | + oout.close(); |
| 63 | + // 反序列化 |
| 64 | + ObjectInputStream oin = new ObjectInputStream(new FileInputStream(file)); |
| 65 | + Object newPerson = oin.readObject(); |
| 66 | + oin.close(); |
| 67 | + System.out.println(newPerson); |
| 68 | +} |
| 69 | +``` |
| 70 | + |
| 71 | +测试发现没有什么问题。有一天，因发展需要， 需要在 Person 中增加了一个字段 email，如下: |
| 72 | +``` |
| 73 | +public class Person implements Serializable { |
| 74 | +
|
| 75 | + private static final long serialVersionUID = 1L; |
| 76 | +
|
| 77 | + private String name; |
| 78 | + private Integer age; |
| 79 | + private String address; |
| 80 | + private String email; |
| 81 | +
|
| 82 | + public Person() { |
| 83 | + } |
| 84 | +
|
| 85 | + public Person(String name, Integer age, String address) { |
| 86 | + this.name = name; |
| 87 | + this.age = age; |
| 88 | + this.address = address; |
| 89 | + } |
| 90 | +
|
| 91 | + public Person(String name, Integer age, String address,String email) { |
| 92 | + this.name = name; |
| 93 | + this.age = age; |
| 94 | + this.address = address; |
| 95 | + this.email = email; |
| 96 | + } |
| 97 | +
|
| 98 | + @Override |
| 99 | + public String toString() { |
| 100 | + return "Person{" + |
| 101 | + "name='" + name + '\'' + |
| 102 | + ", age=" + age + |
| 103 | + ", address='" + address + '\'' + |
| 104 | + ", email='" + email + '\'' + |
| 105 | + '}'; |
| 106 | + } |
| 107 | +} |
| 108 | +``` |
| 109 | + |
| 110 | +这时我们假设和之前序列化到磁盘的 Person 类是兼容的，便不修改版本标识 serialVersionUID。再次测试如下 |
| 111 | +``` |
| 112 | +@Test |
| 113 | +public void testversion1LWithExtraEmail() throws Exception { |
| 114 | + File file = new File("person.out"); |
| 115 | + ObjectInputStream oin = new ObjectInputStream(new FileInputStream(file)); |
| 116 | + Object newPerson = oin.readObject(); |
| 117 | + oin.close(); |
| 118 | + System.out.println(newPerson); |
| 119 | +} |
| 120 | +``` |
| 121 | +将以前序列化到磁盘的旧 Person 反序列化到新 Person 类时，没有任何问题。 |
| 122 | + |
| 123 | +可当我们增加 email 字段后，不作向后兼容。即放弃原来序列化到磁盘的 Person 类，这时我们可以将版本标识提高，如下: |
| 124 | +``` |
| 125 | +private static final long serialVersionUID = 2L; |
| 126 | +``` |
| 127 | + |
| 128 | +再次进行序列化，则会报错，如下: |
| 129 | +``` |
| 130 | +java.io.InvalidClassException:Person local class incompatible: stream classdesc serialVersionUID = 1, local class serialVersionUID = 2 |
| 131 | +``` |
| 132 | + |
| 133 | +谈到这里，我们大概可以清楚，serialVersionUID 就是控制版本是否兼容的，若我们认为修改的 Person 是向后兼容的，则不修改 serialVersionUID；反之，则提高 serialVersionUID的值。再回到一开始的问题，为什么 ide 会提示声明 serialVersionUID 的值呢？ |
| 134 | + |
| 135 | +因为若不显式定义 serialVersionUID 的值，Java 会根据类细节自动生成 serialVersionUID 的值，如果对类的源代码作了修改，再重新编译，新生成的类文件的serialVersionUID的取值有可能也会发生变化。类的serialVersionUID的默认值完全依赖于Java编译器的实现，对于同一个类，用不同的Java编译器编译，也有可能会导致不同的serialVersionUID。所以 ide 才会提示声明 serialVersionUID 的值。 |
| 136 | + |
| 137 | +附录拓展: |
| 138 | + |
| 139 | +- [深入理解 Java 对象序列化](http://developer.51cto.com/art/201202/317181.htm) |
| 140 | +- [对象的序列化和反序列化](http://www.blogjava.net/lingy/archive/2008/10/10/233630.html) |
| 141 | + |
| 142 | +stackoverflow原址：http://stackoverflow.com/questions/285793/what-is-a-serialversionuid-and-why-should-i-use-it |
0 commit comments