使用 Spring 配置 CXF 以使用 MOXY 进行 XML 编组/解组

Question

我有一个 Java 服务器应用程序，它使用 CXF 提供 SOAP 和 REST Web 服务。目前，它使用 JAX-B 的参考实现进行 XML 编组/解组，但我已将其配置为用 Jackson 替换 Jettison 进行 JSON 编组/解组。我使用 Spring 进行 DI 和应用程序上下文配置。

REST Web 服务配置片段如下所示：

web.xml

<servlet>
    <display-name>Myapp REST Services</display-name>
    <servlet-name>MyappWebServices</servlet-name>
    <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>MyappWebServices</servlet-name>
    <url-pattern>/services/*</url-pattern>
</servlet-mapping>

applicationContext.xml

<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

<bean id="jsonProvider" class="org.codehaus.jackson.jaxrs.JacksonJsonProvider" />

<jaxrs:server id="myappCoreSvcRest" address="/rest">
    <jaxrs:serviceBeans>
        <ref bean="fooService" />
        <ref bean="barService" />
    </jaxrs:serviceBeans>

    <jaxrs:providers>
        <ref bean="jsonProvider" />
    </jaxrs:providers>
</jaxrs:server>

此配置有效，并将根据 HTTP Accept 标头返回 XML 或 JSON。我喜欢这个配置的原因是它基于 Spring，并且创建和使用备用 JSON 编码器非常容易。有关配置 CXF 的详细信息，请参阅此处。

我的问题是，现在我要提供一个新的（附加的）REST Web 服务，并且我想为这个新的 Web 服务使用不同的 JAX-B XML 绑定。我知道 MOXy 可以做到这一点，但我无法弄清楚如何配置 CXF 端点，以便它将使用 MOXy 进行编组/解组（以及如何告诉 Moxy 我的自定义 XML 映射文件）。我还希望这个新的 Web 服务根据 Accept 标头返回 XML 或 JSON。我还读到 MOXy 2.4+ 也可以处理这个问题！

理想情况下，我可以将 MOXy 用于这个新端点，而不会影响其他现有的 servlet。

Answer 1

注意：我是EclipseLink JAXB (MOXy) 的领导者和 JAXB 的成员(JSR-222)专家组。

---

我暂时不知道 CXF 的确切配置，但下面我提供了一些将 MOXy 与 Spring 结合使用的链接。请随时联系我，我可以帮助你实现这个：

• http://blog.bdoughan.com/p/contact_01.html

我的问题是，现在我有一个新的（附加的）REST Web 服务
提供，我想为此使用不同的 JAX-B XML 绑定
新的网络服务。我知道 MOXy 可以做到这一点，但我做不到
了解如何配置 CXF 端点以便它将使用
MOXy 用于编组/解编组（以及如何告诉 Moxy
关于我的自定义 XML 映射文件）。

将 MOXy 与 JAX-RS 实现结合使用时，您可以使用 ContextResolver 从 MOXy 的外部映射文件引导：

package blog.bindingfile.jaxrs;

import java.io.*;
import java.util.*;
import javax.ws.rs.Produces;
import javax.ws.rs.ext.*;
import javax.xml.bind.*;     
import org.eclipse.persistence.jaxb.JAXBContextFactory;

import blog.bindingfile.Customer;

@Provider
@Produces({"application/xml", "application/json"})
public class CustomerContextResolver implements ContextResolver<JAXBContext> {

    private JAXBContext jc;

    public CustomerContextResolver() {
        ClassLoader cl = Customer.class.getClassLoader();
        InputStream bindings =
            cl.getResourceAsStream("blog/bindingfile/binding.xml");
        try {
            Map<String, Object> props = new HashMap<String, Object>(1);
            props.put(JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY, bindings);
            jc = JAXBContext.newInstance(new Class[] {Customer.class} , props);
        } catch(JAXBException e) {
            throw new RuntimeException(e);
        } finally {
            try {
                bindings.close();
            } catch(IOException e) {
                throw new RuntimeException(e);
            }
        }
    }

    public JAXBContext getContext(Class<?> clazz) {
        if(Customer.class == clazz) {
            return jc;
        }
        return null;
    }

} 

对于复杂示例

• http://blog.bdoughan.com/2011/04/moxys-xml-metadata-in-jax-rs-service.html

有关使用 MOXy 与 Spring 的更多信息

• http://wiki.eclipse.org/EclipseLink/Examples/MOXy/Spring

---

我还希望这个新的 Web 服务返回 XML 或 JSON
取决于 Accept 标头。我还读到 MOXy 2.4+ 可以
也处理一下！

是的，JSON 绑定已添加到 EclipseLink 2.4 中。要在您的应用程序中利用此功能，创建 MessageBodyReader 和 MessageBodyWriter 应该是一个简单的事情：

package org.example;

import java.io.*;
import java.lang.annotation.Annotation;
import java.lang.reflect.*;
import javax.xml.transform.stream.StreamSource;

import javax.ws.rs.*;
import javax.ws.rs.core.*;
import javax.ws.rs.ext.*;
import javax.xml.bind.*;

@Provider
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public class MOXyJSONProvider implements 
    MessageBodyReader<Object>, MessageBodyWriter<Object>{

    @Context
    protected Providers providers;

    public boolean isReadable(Class<?> type, Type genericType,
        Annotation[] annotations, MediaType mediaType) {
        return true;
    }

    public Object readFrom(Class<Object> type, Type genericType,
            Annotation[] annotations, MediaType mediaType,
            MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
            throws IOException, WebApplicationException {
            try {
                Class<?> domainClass = getDomainClass(genericType);
                Unmarshaller u = getJAXBContext(domainClass, mediaType).createUnmarshaller();
                u.setProperty("eclipselink.media-type", mediaType.toString());
                u.setProperty("eclipselink.json.include-root", false);
                return u.unmarshal(new StreamSource(entityStream), domainClass).getValue();
            } catch(JAXBException jaxbException) {
                throw new WebApplicationException(jaxbException);
            }
    }

    public boolean isWriteable(Class<?> type, Type genericType,
        Annotation[] annotations, MediaType mediaType) {
        return true;
    }

    public void writeTo(Object object, Class<?> type, Type genericType,
        Annotation[] annotations, MediaType mediaType,
        MultivaluedMap<String, Object> httpHeaders,
        OutputStream entityStream) throws IOException,
        WebApplicationException {
        try {
            Class<?> domainClass = getDomainClass(genericType);
            Marshaller m = getJAXBContext(domainClass, mediaType).createMarshaller();
            m.setProperty("eclipselink.media-type", mediaType.toString());
            m.setProperty("eclipselink.json.include-root", false);
            m.marshal(object, entityStream);
        } catch(JAXBException jaxbException) {
            throw new WebApplicationException(jaxbException);
        }
    }

    public long getSize(Object t, Class<?> type, Type genericType,
        Annotation[] annotations, MediaType mediaType) {
        return -1;
    }

    private JAXBContext getJAXBContext(Class<?> type, MediaType mediaType) 
        throws JAXBException {
        ContextResolver<JAXBContext> resolver 
            = providers.getContextResolver(JAXBContext.class, mediaType);
        JAXBContext jaxbContext;
        if(null == resolver || null == (jaxbContext = resolver.getContext(type))) {
            return JAXBContext.newInstance(type);
        } else {
            return jaxbContext;
        }
    }

    private Class<?> getDomainClass(Type genericType) {
        if(genericType instanceof Class) {
            return (Class<?>) genericType;
        } else if(genericType instanceof ParameterizedType) {
            return (Class<?>) ((ParameterizedType) genericType).getActualTypeArguments()[0];
        } else {
            return null;
        }
    }

}

您还可以创建 JSONProvider 的扩展代码>：

• http://cxf.apache.org/apidocs/org/apache/cxf/jaxrs/provider/JSONProvider.html

了解更多信息

• MOXy 作为您的 JAX-RS JSON 提供程序 -客户端
• MOXy 作为您的JAX-RS JSON 提供程序 - 服务器端
• 指定 EclipseLink MOXy 作为您的 JAXB 提供程序