什么是serialVersionUID?serialVersionUID详解

2023-10-28 05:36
文章标签 详解 serialversionuid

本文主要是介绍什么是serialVersionUID?serialVersionUID详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

什么是serialVersionUID?serialVersionUID详解

概述

  • 所述的serialVersionUID属性是用来序列的标识符/反序列化的对象序列化类。

  • 序列化运行时与每个可序列化的类关联一个版本号,称为serialVersionUID,在反序列化期间使用该版本号来验证序列化对象的发送者和接收者是否已加载了该对象的与序列化兼容的类。

  • 如果接收者为对象加载的类serialVersionUID与相应的发送者的类不同,则反序列化将导致 InvalidClassException。可序列化的类可以serialVersionUID通过声明一个serialVersionUID必须为static,final和type的字段来显式声明其自身long:

  • private static final long serialVersionUID = 42L;
    
  • 如果可序列化的类未显式声明一个 serialVersionUID,则序列化运行时将根据serialVersionUID该类的各个方面为该类计算默认值,如Java对象序列化规范中所述。

  • 但是,强烈建议所有可序列化的类显式声明serialVersionUID值,因为默认serialVersionUID计算对类详细信息高度敏感,而类详细信息可能会根据编译器的实现而有所不同,因此可能在InvalidClassExceptions反序列化期间导致意外情况。

  • 因此,为了保证serialVersionUID不同Java编译器实现之间的值一致,可序列化的类必须声明一个显式serialVersionUID值。还强烈建议明确serialVersionUID声明尽可能使用private修饰符,因为此类声明仅适用于立即声明的类-serialVersionUID字段作为继承成员没有用。

序列号UID

  • 简而言之,我们使用serialVersionUID属性记住Serializable类的版本,以验证加载的类和序列化的对象是否兼容。

  • 不同类的serialVersionUID属性是独立的。因此,不同的类不必具有唯一的值。

  • 接下来,让我们通过一些示例来学习如何使用 serialVersionUID。

  • 首先创建一个可序列化的类,并声明一个serialVersionUID标识符:

  • public class AppleProduct implements Serializable {private static final long serialVersionUID = 1234567L;public String headphonePort;public String thunderboltPort;
    }
    
  • 接下来,我们将需要两个实用程序类:一个用于将AppleProduct对象序列化为String,另一个用于从该String反序列化该对象:

  • public class SerializationUtility {public static void main(String[] args) {AppleProduct macBook = new AppleProduct();macBook.headphonePort = "headphonePort2020";macBook.thunderboltPort = "thunderboltPort2020";String serializedObj = serializeObjectToString(macBook);System.out.println("Serialized AppleProduct object to string:");System.out.println(serializedObj);}public static String serializeObjectToString(Serializable o) {ByteArrayOutputStream baos = new ByteArrayOutputStream();ObjectOutputStream oos = new ObjectOutputStream(baos);oos.writeObject(o);oos.close();return Base64.getEncoder().encodeToString(baos.toByteArray());}
    }
    
  • public class DeserializationUtility {public static void main(String[] args) {String serializedObj = ... // ommited for claritySystem.out.println("Deserializing AppleProduct...");AppleProduct deserializedObj = (AppleProduct) deSerializeObjectFromString(serializedObj);System.out.println("Headphone port of AppleProduct:"+ deserializedObj.getHeadphonePort());System.out.println("Thunderbolt port of AppleProduct:"+ deserializedObj.getThunderboltPort());}public static Object deSerializeObjectFromString(String s)throws IOException, ClassNotFoundException {byte[] data = Base64.getDecoder().decode(s);ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(data));Object o = ois.readObject();ois.close();return o;}
    }
    
  • 我们从运行SerializationUtility.java开始,该程序将AppleProduct对象保存(序列化)为String实例,并使用Base64对字节进行编码

  • 然后,使用该String作为反序列化方法的参数,我们运行DeserializationUtility.java,该程序从给定的String重新组装(反序列化)AppleProduct对象。

  • 生成的输出应与此类似:

  • Serialized AppleProduct object to string:
    rO0ABXNyACljb20uYmFlbGR1bmcuZGVzZXJpYWxpemF0aW9uLkFwcGxlUHJvZHVjdAAAAAAAEta
    HAgADTAANaGVhZHBob25lUG9ydHQAEkxqYXZhL2xhbmcvU3RyaW5nO0wADmxpZ2h0ZW5pbmdQb3
    J0cQB+AAFMAA90aHVuZGVyYm9sdFBvcnRxAH4AAXhwdAARaGVhZHBob25lUG9ydDIwMjBwdAATd
    Gh1bmRlcmJvbHRQb3J0MjAyMA==
    
  • Deserializing AppleProduct...
    Headphone port of AppleProduct:headphonePort2020
    Thunderbolt port of AppleProduct:thunderboltPort2020
    
  • 现在,让我们 在AppleProduct.java中修改serialVersionUID常量,然后重新尝试从先前产生的同一String反序列化AppleProduct对象。重新运行DeserializationUtility.java应该生成此输出。

  • Deserializing AppleProduct...
    Exception in thread "main" java.io.InvalidClassException: com.baeldung.deserialization.AppleProduct; local class incompatible: stream classdesc serialVersionUID = 1234567, local class serialVersionUID = 7654321at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:616)at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1630)at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1521)at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1781)at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1353)at java.io.ObjectInputStream.readObject(ObjectInputStream.java:373)at com.baeldung.deserialization.DeserializationUtility.deSerializeObjectFromString(DeserializationUtility.java:24)at com.baeldung.deserialization.DeserializationUtility.main(DeserializationUtility.java:15)
    
  • 通过更改类的serialVersionUID,我们修改了其版本/状态。结果,在反序列化期间未找到兼容的类,并且引发了InvalidClassException。

  • 如果Serializable类中未提供serialVersionUID,则JVM将自动生成一个。但是,优良作法是提供serialVersionUID值,并在更改类后对其进行更新,以便我们可以控制序列化/反序列化过程。我们将在下一部分中对其进行仔细研究。

