如何使用XMLEncoder使数组列表线程安全并可序列化

首先:我知道在SO中有很多与此相关的帖子，但我可以找到一个能够帮助我的情况。

我做的是我有一个非常简单的父对象它可能有多个子对象。这两个对象都符合java bean规范(所有变量的无参数构造函数、setter和getter)。

可能有多个父节点，它们被保存在像这样的存储库类中:

private final Map<String, Parent> parentItems = new ConcurrentHashMap<String, Parent>();

每次创建新的父类时，存储库类保存从parentItems列表构建的父列表，如下所示:

public List<Parent> getParents() {
    return new ArrayList<Parent>(parentItems.values());
}

保存操作是通过使用XMLEncoder将List保存到xml文件中完成的。它看起来像这样:

public void saveParents(OutputStream os) {
    ClassLoader cl = Thread.currentThread().getContextClassLoader();
    XMLEncoder encoder = null;
    try {
        Thread.currentThread().setContextClassLoader(Parent.class.getClassLoader());
        encoder = new XMLEncoder(os);
        encoder.writeObject(getParents());
        encoder.flush();
    } finally {
        if (encoder != null) {
            encoder.close();
        }
        Thread.currentThread().setContextClassLoader(cl);
    }
}

这一切都很好。现在我想添加一些子对象到父对象，只是添加新的子对象到子列表，并重新运行saveParents()。这就是我的问题所在:

如果我在父元素中使用ArrayList来保存子元素，像这样:

private ArrayList<Child> children = new ArrayList<Child>();

一切正常。这些对象将保存在xml文件中的父对象中。它看起来像这样:

<?xml version="1.0" encoding="UTF-8"?>
<java version="1.7.0_45" class="java.beans.XMLDecoder">
 <object class="java.util.ArrayList">
  <void method="add">
   <object class="org.mypackage.Parent" id="Parent0">
    <void property="children">
     <void method="add">
      <object class="org.mypackage.Child">
       <void property="displayName">
        <string>Child1</string>
       </void>
       <void property="id">
        <string>myid1</string>
       </void>
       <void property="parent">
        <object idref="Parent0"/>
       </void>
      </object>
     </void>
     <void method="add">
      <object class="org.mypackage.Child">
       <void property="displayName">
        <string>Child2</string>
       </void>
       <void property="id">
        <string>myid2</string>
       </void>
       <void property="parent">
        <object idref="Parent0"/>
       </void>
      </object>
     </void>
    </void>
    <void property="displayName">
     <string>Parent1</string>
    </void>
    <void property="id">
     <string>myid</string>
    </void>
   </object>
  </void>
 </object>
</java>

然而，我们知道ArrayList不是线程安全的，我知道父对象可能被多人修改。那么如何解决这个问题呢?用synchronizedList(...)，对吧?比如…

private List<Child> children = Collections.synchronizedList(new ArrayList<Child>());

…然后只需快速将getter和setter更改为List而不是ArrayList，我们就可以了。好的，这应该工作-但你猜怎么着:它失败了:-(

)

每次我添加一个子对象(并运行saveParent()之后)，我得到一个StackOverflowException。如果我查找XML，我会看到这样的内容:

<?xml version="1.0" encoding="UTF-8"?>
<java version="1.7.0_45" class="java.beans.XMLDecoder">
<void class="java.util.ArrayList">
 <void method="add">
  <object class="org.mypackage.Child" id="Child0">
   <void property="displayName">
    <string>Child1</string>
   </void>
   <void property="id">
    <string>myid</string>
   </void>
   <void property="parent">
    <object class="org.mypackage.Parent"/>
   </void>
  </object>
 </void>
</void>
<void class="java.util.ArrayList">
 <void method="add">
  <object idref="Child0"/>
 </void>
</void>
<void class="java.util.ArrayList">
 <void method="add">
  <object idref="Child0"/>
 </void>
</void>
<void class="java.util.ArrayList">
 <void method="add">
  <object idref="Child0"/>
 </void>
</void>
...... AND THIS GOES ON AND ON AND ON .......

