程序中有如下entity类-LevyPaymentFlow
@Data
@TableName(value = "levy_payment_flow", autoResultMap = true)
public class LevyPaymentFlow implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(type = IdType.AUTO)
private String flowNo;
/**
* 状态:初始、付款中、付款成功、付款失败
* @see c.e.c.enums.LevyPaymentFlowStatusEnum
*/
private String status;
...
}
为了让代码更易读、易维护,我将其status
的类型从String改成对应的枚举 LevyPaymentFlowStatusEnum ,相关的业务代码跟着一并更改。
以我的经验,这个小重构万无一失。
结果上线过程中翻车,现实给我上了一课。
什么问题呢? rabbitmq消费受到影响了。
业务程序中rabbitmq生产消息,将 LevyPaymentFlow 对象直接写入到消息队列中。
上线后的一刻,rabbitmq消费者监听并消费的时候出现异常:ClassCastException: cannot assign instance of java.lang.String to field c.e.c.levypay.entity.LevyPaymentFlow.status of type c.e.c.enums.LevyPaymentFlowStatusEnum in instance of c.e.c.levypay.entity.LevyPaymentFlow(不能将String串赋值给LevyPaymentFlow对象的LevyPaymentFlowStatusEnum类型的status,或者说,不能将String串分配到LevyPaymentFlowStatusEnum类型的LevyPaymentFlow#status上)
这是 java反序列化失败导致的异常。
Java反序列化对象时,当类结构发生变更时,会报上面的 ClassCastException。我们常用的fastjson则可以兼容这个结构的变更,可以兼容本案中的将String串赋值给枚举field的场景。
关于Java序列化,我本地测试来复现一下这个bug
第一步,执行下面test代码,将 LevyPaymentFlow 对象序列化为字节流并保存到文件中。
FileOutputStream byteArrayOutputStream=new FileOutputStream("testJavaSerialize");
ObjectOutputStream objectOutputStream=new ObjectOutputStream(byteArrayOutputStream);
LevyPaymentFlow entity = new LevyPaymentFlow();
entity.setStatus(LevyPaymentFlowStatusEnum.PAY_SUCCESS.getCode());
objectOutputStream.writeObject(entity);
第二步,变更 LevyPaymentFlow#status 的类型,改为 LevyPaymentFlowStatusEnum。
第三步,下面代码从上面创建的文件中读取字节流并将其反序列化为 LevyPaymentFlow 对象。执行程序抛出 ClassCastException。
ObjectInputStream objectInputStream=new ObjectInputStream(new FileInputStream("testJavaSerialize"));
LevyPaymentFlow entity2= (LevyPaymentFlow)objectInputStream.readObject();
异常堆栈:
Exception in thread "main" java.lang.ClassCastException: cannot assign instance of java.lang.String to field c.e.c.levypay.entity.LevyPaymentFlow.status of type c.e.c.enums.LevyPaymentFlowStatusEnum in instance of c.e.c.levypay.entity.LevyPaymentFlow
at java.io.ObjectStreamClass$FieldReflector.setObjFieldValues(ObjectStreamClass.java:2301)
at java.io.ObjectStreamClass.setObjFieldValues(ObjectStreamClass.java:1431)
at java.io.ObjectInputStream.defaultReadFields(ObjectInputStream.java:2437)
at java.io.ObjectInputStream.readSerialData(ObjectInputStream.java:2355)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:2213)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1669)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:503)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:461)
at TestMain.main(TestMain.java:82)
关于Java序列化。补充两点,
一)要使用Java序列化,对象类必须实现java.io.Serializable 接口。否则,上面第一步的序列化代码会报错
Exception in thread "main" java.io.NotSerializableException: c.e.c.levypay.entity.LevyPaymentFlow
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1184)
at java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:348)
at TestMain.main(TestMain.java:75)
二)关于序列化机制中的 serialVersionUID
serialVersionUID 是一个 private static final long 类型的常量,存在于实现了 java.io.Serializable 接口的类中。它作为类的一个版本标识,用于在序列化和反序列化过程中验证序列化对象和类的版本一致性。如果不手动指定 serialVersionUID,JVM 在序列化时会根据类的结构信息自动计算并生成一个 serialVersionUID 值。
如果未指定serialVersionUID,那么,当类的结构发生变更,反序列化时会因serialVersionUID值不同而抛出 InvalidClassException
Exception in thread "main" java.io.InvalidClassException: c.e.c.levypay.entity.LevyPaymentFlow; local class incompatible: stream classdesc serialVersionUID = -7534543191229157756, local class serialVersionUID = -9139150564353461074
at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:699)
at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:2005)
at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1852)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:2186)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1669)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:503)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:461)
at TestMain.main(TestMain.java:80)