使用 JAXB 解组/编组列表<String>

Question

我正在尝试创建一个非常简单的 REST 服务器。 我只有一个返回字符串列表的测试方法。 这是代码：

@GET
@Path("/test2")
public List test2(){
    List list=new Vector();
    list.add("a");
    list.add("b");
    return list;
}

它给出了以下错误：

SEVERE: A message body writer for Java type,
class java.util.Vector, and MIME media type,
application/octet-stream, was not found

我希望 JAXB 对 String、Integer 等简单类型有一个默认设置。我猜不是。 这是我想象的：

<Strings>
  <String>a</String>
  <String>b</String>
</Strings>

使这种方法起作用的最简单方法是什么？

Answer 1

我使用了@LiorH 的示例并将其扩展为：

@XmlRootElement(name="List")
public class JaxbList<T>{
    protected List<T> list;

    public JaxbList(){}

    public JaxbList(List<T> list){
        this.list=list;
    }

    @XmlElement(name="Item")
    public List<T> getList(){
        return list;
    }
}

请注意，它使用泛型，因此您可以将它与 String 之外的其他类一起使用。 现在，应用程序代码很简单：

    @GET
    @Path("/test2")
    public JaxbList test2(){
        List list=new Vector();
        list.add("a");
        list.add("b");
        return new JaxbList(list);
    }

为什么 JAXB 包中不存在这个简单的类？ 有人在其他地方看到类似的东西吗？

Answer 2

@GET
@Path("/test2")
public Response test2(){
   List<String> list=new Vector<String>();
   list.add("a");
   list.add("b");

   final GenericEntity<List<String>> entity = new GenericEntity<List<String>>(list) { };
   return Response.ok().entity(entity).build();
}

Answer 3

如果你们中的任何人想要为包含多个类的元素的列表编写一个列表包装器，并且想要根据 Class 类型给出一个单独的 XmlElement 名称而不编写 X Wrapper 类，则可以使用@XmlMixed注释。 通过这样做，JAXB 根​​据@XmlRootElement设置的值命名列表中的项目。 这样做时，您必须使用@XmlSeeAlso指定哪些类可能在列表中

例子：

列表中可能的类

@XmlRootElement(name="user")
public class User {/*...*/}

@XmlRootElement(name="entry")
public class LogEntry {/*...*/}

包装类

@XmlRootElement(name="records")
@XmlSeeAlso({User.class, LogEntry.class})
public static class JaxbList<T>{

    protected List<T> records;

    public JaxbList(){}

    public JaxbList(List<T> list){
        this.records=list;
    }

    @XmlMixed 
    public List<T> getRecords(){
        return records;
    }
}

例子：

List l = new List();
l.add(new User("userA"));
l.add(new LogEntry(new UserB()));


XStream xStream = new XStream();
String result = xStream.toXML(l);

结果：

<records>
    <user>...</user>
    <entry>...</entry>
</records>

或者，您可以使用@XmlElementRef注释直接在包装类中指定 XmlElement 名称

@XmlRootElement(name="records")
@XmlSeeAlso({User.class, LogEntry.class})
public static class JaxbList<T>{

    protected List<T> records;

    public JaxbList(){}

    public JaxbList(List<T> list){
        this.records=list;
    }

    @XmlElementRefs({
        @XmlElementRef(name="item", type=Object.class),
        @XmlElementRef(name="user", type=User.class),
        @XmlElementRef(name="entry", type=LogEntry.class)
    })
    public List<T> getRecords(){
        return records;
    }
}

Answer 4

从个人博客文章来看，没有必要创建特定的JaxbList < T >对象。

假设一个带有字符串列表的对象：

@XmlRootElement
public class ObjectWithList {

    private List<String> list;

    @XmlElementWrapper(name="MyList")
    @XmlElement
    public List<String> getList() {
        return list;
    }

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

}

JAXB 往返：

public static void simpleExample() throws JAXBException {

    List<String> l = new ArrayList<String>();
    l.add("Somewhere");
    l.add("This and that");
    l.add("Something");

    // Object with list
    ObjectWithList owl = new ObjectWithList();
    owl.setList(l);

    JAXBContext jc = JAXBContext.newInstance(ObjectWithList.class);
    ObjectWithList retr = marshallUnmarshall(owl, jc);

    for (String s : retr.getList()) {
        System.out.println(s);
    } System.out.println(" ");

}

产生以下内容：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectWithList>
    <MyList>
        <list>Somewhere</list>
        <list>This and that</list>
        <list>Something</list>
    </MyList>
</objectWithList>

Answer 5

使用出色的XStream库可以更轻松地完成此操作。 没有包装，没有注释。

目标 XML

<Strings>
  <String>a</String>
  <String>b</String>