好吧，我猜我知道堆栈溢出是从哪里来的…但是为什么呢?它应该是可序列化的，但是，看看它。我如何得到一个可序列化的，线程安全的List(或任何其他适合的数据类型)，不会爆炸?也许您可以考虑的任何解决方案，以使ArrayList(在这种情况下工作)线程安全?也许通过使整个父对象线程安全?(然而，这可能有其他副作用，这就是为什么简单地让synchronizedList(...)工作将是最优雅的方式)

我创建了以下最小的完整可验证示例来复制您的问题:

public class Test {
    public static void main(String[] args) {
        List<Parent> parents = new ArrayList<>();
        // parents = Collections.synchronizedList(parents);
        Parent p1 = new Parent();
        Child c1 = new Child();
        Child c2 = new Child();
        p1.getChildren().add(c1);
        c1.setParent(p1);
        p1.getChildren().add(c2);
        c2.setParent(p1);
        parents.add(p1);
        try (XMLEncoder encoder = new XMLEncoder(System.out)) {
            encoder.writeObject(parents);
        }
    }
    public static class Parent {
        private List<Child> children = new ArrayList<>();
        public List<Child> getChildren() { return children; }
        public void setChildren(List<Child> children) { this.children = children; }
    }
    public static class Child {
        private Parent parent;
        public Parent getParent() { return parent; }
        public void setParent(Parent p) { parent = p; }
    }
}

上面的非同步集合代码可以工作，并生成所需的XML编码。取消注释parents = Collections.synchronizedList(parents);行，StackOverflowException结果。现在修复它。

问题似乎源于parents列表被序列化，如果是ArrayList<>，它不是。它实际上是一个非公开的java.util.Collections$SynchronizedRandomAccessList。如果StackOverflowException没有出现，你的问题应该是"我序列化了一个synchronizedList-wrapped-ArrayList，但被反序列化为一个ArrayList，这是错误的"。您需要对同步列表进行正确编码。为此，您需要一个PersistenceDelegate。

public class SynchronizedArrayListPD extends DefaultPersistenceDelegate {
    @Override
    protected Expression instantiate(Object oldInstance, Encoder out) {
        return new Expression(oldInstance, Collections.class, "synchronizedList",
                new Object[] { new ArrayList<>() });
    }
    @Override
    protected void initialize(Class<?> type, Object oldInstance, Object newInstance,
            Encoder out) {
        super.initialize(type, oldInstance, newInstance, out);
        List<?> list = (List<?>) oldInstance;
        for (Object item : list) {
            out.writeStatement(new Statement(oldInstance, "add", new Object[] { item }));
        }
    }
}

这个委托将通过传递一个ArrayList<>给Collections.synchronizedList()方法来创建指令来反序列化列表，然后将成员添加到结果List<>对象中。只需在创建XMLEncoder后安装委托。

try (XMLEncoder encoder = new XMLEncoder(System.out)) {
    encoder.setPersistenceDelegate(parents.getClass(), new SynchronizedArrayListPD());
    encoder.writeObject(parents);
}

#setPersistanceDelegate(cls, delegate)需要Class<?>对象。通常，我们会使用像SynchronizedArrayList.class这样的东西，但实际的类不是公共类，所以我们从对象本身抓取实际的类。这不是类型安全的;如果您将parents更改为(例如)一个同步链表，则SynchronizedArrayListPD将用于同步该链表，这是错误的。添加适当的注意事项。

生成的XML编码:

<java version="1.8.0_101" class="java.beans.XMLDecoder">  
<object class="java.util.Collections" method="synchronizedList">  
  <object class="java.util.ArrayList"/>  
  <void method="add">  
   <object class="xml.Test$Parent" id="Test$Parent0">  
    <void property="children">  
     <void method="add">  
      <object class="xml.Test$Child">  
       <void property="parent">  
        <object idref="Test$Parent0"/>  
       </void>  
      </object>  
     </void>  
     <void method="add">  
      <object class="xml.Test$Child">  
       <void property="parent">  
        <object idref="Test$Parent0"/>  
       </void>  
      </object>  
     </void>  
    </void>  
   </object>  
  </void>  
 </object>  
</java>

有关创建持久性委托的更多信息，请参阅XML Encoder文章。

相关内容

最新更新

热门标签：