兼容的变更

  • 假设我们需要在现有的AppleProduct类中添加一个新的lightningPort字段:

  • public class AppleProduct implements Serializable {
    //...public String lightningPort;
    }
    
  • 因为我们只是增加一个新的领域,在没有变化的serialVersionUID将需要。这是因为,在反序列化过程中,会将null分配为lightningPort字段的默认值。

  • 让我们修改DeserializationUtility类以打印此新字段的值:

  • System.out.println("LightningPort port of AppleProduct:"+ deserializedObj.getLightningPort());
    
  • 现在,当我们重新运行DeserializationUtility类时,我们将看到类似以下的输出:

  • Deserializing AppleProduct...
    Headphone port of AppleProduct:headphonePort2020
    Thunderbolt port of AppleProduct:thunderboltPort2020
    Lightning port of AppleProduct:null
    

默认串行版本

  • 如果我们不为Serializable 类定义 serialVersionUID 状态 ,则Java将根据类本身的某些属性(例如,类名,实例字段等)定义一个。

  • 让我们定义一个简单的 Serializable 类:

  • public class DefaultSerial implements Serializable {
    }
    
  • 如果我们像下面这样序列化此类的实例:

  • DefaultSerial instance = new DefaultSerial();
    System.out.println(SerializationUtility.serializeObjectToString(instance));
    
  • 这将打印序列化二进制文件的Base64摘要:

  • rO0ABXNyACpjb20uYmFlbGR1bmcuZGVzZXJpYWxpemF0aW9uLkRlZmF1bHRTZXJpYWx9iVz3Lz/mdAIAAHhw
    
  • 和以前一样,我们应该能够从摘要中反序列化此实例:

  • String digest = "rO0ABXNyACpjb20uYmFlbGR1bmcuZGVzZXJpY" + "WxpemF0aW9uLkRlZmF1bHRTZXJpYWx9iVz3Lz/mdAIAAHhw";
    DefaultSerial instance = (DefaultSerial) DeserializationUtility.deSerializeObjectFromString(digest);
    
  • 但是,对该类进行一些更改可能会破坏序列化兼容性。例如,如果我们向此类添加一个 私有 字段:

  • public class DefaultSerial implements Serializable {private String name;
    }
    
  • 然后尝试将相同的Base64摘要反序列化为类实例,我们将收到InvalidClassException:

  • Exception in thread "main" java.io.InvalidClassException: com.baeldung.deserialization.DefaultSerial; local class incompatible: stream classdesc serialVersionUID = 9045863543269746292, local class serialVersionUID = -2692722436255640434
    
  • 由于这种不必要的不兼容性,在Serializable类中声明serialVersionUID 始终是一个好主意。 这样,我们可以随着类本身的发展来保留或发展版本。

