是否可以让Jackson ObjectMapper遵循Spring Boot应用程序中的JAXB XML注释?

时间:2018-08-30 14:27:52

标签: java xml spring-boot jackson jaxb

使用 ObjectMapper的{​​{3}}应用程序,我正在使用以下模式将List字段很好地序列化:

@JacksonXmlProperty(localName = "item")
@JacksonXmlElementWrapper(useWrapping = true, localName = "items")    
private List<Item> items;

所以得到类似的东西:

<items>
   <item>...</item>
   <item>...</item>
   ...
</items>

我(没有运气)研究了如何使用@XmlElementWrapper之类的注释来实现这一目标。

例如-我可以用JacksonConfiguration做些什么吗?

更新

添加

objectMapper.registerModule(new JaxbAnnotationModule());

Spring JacksonConfiguration并像这样注释:

@XmlElementWrapper
@XmlElement(name="item")
private List<Item> items;

不能按预期工作。我目前正在研究是否可以像

那样用GSON替换Jackson。

我真的很想使注解内容具有通用性,而不只是this post特定,或者喜欢为每个序列化程序实现添加注解。

1 个答案:

答案 0 :(得分:0)

我还没有尝试过jackson-dataformat-xml / JaxbAnnotationModule,并且不确定它是否与spring-boot兼容(如果有的话,您应该写回去),但是值得测试。

更新

这里是测试(使用上面的链接)

import java.io.IOException;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import com.fasterxml.jackson.module.jaxb.JaxbAnnotationModule;



public class TestJacksonWithJaxbAnnot {

    static ObjectMapper objectMapper = new ObjectMapper();

    static  {
        objectMapper.registerModule(new JaxbAnnotationModule());
    }

    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlRootElement(name = "item")
    static class Item {
        @XmlElement
        int id;
        @XmlElement
        String name;

        //getters, setters, etc.
    }

    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlRootElement(name = "itemcollection")
    static class ItemCollection {
        @XmlElement
        String nameOfItems;
        @XmlElement
        List<Item> items;

        //getters, setters, etc.
}

    public static void main(String[] args) throws XMLStreamException, IOException {
        ItemCollection testColl = new ItemCollection();
        testColl.nameOfItems = "Test items";
        Item item1 = new Item();
        item1.id = 1;
        item1.name = "apple";
        Item item2 = new Item();
        item2.id = 2;
        item2.name = "orange";
        testColl.items = Arrays.asList(item1, item2);

        StringWriter stringWriter = new StringWriter();
        XMLOutputFactory xmlOutputFactory = XMLOutputFactory.newInstance();
        XMLStreamWriter sw =     xmlOutputFactory.createXMLStreamWriter(stringWriter);
        XmlMapper mapper = new XmlMapper();

        sw.writeStartDocument();
        sw.writeStartElement("root");

        mapper.writeValue(sw, testColl);

        sw.writeComment("Some insightful commentary here");
        sw.writeEndElement();
        sw.writeEndDocument();
        System.out.println(stringWriter.toString());
    }
}

输出:

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <ItemCollection>
      <nameOfItems>Test items</nameOfItems>
      <items>
         <items>
            <id>1</id>
            <name>apple</name>
         </items>
         <items>
            <id>2</id>
            <name>orange</name>
         </items>
      </items>
   </ItemCollection>
   <!--Some insightful commentary here-->
</root>

如您所见,它并不完美,例如它没有处理@XmlRootElement批注中的已定义名称。 (在我的1.5.10.RELEASE春季启动项目中进行了测试,其中jackson-dataformat-xml具有2.8.10托管版本)。

也许使用更高版本,您将获得更好的输出。