如何使用 Jackson 在 JSON 序列化中重命名根密钥

json java root jackson

2022-09-01 09:23:45

我正在使用Jackson对对象列表进行JSON序列化。

这是我得到的：

{"ArrayList":[{"id":1,"name":"test name"}]}

但我想要这个：

{"rootname":[{"id":1,"name":"test name"}]} // ie showing the string I want as the root name.

以下是我的方法：

接口：

public interface MyInterface {
    public long getId();
    public String getName();
}

实现类：

@JsonRootName(value = "rootname")
public class MyImpl implements MyInterface {
    private final long id;
    private String name;

    public MyImpl(final long id,final name) {
        this.id = id;
        this.name = name;
    }

   // getters     
}

JSon 序列化：

public class MySerializer {
    public static String serializeList(final List<MyInterface> lists) {
        //check for null value.Throw Exception
        final ObjectMapper mapper = new ObjectMapper();
        mapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
        return mapper.writeValueAsString(lists);
    }
}

测试：

final List<MyInterface> list = new ArrayList<MyImpl>();
MyImpl item = new MyImpl(1L,"test name");
list.add(item);
final String json = MySerializer.serializeList(list);
System.out.println(json);

这是我得到的：

{"ArrayList":[{"id":1,"name":"test name"}]}

但我想要这个：

{"rootname":[{"id":1,"name":"test name"}]} // ie showing the string I want as the root     name.

我已经尝试了所有我能找到的建议解决方案，但未能实现我的目标。我看过：

还是我错过了什么？我使用杰克逊1.9.12。欢迎在这方面提供任何帮助。

答案 1

好吧，默认情况下，Jackson在尝试确定要为包装值显示的根名称时会使用以下两个注释之一 - @XmlRootElement或@JsonRootName。它期望此批注位于正在序列化的类型上，否则它将使用该类型的简单名称作为根名称。

在本例中，您正在序列化列表，这就是为什么根名称是“ArrayList”（正在序列化的类型的简单名称）的原因。列表中的每个元素都可能属于用@JsonRootName注释的类型，但列表本身不是。

当您尝试包装的根值是一个集合时，您需要某种方法来定义包装名称：

支架/包装类

您可以创建一个包装类来保存列表，并使用注释来定义所需的属性名称（只有在没有直接控制 ObjectMapper/JSON 转换过程时才需要使用此方法）：

class MyInterfaceList {
    @JsonProperty("rootname")
    private List<MyInterface> list;

    public List<MyInterface> getList() {
        return list;
    }

    public void setList(List<MyInterface> list) {
        this.list = list;
    }
}

final List<MyInterface> lists = new ArrayList<MyInterface>(4);
lists.add(new MyImpl(1L, "test name"));
MyInterfaceList listHolder = new MyInterfaceList();
listHolder.setList(lists);
final String json = mapper.writeValueAsString(listHolder);

对象编写器

这是首选选项。使用已配置的 ObjectWriter 实例生成 JSON。特别是，我们对withRootName方法感兴趣：

final List<MyInterface> lists = new ArrayList<MyInterface>(4);
lists.add(new MyImpl(1L, "test name"));
final ObjectWriter writer = mapper.writer().withRootName("rootName");
final String json = writer.writeValueAsString(lists);

答案 2

我知道，我迟到了，但我有更好的方法，不需要Holder/Wrapper Class。它从注释中选取根键。

package com.test;

import com.fasterxml.jackson.annotation.JsonRootName;


@JsonRootName("Products")
public class ProductDTO {
    private String name;
    private String description;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

这是测试类：-

package com.test;

import java.io.IOException;
import java.util.ArrayList;

import org.junit.Test;

import com.fasterxml.jackson.annotation.JsonRootName;
import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;


public class ProductDTOTestCase {
    @Test
    public void testPersistAndFindById() throws JsonGenerationException, JsonMappingException, IOException {
        ObjectMapper mapper = new ObjectMapper();
        ProductDTO productDTO = new ProductDTO();
        productDTO.setDescription("Product 4 - Test");

        ArrayList<ProductDTO> arrayList = new ArrayList<ProductDTO>();
        arrayList.add(productDTO);

        String rootName = ProductDTO.class.getAnnotation(JsonRootName.class).value();
        System.out.println(mapper.writer().withRootName(rootName).writeValueAsString(arrayList));

    }


}

它将给出以下输出

{"Products":[{"name":null,"description":"Product 4 - Test"}]}