如何自定义 Jersey JAXB 序列化的 XML 输出

Question

我有一些 @javax.xml.bind.annotation.Xml... 带注释的类，用于 REST Web 服务。 Jersey 设置在 Spring 管理的 Web 容器中，并且 Web 服务返回格式良好的 xml。我们使用 maven-enunciate-plugin 来记录 Web 服务并为返回的 xml 文档创建 xsd。我现在想使用文档 xsd 文件作为返回的 xml 文件中的 schemaLocation，以便 xml 验证不会抱怨缺少定义。如何为此配置 XML 序列化？

Answer 1

如果我没记错的话，我必须做一些事情才能将命名空间标识符正确写入生成的 XML 中。

1) 创建一个 JaxbFactory 来配置并返回一个自定义编组器（顺便说一句，还有解组器）。我省略了下面的吸气剂/和解组设置...

//constructor
public JaxbFactory() throws Exception {
    context = JAXBContext.newInstance(ResourceDto.class);

    // Setup the marshaller
    marshaller = context.createMarshaller();
    marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
    marshaller.setProperty(Marshaller.JAXB_SCHEMA_LOCATION, XmlMetadataConstants.XML_SCHEMA_LOCATION);  // this schema location is used in generating the schema-location property in the xml
}

2) 该工厂类对 Jersey 来说是“不可见的”。为了使其可见，我创建了一个 MarshallerProvider。看起来像这样：

@Provider
public class ResourceJaxbMarshallerProvider implements ContextResolver<Marshaller> {
// injected by Spring
private ResourceJaxbFactory ResourceJaxbFactory;
private ResourceStatusJaxbFactory ResourceStatusJaxbFactory;


/*
 * ----------------------------------------
 * Setters (for Spring injected properties)
 * ----------------------------------------
 */
public void setResourceJaxbFactory(ResourceJaxbFactory ResourceJaxbFactory) {
    this.ResourceJaxbFactory = ResourceJaxbFactory;
}

public void setResourceStatusJaxbFactory(ResourceStatusJaxbFactory ResourceStatusJaxbFactory) {
    this.ResourceStatusJaxbFactory = ResourceStatusJaxbFactory;
}

/*
 * ------------------------
 * Interface Implementation
 * ------------------------
 */
public Marshaller getContext(Class<?> type) {
    if (type == ResourceDto.class)
        return ResourceJaxbFactory.getMarshaller();
    else if (type == ResourceStatusDto.class)
        return ResourceStatusJaxbFactory.getMarshaller();
    else
        return null;
}       
}

我已经使用 Jersey/Spring Servlet 将 Jersey 连接到 Spring，因此由 Spring 创建的任何 @Provider 类都会被 Jersey 自动识别。在我的 Spring applicationContext.xml 中，我所要做的就是实例化资源提供程序。反过来，它会从工厂中获取编组器。

3）我发现另一件至关重要的事情是我必须在包含我的资源的根包中创建一个 package-info.java 文件。看起来像这样：

/*
 * Note that this file is critical for ensuring that our ResourceDto object is
 * marshalled/unmarshalled with the correct namespace.  Without this, marshalled
 * classes produce XML files without a namespace identifier
 */
@XmlSchema(namespace = XmlMetadataConstants.XML_SCHEMA_NAMESPACE, elementFormDefault = XmlNsForm.QUALIFIED) 
package com.yourcompany.resource;

import javax.xml.bind.annotation.XmlNsForm;

---

至少我认为这就是我需要做的一切，我无法记住每一件作品。我确实记得 package-info.java 部分是使所有内容组合在一起的最后一个关键齿轮。

希望有帮助。我花了太多时间挖掘这一切的信息。在我希望 Jersey 进行正确的 xml 模式验证（以及针对模式无效输入的正确错误报告）之前，Jersey 非常简单。一旦我开始沿着这条路走下去，泽西岛就从简单的脑死亡变得相当困难。大部分困难在于从网上各种帖子中找出所有细节。希望这能帮助您走得更远、更快。 :-)