jackson库中空值字段与缺值字段的区分

Question

null

我看到的是一般的注释

@jsoninclude(NON_EMPTY)可用于排除空值。我不能使用此方法，因为我仍然希望在json中看到具有空值的空字段

@jsoninclude(non_excent)可以用来排除空值和“不存在”的值。我不能使用这个，因为我仍然想看到JSON中的空字段和空字段。与JSONInclude(NON_NULL)相同

所以我的问题是，如果我不指定这些属性中的任何一个，我能实现我想要的吗？换句话说，如果我没有指定其中的任何一个，那么Jackson的行为是显示所有在动态意义上具有空值的字段吗？我主要关心的是这里的动态反应。对于每个请求，字段可能存在或不存在。我们必须在json中显示我们在XML中得到的确切信息

Answer 1

如果要区分null值字段和缺省字段，最通用的方法是使用map或JsonNode而不是POJO。POJO类具有常量结构，Map或JsonNode具有动态结构-仅包含您实际放在那里的内容。让我们创建一个简单的应用程序，它从文件中读取XML负载，并创建JSON响应：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

import java.io.File;
import java.util.Map;

public class JsonApp {

    public static void main(String[] args) throws Exception {
        File xmlFile = new File("./resource/test.xml").getAbsoluteFile();

        XmlMapper xmlMapper = new XmlMapper();
        Map map = xmlMapper.readValue(xmlFile, Map.class);

        ObjectMapper jsonMapper = new ObjectMapper();
        String json = jsonMapper.writeValueAsString(map);

        System.out.println(json);
    }
}

现在来看看一些示例，在这些示例中，我们测试将为empty、null和缺省节点生成什么JSON。

输入xml:

<Root>
    <a>A</a>
    <b>1</b>
    <c>
        <c1>Rick</c1>
        <c2>58</c2>
    </c>
</Root>

结果json为：

{"a":"A","b":"1","c":{"c1":"Rick","c2":"58"}}

输入xml:

<Root>
    <a>A</a>
    <c>
        <c1>Rick</c1>
        <c2/>
    </c>
</Root>

{"a":"A","c":{"c1":"Rick","c2":null}}

<Root>
    <c/>
</Root>

输出JSON:

{"c":null}

这种简单而快速的解决方案最大的问题是丢失了原语的类型信息。例如，如果b是integer我们应该在JSON中返回它，作为没有引号的number基元：“字符。要解决这个问题，我们应该使用POJO模型，它允许我们找到所有必需的类型。让我们为示例创建POJO模型：

@JsonFilter("allowedFields")
class Root {
    private String a;
    private Integer b;
    private C c;

    // getters, setters
}

@JsonFilter("allowedFields")
class C {
    private String c1;
    private Integer c2;

    // getters, setters
}

我们需要将简单的xml->map->json算法更改为以下一个：

1. 将JSON读取为map或JsonNode
2. 查找所有字段名
3. 使用找到的名称创建filterprovider-请注意，筛选器使用AllowedFields名称注册，与@JSONFilter批注中使用的名称相同。
4. 将map转换为POJO以获取类型强制。
5. 使用筛选器编写POJO

简单的应用程序可能如下所示：

import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

import java.io.File;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Set;

public class JsonApp {

    public static void main(String[] args) throws Exception {
        File xmlFile = new File("./resource/test.xml").getAbsoluteFile();

        NodesWalker walker = new NodesWalker();

        XmlMapper xmlMapper = new XmlMapper();
        JsonNode root = xmlMapper.readValue(xmlFile, JsonNode.class);
        Set<String> names = walker.findAllNames(root);

        SimpleFilterProvider filterProvider = new SimpleFilterProvider();
        filterProvider.addFilter("allowedFields", SimpleBeanPropertyFilter.filterOutAllExcept(names));

        ObjectMapper jsonMapper = new ObjectMapper();
        jsonMapper.setFilterProvider(filterProvider);

        Root rootConverted = jsonMapper.convertValue(root, Root.class);
        String json = jsonMapper.writeValueAsString(rootConverted);

        System.out.println(json);
    }
}

class NodesWalker {

    public Set<String> findAllNames(JsonNode node) {
        Set<String> names = new HashSet<>();

        LinkedList<JsonNode> nodes = new LinkedList<>();
        nodes.add(node);
        while (nodes.size() > 0) {
            JsonNode first = nodes.removeFirst();
            if (first.isObject()) {
                ObjectNode objectNode = (ObjectNode) first;
                objectNode.fields().forEachRemaining(e -> {
                    names.add(e.getKey());
                    JsonNode value = e.getValue();
                    if (value.isObject() || value.isArray()) {
                        nodes.add(value);
                    }
                });
            } else if (first.isArray()) {
                ArrayNode arrayNode = (ArrayNode) first;
                arrayNode.elements().forEachRemaining(e -> {
                    if (e.isObject() || e.isArray()) {
                        nodes.add(e);
                    }
                });
            }
        }

        return names;
    }
}

输入xml:

<Root>
    <a>A</a>
    <b>1</b>
    <c>
        <c1>Rick</c1>
        <c2>58</c2>
    </c>
</Root>

输出JSON:

{"a":"A","b":1,"c":{"c1":"Rick","c2":58}}

输入xml:

<Root>
    <b>1</b>
    <c>
        <c2/>
    </c>
</Root>

{"b":1,"c":{"c2":null}}

<Root>
    <c/>
</Root>

{"c":null}

我认为在您的示例中最好的解决方案是使用@jsoninclude(NON_NULL)，它将xml端的所有设置字段发送给客户端。null和缺省应在客户端相同地处理。业务逻辑不应依赖于事实字段在JSON有效负载中被设置为null或缺席。

另见：

• JSON中空与空的约定是什么？
• 在JSON中表示null