使用类名作为 JSON Jackson 序列化的根键

Question

假设我有一个 pojo：

import org.codehaus.jackson.map.*;

public class MyPojo {
    int id;
    public int getId()
    { return this.id; }

    public void setId(int id)
    { this.id = id; }

    public static void main(String[] args) throws Exception {
        MyPojo mp = new MyPojo();
        mp.setId(4);
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
        System.out.println(mapper.getSerializationConfig().isEnabled(SerializationConfig.Feature.WRAP_ROOT_VALUE));
        System.out.println(mapper.writeValueAsString(mp));
    }
}

当我使用 Jackson ObjectMapper 进行序列化时，我只是得到，

true
{"id":4}

但我希望

true
{"MyPojo":{"id":4}}

我已经搜索过了，Jackson 的文档确实没有组织，而且大多已经过时。

Answer 1

通过在类级别添加 jackson 注释 @JsonTypeInfo，您可以获得预期的输出。我刚刚在你的班级中添加了没有任何变化的内容。

package com.test.jackson;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;

@JsonTypeInfo(include=As.WRAPPER_OBJECT, use=Id.NAME)
public class MyPojo {
    // Remain same as you have
}

输出：

{
    "MyPojo": {
        "id": 4
    }
}

Answer 2

我没有使用杰克逊，但搜索我发现这个配置似乎正是您想要的： WRAP_ROOT_VALUE

可以启用将根值（通常是 JSON 对象，但可以是任何类型）包装在单个属性 JSON 对象中的功能，其中 key 作为“根名称”，由注释内省器确定（特别是对于 JAXB 而言）使用@XmlRootElement.name）或后备（非限定类名）。该功能主要用于 JAXB 兼容性。

默认设置为 false，表示 root
值未包装。

这样您就可以配置映射器：

objectMapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);

我希望它可以帮助您......

Answer 3

以下是实现此目的的方法

Map<String, MyPojo> singletonMap = Collections.singletonMap("mypojo", mp);
System.out.println(mapper.writeValueAsString(singletonMap));

输出
{ "mypojo" : { "id" : 4}}

这里的优点是我们可以为 json 对象的根键指定我们的 on 名称。通过上面的代码，mypojo 将成为根键。当我们使用像 Mustache.js 这样的 Java 脚本模板来迭代 json 对象时，这种方法将非常有用

Answer 4

要实现此目的，您需要在类上使用 JsonTypeInfo 注释，特别是 WRAPPER_OBJECT

@JsonTypeName("foo")                                                                                         
@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT ,use = JsonTypeInfo.Id.NAME)

public class Bar(){
)

Answer 5

对此还有一个很好的注释：

@JsonRootName(value = "my_pojo")
public class MyPojo{
  ...
}

将生成：

{
  "my_pojo" : {...}
}

Answer 6

最简单的解决方案怎么样？只需使用像这样的包装类：

class Wrapper {
   public MyPojo MyPojo;
}

并在代码中包装/展开？

除此之外，了解为什么您需要像这样的额外 json 对象条目会有所帮助？我知道这是通过 xml api 模拟 json 的库完成的（由于 xml 和 json 之间的阻抗，由于从 xml 到 json 的转换），但对于纯 json 解决方案，通常不需要它。

它是为了让你弄清楚实际类型是什么吗？
如果是这样，也许您可​​以考虑启用多态类型信息，让 Jackson 自动处理它？ （有关详细信息，请参阅 1.5 发行说明，PTH 条目）。

Answer 7

我用过另一种方法，它对我有用。
我正在使用第三方 jar，因此我无法控制注释。
所以我不得不通过一些技巧来写。

覆盖：org.codehaus.jackson.map.ser.BeanSerializerFactory.findBeanProperties(SerializationConfig, BasicBeanDescription)

添加您的属性，如下所示

List<BeanPropertyWriter> props = super.findBeanProperties(config, beanDesc);
BeanPropertyWriter bpw = null;
try {
     Class cc = beanDesc.getType().getRawClass();
     Method m = cc.getMethod("getClass", null);
     bpw = new BeanPropertyWriter("$className", null, null, m, null,true, null);
} catch (SecurityException e) {
  // TODO
} catch (NoSuchMethodException e) {
  // TODO
}
props.add(bpw);
return props;

这样我可以获得更多控制权，也可以执行其他类型的过滤器。

Answer 8

@JsonTypeInfo(include=As.WRAPPER_OBJECT, use=Id.NAME) 

正如 Arun Prakash 所建议的，这个注释工作得很好。我试图以这种形式获取 json:

{"Rowset":{"ROW":{"receiptno":"881604199388936","status":"SUCCESS"}}}

但得到这样的:

{"ROW":{"receiptno":"881604199388936","status":"SUCCESS"}}

现在注释解决了我的问题。

Answer 9

我有兴趣听到OP对此的解决方案。我遇到了类似的问题，我的 RESTful Web 服务将对象序列化为客户端的 XML 或 JSON。 Javascript 客户端需要知道包装类型以便能够解析它。将类型耦合到 URI 模式并不是一种选择。

谢谢。

编辑：我注意到 Spring MappingJacksonJsonMarshaller 在编组时添加了包装类，因此我在调试中单步执行代码，并注意到 Spring 传入带有单个键值对的 HashMap，其中键是包装名称，值是目的。因此，我扩展了 JacksonJaxbJsonProvider，重写了 writeTo() 方法并添加了以下内容：

HashMap<String, Object> map = new HashMap<String, Object>();
map.put(value.getClass().getSimpleName(), value);
super.writeTo(map, type, genericType, annotations, mediaType, httpHeaders,entityStream);

这有点像黑客，但效果很好。

Answer 10

使用 withRootName。

objectMapper.writer().withRootName(MyPojo.class.getName());

Answer 11

我通过经验发现，所有 JSON 都包含后端类型（作为字符串）和用于在前端渲染它的组件类型（如果使用 Angular 或 Vue 之类的东西）是一个好主意。

这样做的理由是，您可以使用一组代码处理各种类型。

例如，在 vue 中，在数据中包含 UI 组件的名称，除其他外，您可以仅使用父模板中的单个标签来让屏幕呈现不同类型的子组件列表。

  <component :is="child.componentType"/>.

对于后端系统和 Web 服务 - 我更喜欢使用单个 Web 服务处理器类，它通过根据传入的有效负载查找适当的处理器类来为所有 Web 服务提供日志记录、审核和异常处理。这使得我的所有 Web 服务的实现看起来完全相同（大约 3 行代码），并且我可以通过调用的生命周期获取详细的事件日志记录，而无需编写任何每个服务代码来执行此操作。

使用包装 JSON 的类型使其能够自我记录。如果您看到的只是属性，那么在找到相应的端点之前，您不知道自己在看什么。

如果您想编写数据驱动的软件，那么能够识别您正在处理的内容是一个基本要求。