这篇关于什么是serialVersionUID?serialVersionUID详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/291032

相关文章

HTML5的input标签的`type`属性值详解和代码示例

《HTML5的input标签的`type`属性值详解和代码示例》HTML5的`input`标签提供了多种`type`属性值,用于创建不同类型的输入控件,满足用户输入的多样化需求,从文本输入、密码输入、... 目录一、引言二、文本类输入类型2.1 text2.2 password2.3 textarea(严格

C++ move 的作用详解及陷阱最佳实践

《C++move的作用详解及陷阱最佳实践》文章详细介绍了C++中的`std::move`函数的作用,包括为什么需要它、它的本质、典型使用场景、以及一些常见陷阱和最佳实践,感兴趣的朋友跟随小编一起看... 目录C++ move 的作用详解一、一句话总结二、为什么需要 move?C++98/03 的痛点⚡C++

MySQL中between and的基本用法、范围查询示例详解

《MySQL中betweenand的基本用法、范围查询示例详解》BETWEENAND操作符在MySQL中用于选择在两个值之间的数据,包括边界值,它支持数值和日期类型,示例展示了如何使用BETWEEN... 目录一、between and语法二、使用示例2.1、betwphpeen and数值查询2.2、be

python中的flask_sqlalchemy的使用及示例详解

《python中的flask_sqlalchemy的使用及示例详解》文章主要介绍了在使用SQLAlchemy创建模型实例时,通过元类动态创建实例的方式,并说明了如何在实例化时执行__init__方法,... 目录@orm.reconstructorSQLAlchemy的回滚关联其他模型数据库基本操作将数据添

Java中ArrayList与顺序表示例详解

《Java中ArrayList与顺序表示例详解》顺序表是在计算机内存中以数组的形式保存的线性表,是指用一组地址连续的存储单元依次存储数据元素的线性结构,:本文主要介绍Java中ArrayList与... 目录前言一、Java集合框架核心接口与分类ArrayList二、顺序表数据结构中的顺序表三、常用代码手动

JAVA线程的周期及调度机制详解

《JAVA线程的周期及调度机制详解》Java线程的生命周期包括NEW、RUNNABLE、BLOCKED、WAITING、TIMED_WAITING和TERMINATED,线程调度依赖操作系统,采用抢占... 目录Java线程的生命周期线程状态转换示例代码JAVA线程调度机制优先级设置示例注意事项JAVA线程

详解C++ 存储二进制数据容器的几种方法

《详解C++存储二进制数据容器的几种方法》本文主要介绍了详解C++存储二进制数据容器,包括std::vector、std::array、std::string、std::bitset和std::ve... 目录1.std::vector<uint8_t>(最常用)特点:适用场景:示例:2.std::arra

C++构造函数中explicit详解

《C++构造函数中explicit详解》explicit关键字用于修饰单参数构造函数或可以看作单参数的构造函数,阻止编译器进行隐式类型转换或拷贝初始化,本文就来介绍explicit的使用,感兴趣的可以... 目录1. 什么是explicit2. 隐式转换的问题3.explicit的使用示例基本用法多参数构造

Android使用java实现网络连通性检查详解

《Android使用java实现网络连通性检查详解》这篇文章主要为大家详细介绍了Android使用java实现网络连通性检查的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录NetCheck.Java(可直接拷贝)使用示例(Activity/Fragment 内)权限要求

MyBatis中的两种参数传递类型详解(示例代码)

《MyBatis中的两种参数传递类型详解(示例代码)》文章介绍了MyBatis中传递多个参数的两种方式,使用Map和使用@Param注解或封装POJO,Map方式适用于动态、不固定的参数,但可读性和安... 目录✅ android方式一:使用Map<String, Object>✅ 方式二:使用@Param