如何使用XMLEncoder使Arraylist线程安全且可序列化

时间:2014-06-26 13:38:53

标签: java multithreading serialization arraylist xmlencoder

首先:我知道SO中有很多相关的帖子,但我能找到的一个能够帮助我。

所以,我正在做的是我有一个非常简单的父对象,可能有多个子对象。 这两个对象都符合java bean规范(所有变量的no-args构造函数,setter和getter)。

可能有多个父项,它们保存在这样的存储库类中:

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

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

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

通过使用ListXMLEncoder保存到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);
    }
}

一切正常。现在我想向父对象添加一些子对象,只需将新的子对象添加到子List中,然后重新运行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(...)工作将是最优雅的方式)

1 个答案:

答案 0 :(得分:0)

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

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 }));
        }
    }
}

此委托将创建指令以反序列化列表,方法是将Collections.synchronizedList()方法传递给ArrayList<>,然后将成员添加到生成的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文章。