readResolve 不起作用？ ：出现 Guava 的 SerializedForm 实例

Question

在我们的数据结构之一的反序列化过程中（使用默认机制（无自定义 writeObject/readObject）），会显示一个 ImmutableMap$SerializedForm 实例（来自 google 的 Guava 库）。

这样的实例对于 guava 客户端来说不应该是可见的，因为 SerializedForm 的实例是使用 readResolve 替换的（例如，参见 com.google.common.collect.ImmutableMap 类中的“writeReplace”）。

因此，反序列化失败并显示以下消息：

java.lang.ClassCastException: cannot assign instance of com.google.common.collect.ImmutableMap$SerializedForm
to field .. of type java.util.Map in instance of com.blah.C

这是正确的，因为 ImmutableMap$SerializedForm 不是 java.util.Map 的子类型，但 它应该被替换。出了什么问题？

我们在 com.blah.C 类中没有自定义 writeObject/readObject。我们在父对象（包含 com.blah.C）中确实有自定义序列化代码。

更新，这是堆栈跟踪的顶部：

java.lang.ClassCastException: cannot assign instance of com.google.common.collect.ImmutableSet$SerializedForm to field com.blah.ast.Automaton.bodyNodes of type java.util.Set in instance of com.blah.ast.Automaton
at java.io.ObjectStreamClass$FieldReflector.setObjFieldValues(ObjectStreamClass.java:2039)
at java.io.ObjectStreamClass.setObjFieldValues(ObjectStreamClass.java:1212)
at java.io.ObjectInputStream.defaultReadFields(ObjectInputStream.java:1952)
at java.io.ObjectInputStream.readSerialData(ObjectInputStream.java:1870)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1752)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1328)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:350)
at java.util.ArrayList.readObject(ArrayList.java:593)
at sun.reflect.GeneratedMethodAccessor9.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at java.io.ObjectStreamClass.invokeReadObject(ObjectStreamClass.java:974)
at java.io.ObjectInputStream.readSerialData(ObjectInputStream.java:1848)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1752)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1328)
at java.io.ObjectInputStream.defaultReadFields(ObjectInputStream.java:1946)
at java.io.ObjectInputStream.defaultReadObject(ObjectInputStream.java:479)
at com.blah.ast.AstNode.readObject(AstNode.java:189)
at sun.reflect.GeneratedMethodAccessor10.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at java.io.ObjectStreamClass.invokeReadObject(ObjectStreamClass.java:974)
at java.io.ObjectInputStream.readSerialData(ObjectInputStream.java:1848)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1752)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1328)
at java.io.ObjectInputStream.readObject(ObjectInputStream.java:350)
at java.util.ArrayList.readObject(ArrayList.java:593)
at sun.reflect.GeneratedMethodAccessor9.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at java.io.ObjectStreamClass.invokeReadObject(ObjectStreamClass.java:974)
at java.io.ObjectInputStream.readSerialData(ObjectInputStream.java:1848)
at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1752)
at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1328)
at java.io.ObjectInputStream.defaultReadFields(ObjectInputStream.java:1946)
at java.io.ObjectInputStream.defaultReadObject(ObjectInputStream.java:479)
at com.blah.ast.AstNode.readObject(AstNode.java:189)

Answer 1

本周，我们再次遇到这个错误；但我找到了根本原因。 ObjectInputStream 使用的类加载器高度依赖于上下文（有些人会说不确定）。以下是 Sun 文档的相关部分（摘自 ObjectInputStream#resolveClass(ObjectStreamClass)）：

[类加载器]的确定如下：如果当前线程的堆栈上有一个方法，其声明类是由用户定义的类加载器定义的（并且不是为实现反射调用而生成的），那么它是与当前执行帧最接近的此类方法对应的类加载器；否则，它为空。如果此调用导致 ClassNotFoundException，并且传递的 ObjectStreamClass 实例的名称是基本类型或 void 的 Java 语言关键字，则将返回表示该基本类型或 void 的 Class 对象（例如，名称为“int”的 ObjectStreamClass " 将被解析为 Integer.TYPE)。否则，将向该方法的调用者抛出 ClassNotFoundException。

