为什么在Java中的Serializable类中使用SerialVersionUID？

在序列化期间，Java运行时为类创建一个版本号，以便以后可以对其进行反序列化。此版本号在Java中称为SerialVersionUID。

SerialVersionUID用于序列化数据的版本。只有当类的SerialVersionUID与序列化实例匹配时，才能对其进行反序列化。当我们不在类中声明SerialVersionUID时，Java运行时会为我们生成它，但不建议这样做。建议将SerialVersionUID声明为私有静态最终长变量，以避免默认机制。

当您通过实现标记接口java.io.Serializable将类声明为Serializable时，如果您没有使用Externalizable接口自定义进程，java运行时将该类的实例通过默认Serialization机制持久化到磁盘中。

另请参阅为什么在Java中的Serializable类中使用SerialVersionUID

java.io.Serializable的文档可能与您将得到的解释一样好：

序列化运行时与每个可序列化类关联一个版本号，称为serialVersionUID，该版本号在反序列化期间用于验证序列化对象的发送方和接收方是否已为该对象加载了与序列化兼容的类。如果接收方为对象加载的类具有与对应发送方类不同的serialVersionUID，则反序列化将导致InvalidClassException。可序列化类可以通过声明一个名为serialVersionUID的字段来显式声明自己的serialVersionUID，该字段必须是静态的、final的和long类型：

ANY-ACCESS-MODIFIER静态最终长序列版本UID=42L；

如果可序列化类未显式声明serialVersionUID，则序列化运行时将根据该类的各个方面计算该类的默认serialVersionID值，如Java（TM）对象序列化规范中所述。但是，强烈建议所有可序列化类显式声明serialVersionUID值，因为默认的serialVersionUID计算对可能因编译器实现而异的类细节高度敏感，因此在反序列化期间可能会导致意外的InvalidClassExceptions。因此，为了保证不同java编译器实现之间的serialVersionUID值一致，可序列化类必须声明显式的serialVersion UID值。还强烈建议显式serialVersionUID声明在可能的情况下使用私有修饰符，因为此类声明仅适用于立即声明的类-serialVersionUID字段作为继承成员不有用。

如果您想修改大量最初没有设置serialVersionUID的类，同时保持与旧类的兼容性，IntelliJ Idea、Eclipse等工具会产生随机数，并且不能一次性处理一堆文件，因此会出现问题。我提出了以下bash脚本（很抱歉，Windows用户，请考虑购买Mac或转换为Linux），以轻松解决serialVersionUID问题：

base_dir=$(pwd)                                                                  
src_dir=$base_dir/src/main/java                                                  
ic_api_cp=$base_dir/target/classes                                               