</Strings>

序列化

（ String别名可以通过使用小写string标签来避免，但我使用了 OP 的代码）

List <String> list = new ArrayList <String>();
list.add("a");
list.add("b");

XStream xStream = new XStream();
xStream.alias("Strings", List.class);
xStream.alias("String", String.class);
String result = xStream.toXML(list);

反序列化

反序列化为 ArrayList

XStream xStream = new XStream();
xStream.alias("Strings", ArrayList.class);
xStream.alias("String", String.class);
xStream.addImplicitArray(ArrayList.class, "elementData");
List <String> result = (List <String>)xStream.fromXML(file);

反序列化为 String[]

XStream xStream = new XStream();
xStream.alias("Strings", String[].class);
xStream.alias("String", String.class);
String[] result = (String[])xStream.fromXML(file);

请注意，XStream 实例是线程安全的，可以预先配置，将代码量缩减为单行。

XStream 也可以用作 JAX-RS 服务的默认序列化机制。 在泽西岛插入 XStream 的示例可以在这里找到

Answer 6

我遇到过几次这种模式，我发现最简单的方法是使用 JaxB 注释定义一个内部类。 （无论如何，您可能想要定义根标签名称）

所以你的代码看起来像这样

@GET
@Path("/test2")
public Object test2(){
   MyResourceWrapper wrapper = new MyResourceWrapper();
   wrapper .add("a");
   wrapper .add("b");
   return wrapper ;
}

@XmlRootElement(name="MyResource")
private static class MyResourceWrapper {
       @XmlElement(name="Item")
       List<String> list=new ArrayList<String>();
       MyResourceWrapper (){}

       public void add(String s){ list.add(s);}
 }

如果您使用 javax.rs (jax-rs)，我将返回 Response 对象，并将包装器设置为其实体

Answer 7

最后，我使用JacksonJaxbJsonProvider解决了它需要在 Spring context.xml和 Maven pom.xml中进行一些更改

在您的 Spring context.xml中，将JacksonJaxbJsonProvider添加到<jaxrs:server> ：

<jaxrs:server id="restService" address="/resource">
    <jaxrs:providers>
        <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"/>
    </jaxrs:providers>
</jaxrs:server>

在你的 Maven pom.xml 添加：

<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-jaxrs</artifactId>
    <version>1.9.0</version>
</dependency>

Answer 8

User1 的示例对我来说效果很好。 但是，作为警告，除了简单的 String/Integer 类型之外，它不能用于任何其他类型，除非您添加 @XmlSeeAlso 注释：

@XmlRootElement(name = "List")
@XmlSeeAlso(MovieTicket.class)
public class MovieTicketList {
    protected List<MovieTicket> list;

这可以正常工作，尽管它阻止我在整个应用程序中使用单个通用列表类。 这也可以解释为什么 JAXB 包中不存在这个看似显而易见的类。

Answer 9

确保使用 JaxbList 中使用的特定类添加 @XmlSeeAlso 标记。 这很重要，否则它会抛出 HttpMessageNotWritableException

Answer 10

如果我早点找到Resteasy Jackson Provider ，我会节省时间。

只需添加Resteasy Jackson Provider JAR 。 没有实体包装器。 没有 XML 注释。 没有自定义消息正文作者。

Answer 11

如果您在 jersey 项目中使用 maven，请在 pom.xml 中添加以下内容并更新项目依赖项，以便 Jaxb 能够检测模型类并将列表转换为媒体类型应用程序 XML：

<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-core</artifactId>
    <version>2.2.11</version>
</dependency>

Answer 12

对于更通用的解决方案，对于任何顶级列表的 JAXB-XML 序列化，只需要编写 1 个新类，请查看此问题中给出的解决方案：

是否可以以编程方式配置 JAXB？

public class Wrapper<T> {

private List<T> items = new ArrayList<T>();

@XmlAnyElement(lax=true)
public List<T> getItems() {
    return items;
}

}

//JAXBContext is thread safe and so create it in constructor or 
//setter or wherever:
... 
JAXBContext jc = JAXBContext.newInstance(Wrapper.class, clazz);
... 

public String marshal(List<T> things, Class clazz) {

  //configure JAXB and marshaller     
  Marshaller m = jc.createMarshaller();
  m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

  //Create wrapper based on generic list of objects
  Wrapper<T> wrapper = new Wrapper<T>(things);
  JAXBElement<Wrapper> wrapperJAXBElement = new JAXBElement<Wrapper>(new QName(clazz.getSimpleName().toLowerCase()+"s"), Wrapper.class, wrapper);

  StringWriter result = new StringWriter();
  //marshal!
  m.marshal(wrapperJAXBElement, result);

  return result.toString();

}