在我们的应用程序中，我们有一个 Eclipse 插件 B，它依赖于一个纯实用程序插件 A。我们正在反序列化类位于 B 中的对象，但反序列化是在 A 中启动的（在那里创建一个 ObjectInputStream），这就是问题所在。很少（即取决于文档所说的调用堆栈）反序列化选择了错误的类加载器（无法加载 B 类）。为了解决这个问题，我们将一个适当的加载器从顶级反序列化调用程序（B 中）传递到 A 中的实用程序方法。该方法现在使用自定义 ObjectInputStream，如下所示（请注意自由变量“loader”）：

ObjectInputStream ois = new ObjectInputStream(new FileInputStream(file)) {
                @SuppressWarnings("rawtypes")
                @Override
                protected Class resolveClass(ObjectStreamClass objectStreamClass)
                        throws IOException, ClassNotFoundException {
                    return Class.forName(objectStreamClass.getName(), true, loader);
                }
            };

Answer 2

请提交错误：
http://code.google.com/p/guava-libraries/issues/entry

如果您可以附加一个为您触发此错误的独立程序，那将会有所帮助！

Answer 3

我们找到了如何避免该错误，但没有找到导致该错误的原因。

当我们反序列化 ArrayListMultiMap 的实例时，类加载器找不到我们的类之一（com.blah....），因为使用了 Guava 的类加载器（在从 ObjectInputStream#resolveClass 调用的代码中）而不是默认的类加载器。然后，ObjectInputStream 通过使用 ClassCastExceptions 填充其 HandleList#entries 实例来传播失败。此类异常最终会导致 readResolve 被跳过，这解释了为什么会出现 ImmutableMap$SerializedForm。

奇怪的是我们序列化和反序列化许多其他数据结构（我们自己的和番石榴的）。我们自己序列化 guava 的 ArrayListMultimap（使用自定义 writeObject）可以避免该错误（即使我们序列化 Guava 集合的实例（尽管不是 Multimap））。

我们不明白为什么类加载器突然出错，但一定是某个地方潜伏着一个错误。我相信我们收到了 ClassCastException 而不是 ClassNotFoundException，因为 ObjectInputStream 中的错误处理是错误的（即使缺少某些类，也不应该跳过 readResolve）。

Answer 4

问题是 writeReplace()/readResolve() 不能很好地处理对象图中的循环引用。 writeReplace() 和 readResolve() 是不对称的。在序列化期间，Java 将替换所有引用，包括循环引用。但在反序列化过程中，Java不会解析循环引用。不幸的是，这是设计使然。来自序列化规范：

注意 - readResolve 方法不会在对象上调用，直到
对象已完全构造，因此在其对象中对此对象的任何引用
对象图不会更新为指定的新对象
阅读解决。然而，在对象的序列化过程中
writeReplace 方法中，对原始对象的所有引用
替换对象的对象图被替换为对
替换对象。因此，如果一个对象是
序列化指定一个替换对象，其对象图具有
对原始对象的引用，反序列化将导致
对象图不正确。此外，如果引用类型
正在读取的对象（由 writeReplace 指定）和原始对象
不兼容，对象图的构造会引发
类转换异常。

Guava 开发人员可以通过使 ImmutableMap$SerializedForm 扩展 ImmutableMap 并委托给适当的 ImmutableMap 实例来解决这个问题。当发生循环引用时，调用者将获得 SerializedForm 而不是直接引用 ImmutableMap，但它比 ClassCastException 更好。

Answer 5

有同样的问题。结果发现，不可变列表的成员对象的类不在反序列化端的类路径上。
但这个事实隐藏在 ClassCastException 后面。

现在我正在使用此构造进行更好的错误检测：

final ImmutableSet.Builder<Object> notFoundClasses = ImmutableSet.builder();
    try {
        ObjectInputStream objectInputStream = new ObjectInputStream(inputStream) {
            @Override
            protected Class<?> resolveClass(ObjectStreamClass desc) throws IOException, ClassNotFoundException {
                try {
                    return super.resolveClass(desc);
                } catch (ClassNotFoundException e) {
                    notFoundClasses.add(desc.getName());
                    throw e;
                }
            }
        };
        return (T) objectInputStream.readObject();
    } catch (ClassCastException e) {
        throw Exceptions.runtime(e, "ClassCastException while de-serializing '%s', classes not found are: %s", objectClass, notFoundClasses.build());
    } catch (IOException | ClassNotFoundException e) {
        throw Exceptions.runtime(e, "Could not de-serialize '%s'", objectClass);
    }