while read f                                                                     
do                                                                               
    clazz=${f//\//.}                                                             
    clazz=${clazz/%.java/}                                                       
    seruidstr=$(serialver -classpath $ic_api_cp $clazz | cut -d ':' -f 2 | sed -e 's/^\s\+//')
    perl -ni.bak -e "print $_; printf qq{%s\n}, q{    private $seruidstr} if /public class/" $src_dir/$f
done

保存此脚本时，将add_serialVersionUID.sh设置为~/bin。然后在Maven或Gradle项目的根目录中运行它，如下所示：

add_serialVersionUID.sh < myJavaToAmend.lst

此.lst包含用于以以下格式添加serialVersionUID的java文件列表：

com/abc/ic/api/model/domain/item/BizOrderTransDO.java
com/abc/ic/api/model/domain/item/CardPassFeature.java
com/abc/ic/api/model/domain/item/CategoryFeature.java
com/abc/ic/api/model/domain/item/GoodsFeature.java
com/abc/ic/api/model/domain/item/ItemFeature.java
com/abc/ic/api/model/domain/item/ItemPicUrls.java
com/abc/ic/api/model/domain/item/ItemSkuDO.java
com/abc/ic/api/model/domain/serve/ServeCategoryFeature.java
com/abc/ic/api/model/domain/serve/ServeFeature.java
com/abc/ic/api/model/param/depot/DepotItemDTO.java
com/abc/ic/api/model/param/depot/DepotItemQueryDTO.java
com/abc/ic/api/model/param/depot/InDepotDTO.java
com/abc/ic/api/model/param/depot/OutDepotDTO.java

该脚本使用了JDK serialVer工具。因此，请确保$JAVA_HOME/bin位于PATH中。

serialVersionUID有助于序列化数据的版本控制。序列化时，其值与数据一起存储。反序列化时，将检查同一版本，以查看序列化数据与当前代码的匹配情况。

如果要对数据进行版本化，通常从serialVersionUID 0开始，并将其与更改序列化数据（添加或删除非瞬时字段）的类的每一个结构更改一起转储。

内置的反序列化机制（在.defaultReadObject（）中）将拒绝从旧版本的数据进行反序列化。但如果您愿意，您可以定义自己的readObject（）函数，该函数可以读取旧数据。然后，此自定义代码可以检查serialVersionUID，以了解数据的版本，并决定如何对其进行反序列化。如果存储的序列化数据在代码的几个版本中都存在，则此版本控制技术非常有用。

但将序列化数据存储如此长的时间跨度并不常见。更常见的是使用串行化机制将数据临时写入例如缓存，或通过网络将数据发送到具有相同版本的代码库相关部分的另一个程序。

在这种情况下，您对保持向后兼容性不感兴趣。您只关心确保正在通信的代码库确实具有相同版本的相关类。为了方便这种检查，您必须像以前一样维护serialVersionUID，并且在对类进行更改时不要忘记更新它。

如果忘记更新字段，则可能会导致一个类的两个不同版本具有不同的结构，但具有相同的serialVersionUID。如果发生这种情况，默认机制（在.defaultReadObject（）中）将检测不到任何差异，并尝试对不兼容的数据进行反序列化。现在，您可能会遇到一个神秘的运行时错误或静默失败（空字段）。这些类型的错误可能很难找到。

因此，为了帮助这个用例，Java平台为您提供了不手动设置serialVersionUID的选择。相反，类结构的哈希将在编译时生成并用作id。该机制将确保您永远不会有具有相同id的不同类结构，因此您不会得到上述难以跟踪的运行时序列化失败。

但自动生成id策略也有其背后的原因。也就是说，为同一类生成的id在编译器之间可能会有所不同（正如Jon Skeet所提到的）。因此，如果在使用不同编译器编译的代码之间传递序列化数据，建议无论如何都手动维护id。

如果您像前面提到的第一个用例那样与数据向后兼容，那么您可能也希望自己维护id。这是为了获得可读的id，并更好地控制它们的更改时间和方式。

我通常在一个上下文中使用serialVersionUID：当我知道它将离开JavaVM的上下文时。

当我为我的应用程序使用ObjectInputStream和ObjectOutputStream时，或者如果我知道我使用的库/框架将使用它时，我会知道这一点。serialVersionID确保不同版本或供应商的不同Java VM能够正确互操作，或者如果它在VM外部存储和检索（例如HttpSession），会话数据即使在应用服务器。

对于所有其他情况，我使用

@SuppressWarnings("serial")

因为大多数时候默认的serialVersionUID就足够了。这包括异常、HttpServlet。

“serialVersionUID”是一个64位数字，用于在反序列化过程中唯一标识类。序列化对象时，类的serialVersionUID也会写入文件。每当反序列化此对象时，java运行时都会从序列化数据中提取此serialVersionUID值，并比较与该类关联的相同值。如果两者不匹配，则将抛出“java.io.InvalidClassException”。

如果可序列化类未显式声明serialVersionUID，则序列化运行时将基于类的各个方面（如字段、方法等）计算该类的serialVersionID值。您可以参考此链接获取演示应用程序。