如何将树(使用 DefaultMutableTreeNode
类在 Java 中实现)序列化为 JSON(用于通过 RESTful 方法传输到 iOS 客户端)?
我试过:
String jsonString = (new Gson()).toJson(topNode);
// topNode is DefaultMutableTreeNode at the root
它崩溃了,出现了StackOverflowError
。
Swing的DefaultMutableTreeNode
类是一个类似于树的数据结构,它包含与子级
和父级
同一类型的实例。这就是为什么Gson的默认序列化程序遇到无限递归,因此抛出了一个<code>StackOverflowError</code>。
要解决此问题,您需要使用专门为将DefaultMutableTreeNode
转换为JSON而设计的更智能的JsonSerializer
自定义Gson
。另外,您可能还希望提供一个<code>JsonDeserializer</code>,用于将此类JSON转换回<code>DefaultMutableTreeNode</code<。
为此,不仅通过newGson()
,而且通过
Gson gson = new GsonBuilder()
.registerTypeAdapter(DefaultMutableTreeNode.class, new DefaultMutableTreeNodeSerializer())
.registerTypeAdapter(DefaultMutableTreeNode.class, new DefaultMutableTreeNodeDeserializer())
.setPrettyPrinting()
.create();
下面的DefaultMutableTreeNodeSerializer
负责将DefaultMutabbleTreeNode
转换为JSON。它将其财产allowsChildren
、userObject
和children
转换为JSON。注意,它不会将<code>父</code>属性转换为JSON,因为这样做会再次产生无限递归。
public class DefaultMutableTreeNodeSerializer implements JsonSerializer<DefaultMutableTreeNode> {
@Override
public JsonElement serialize(DefaultMutableTreeNode src, Type typeOfSrc, JsonSerializationContext context) {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("allowsChildren", src.getAllowsChildren());
jsonObject.add("userObject", context.serialize(src.getUserObject()));
if (src.getChildCount() > 0) {
jsonObject.add("children", context.serialize(Collections.list(src.children())));
}
return jsonObject;
}
}
为了进行测试,让我们将示例 JTree
的根节点序列化为 JSON,然后再次反序列化。
JTree tree = new JTree(); // create a sample tree
Object topNode = tree.getModel().getRoot(); // a DefaultMutableTreeNode
String jsonString = gson.toJson(topNode);
System.out.println(jsonString);
DefaultMutableTreeNode topNode2 = gson.fromJson(jsonString, DefaultMutableTreeNode.class);
它生成以下JSON输出:
{
"allowsChildren": true,
"userObject": "JTree",
"children": [
{
"allowsChildren": true,
"userObject": "colors",
"children": [
{
"allowsChildren": true,
"userObject": "blue"
},
{
"allowsChildren": true,
"userObject": "violet"
},
{
"allowsChildren": true,
"userObject": "red"
},
{
"allowsChildren": true,
"userObject": "yellow"
}
]
},
{
"allowsChildren": true,
"userObject": "sports",
"children": [
{
"allowsChildren": true,
"userObject": "basketball"
},
{
"allowsChildren": true,
"userObject": "soccer"
},
{
"allowsChildren": true,
"userObject": "football"
},
{
"allowsChildren": true,
"userObject": "hockey"
}
]
},
{
"allowsChildren": true,
"userObject": "food",
"children": [
{
"allowsChildren": true,
"userObject": "hot dogs"
},
{
"allowsChildren": true,
"userObject": "pizza"
},
{
"allowsChildren": true,
"userObject": "ravioli"
},
{
"allowsChildren": true,
"userObject": "bananas"
}
]
}
]
}
下面的DefaultMutableTreeNodeDeserializer
负责将JSON转换回DefaultMutableTreeNode
。
它使用了与How to serialize/deserialize a DefaultMutableTreeNode with Jackson?中的反序列化程序相同的思想?。DefaultMutableTreeNode
不太像POJO,因此不能与Gson一起工作。因此,它使用了一个行为良好的POJO
帮助器类(具有财产allowsChildren
、userObject
children),并让Gson将JSON内容反序列化到这个类中。然后,POJO
对象(及其POJO
children)被转换为DefaultMutableTreeNode
子对象(具有DefaultMutabbleTreeNode
子对象)。
public class DefaultMutableTreeNodeDeserializer implements JsonDeserializer<DefaultMutableTreeNode> {
@Override
public DefaultMutableTreeNode deserialize(JsonElement json, Type type, JsonDeserializationContext context) {
return context.<POJO>deserialize(json, POJO.class).toDefaultMutableTreeNode();
}
private static class POJO {
private boolean allowsChildren;
private Object userObject;
private List<POJO> children;
// no need for: POJO parent
public DefaultMutableTreeNode toDefaultMutableTreeNode() {
DefaultMutableTreeNode node = new DefaultMutableTreeNode();
node.setAllowsChildren(allowsChildren);
node.setUserObject(userObject);
if (children != null) {
for (POJO child : children) {
node.add(child.toDefaultMutableTreeNode()); // recursion!
// this did also set the parent of the child-node
}
}
return node;
}
// Following setters needed by Gson's deserialization:
public void setAllowsChildren(boolean allowsChildren) {
this.allowsChildren = allowsChildren;
}
public void setUserObject(Object userObject) {
this.userObject = userObject;
}
public void setChildren(List<POJO> children) {
this.children = children;
}
}
}
这是对我以前的答案的一个改进的替代方案,该答案使用JsonSerializer
和JRsonDeserializer
实现DefaultMutableTreeNode
。这两个接口的API文档表示:
新的应用程序应该更喜欢TypeAdapter
,它的流API比这个接口的树API更高效。
因此,让我们使用这种首选方法,并为< code > DefaultMutableTreeNode 实现一个< code>TypeAdapter。
为了使用它,您可以像这样创建Gson
实例(而不是只使用newGson()
):
Gson gson = new GsonBuilder()
.registerTypeAdapterFactory(DefaultMutableTreeNodeTypeAdapter.FACTORY)
.setPrettyPrinting()
.create();
下面的DefaultMutableTreeNodeTypeAdapter
负责将一个DefaultMutableTreeNode
与JSON进行转换。它写入/读取其属性lowsKids
、userObject
和儿童
。不需要写入父
属性,因为父子关系已经编码在JSON输出的嵌套结构中。
public class DefaultMutableTreeNodeTypeAdapter extends TypeAdapter<DefaultMutableTreeNode> {
public static final TypeAdapterFactory FACTORY = new TypeAdapterFactory() {
@Override
@SuppressWarnings("unchecked") // we use a runtime check to make sure the 'T's equal
public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
if (type.getRawType() == DefaultMutableTreeNode.class) {
return (TypeAdapter<T>) new DefaultMutableTreeNodeTypeAdapter(gson);
}
return null;
}
};
private final Gson gson;
private DefaultMutableTreeNodeTypeAdapter(Gson gson) {
this.gson = gson;
}
@Override
public void write(JsonWriter out, DefaultMutableTreeNode node) throws IOException {
out.beginObject();
out.name("allowsChildren");
out.value(node.getAllowsChildren());
out.name("userObject");
gson.toJson(node.getUserObject(), Object.class, out);
if (node.getChildCount() > 0) {
out.name("children");
gson.toJson(Collections.list(node.children()), List.class, out); // recursion!
}
// No need to write node.getParent(), it would lead to infinite recursion.
out.endObject();
}
@Override
public DefaultMutableTreeNode read(JsonReader in) throws IOException {
in.beginObject();
DefaultMutableTreeNode node = new DefaultMutableTreeNode();
while (in.hasNext()) {
switch (in.nextName()) {
case "allowsChildren":
node.setAllowsChildren(in.nextBoolean());
break;
case "userObject":
node.setUserObject(gson.fromJson(in, Object.class));
break;
case "children":
in.beginArray();
while (in.hasNext()) {
node.add(read(in)); // recursion!
// this did also set the parent of the child-node
}
in.endArray();
break;
default:
in.skipValue();
break;
}
}
in.endObject();
return node;
}
}