Как сериализовать DefaultMutableTreeNode (Java) в JSON?

Question

Как я могу сериализовать дерево (реализованное в Java с использованием класса DefaultMutableTreeNode) в JSON (для передачи через метод RESTful в клиент iOS)?

Я пытался:

String jsonString = (new Gson()).toJson(topNode);
// topNode is DefaultMutableTreeNode at the root

Сбой при StackOverflowError.

Answer 1

Это улучшенная альтернатива моему более старому ответу, в котором использовались реализации JsonSerializer и JsonDeserializer для DefaultMutableTreeNode.Документ API этих двух интерфейсов гласит:

Новые приложения должны отдавать предпочтение TypeAdapter, чей API потоковой передачи более эффективен, чем API дерева этого интерфейса.

Поэтому давайте воспользуемся этим предпочтительным подходом и реализуем TypeAdapter для DefaultMutableTreeNode.

Для его использования вы создадите свой экземпляр Gson, подобный этому (вместо простого использования *).1024 *):

Gson gson = new GsonBuilder()
        .registerTypeAdapterFactory(DefaultMutableTreeNodeTypeAdapter.FACTORY)
        .setPrettyPrinting()
        .create();

Приведенное ниже DefaultMutableTreeNodeTypeAdapter отвечает за преобразование DefaultMutableTreeNode в и из JSON.Он пишет / читает свои свойства allowsChildren, userObject и children.Нет необходимости записывать свойство parent, потому что отношения родитель-потомок уже закодированы во вложенной структуре 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;
    }
}

Answer 2

Класс Swing DefaultMutableTreeNode представляет собой древовидную структуру данных, которая содержит экземпляры этого же типа как children, так и parent.Вот почему стандартный сериализатор Gson столкнулся с бесконечной рекурсией и, следовательно, выкинул StackOverflowError.

. Чтобы решить эту проблему, вам нужно настроить Gson с более умным JsonSerializer, специально созданным дляпреобразование DefaultMutableTreeNode в JSON.В качестве бонуса вы также можете предоставить JsonDeserializer для преобразования такого JSON обратно в DefaultMutableTreeNode.

. Для этого создайте свой экземпляр Gson, а не просто new Gson(), но

Gson gson = new GsonBuilder()
        .registerTypeAdapter(DefaultMutableTreeNode.class, new DefaultMutableTreeNodeSerializer())
        .registerTypeAdapter(DefaultMutableTreeNode.class, new DefaultMutableTreeNodeDeserializer())
        .setPrettyPrinting()
        .create();

DefaultMutableTreeNodeSerializer ниже отвечает за преобразование DefaultMutableTreeNode в JSON.Он преобразует свои свойства allowsChildren, userObject и children в JSON.Обратите внимание, что он не преобразует свойство parent в 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.

Он использует ту же идею, что и десериализатор из Как сериализовать / десериализовать DefaultMutableTreeNode с Джексоном? .DefaultMutableTreeNode не очень похож на POJO и поэтому не очень хорошо работает вместе с Gson.Следовательно, он использует хорошо работающий вспомогательный класс POJO (со свойствами allowsChildren, userObject и children) и позволяет Gson десериализовать содержимое JSON в этот класс.Затем объект POJO (и его POJO потомков) преобразуется в объект DefaultMutableTreeNode (с DefaultMutableTreeNode потомками).

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