升级 Java 可序列化类

Question

我读过各种关于序列化和serialVersionUID的使用的博客。他们中的大多数人提到使用它来维护可序列化类的状态。

我的情况是；

我知道旧的serialVersionUID和新的serialVersionUID。

在使用旧的serialVersionUID读取对象时，我想操作数据以使其适合新版本，如果我正在读取的对象是旧类型，我只想费心这样做。

这看起来应该是非常简单的事情！

有没有办法在读入对象时获取serialVersionUID？

InvalidClassException 在调用序列化类中的 readObject 方法之前抛出，因此我无法在那里访问它。

我发现的唯一提示是重写 ObjectInputStream 以便 readClassDescriptor() 可用，尽管这似乎是一个常见问题的重量级解决方案！

非常感谢所有帮助！

中号

Answer 1

我将介绍几种可能的方法来支持序列化中旧版本的类/接口：

使用迁移器

在这种情况下，您的 Java 项目中需要以下内容：

1. 统一所有这些的不可变接口类
2. 该接口的旧实现，注释为 @Deprecated
3. 接口的新实现
4. 帮助您将已弃用对象转换为新对象的 Migrator 类

让我从一开始就说它不是始终可以使用旧版本的对象（请参阅 Oracle 文档 可序列化对象的版本控制）。为了简单起见，我们假设在升级时，您的类始终实现您定义的接口 IEntity。

public interface IEntity extends Serializable {
   // your method definitions
}

并假设您最初使用该类：

public class Entity implements IEntity {
   private static final long serialVersionUID = 123456789L;
   // fields and methods
}

如果您需要将类Entity升级为具有新serialVersionUID的新实现，则首先将其注释为@Deprecated但< em>不要重命名它并且不要将其移动到另一个包：

@Deprecated 
public class Entity implements IEntity {
private static final long serialVersionUID = 123456789L;
  // fields and methods
}

现在使用新的serialVersionUID（重要）和附加构造函数创建新的实现，如下所示

public class Entity_new implements IEntity {
  private static final long serialVersionUID = 5555558L;

  public Entity_new(IEntity){
     // Create a new instance of Entity_new copying the given IEntity
  }

}

...当然整个过程中最关键的部分是如何实现上述构造函数。如果您已将旧类型 Entity 的一些对象序列化为二进制文件（例如使用 ObjectOutputStream），并且现在已迁移到 Entity_new，您可以将它们解析为 Entity 的实例，然后将它们转换为 Entity_new 的实例。这是一个示例：

public class Migrator {

   private final IEntity entity;
   private Class<? extends IEntity> newestClass = Entity_new.class;

   public Migrator(final IEntity entity){
    this.entity = entity;
   }

   public Migrator setNewestClass(Class<? extends IEntity> clazz){
     this.newestClass = clazz;
     return this;
   }

   public IEntity migrate() throws Exception {
     Constructor<? extends IEntity> constr =  
        newestClass.getConstructor(IEntity.class);
     return constr.newInstance(this.entity);
   }
}

当然还有其他替代方案，不需要特定的构造函数或使用 Java 反射。还有许多其他设计方法可供选择。另请注意，为了简单起见，上述代码中完全省略了异常处理和空对象检查。

设计一个通用的可序列化接口

如果适用，您可以首先尝试为您的类设计一个将来不太可能更改的接口。如果您的类需要存储一组很可能被修改的属性，请考虑使用 Map 来实现此目的，其中 String 指的是属性名称/标识符和Object是对应的值。

自定义 readObject 和 writeObject

还有另一种方法可以为旧版本提供支持，为了完整性我会提到它，但我不会选择这种方法。您可以实现 private void readObject(ObjectInputStream in) 和 private void writeObject(ObjectOutputStream out) 以适应您的类/接口的当前版本和所有以前版本。我不确定这样的事情是否总是可行和可持续的，你最终可能会得到这些方法的非常混乱和冗长的实现。

替代序列化技术

这并没有回答OP的问题，但我认为值得提出来。您可以考虑以某种 ASCII 格式（例如 JSON、YAML 或 XML）序列化您的对象。在这种情况下，除非您大力重新设计可序列化接口，否则可扩展性是现成的。如果您正在寻找可扩展的二进制协议，BSON（二进制 JSON）是一个不错的选择。也许这是在可能无法用 Java 实现的软件之间提供对象可移植性的最佳方式。

Answer 2

您应该保持相同的serialVersionUID。序列化字段不必与类本身的字段匹配。使用ObjectInputStream.readFields并定义serialPercientFields（尽管请确保拼写正确）。

Answer 3

这不是一件容易的事。如果您的代码可以支持这两种类类型，则处理此问题的最佳方法是不更改serialVersionUID，而是检测数据是新的还是旧的，并相应地读取数据。

如果您想将旧数据一次性升级为新数据，则需要设置某种类杂耍，其中旧类和新类都可用于进程（例如单独的类加载器）。您需要使用旧类读取数据，复制到新类并重写。但这绝对不是最好的做事方式。

简而言之，更改serialVersionUID不是维护状态的方法，而是指示不兼容的方法（即，退出是唯一解决方案的情况）。