Конфигурирование CXF с помощью Spring для использования MOXY для маршалинга / демаршаллинга XML - PullRequest
3 голосов
/ 24 января 2012

У меня есть серверное приложение Java, которое использует CXF для предоставления веб-сервисов SOAP и REST.В настоящее время он использует эталонную реализацию JAX-B для маршаллинга / демаршаллинга XML, но я настроил его для замены Jettison на Джексона для маршалинга / демаршаллинга JSON.Я использую Spring для DI и настройки контекста приложения.

Фрагменты конфигурации веб-службы REST выглядят следующим образом:

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>

Эта конфигурация работает и возвращает либо XML, либо JSON в зависимости от заголовка HTTP Accept.Что мне нравится в этой конфигурации, так это то, что она основана на Spring, и ее очень легко создать и использовать альтернативный кодер JSON.Подробную информацию о настройке CXF можно найти здесь .

Моя проблема в том, что теперь у меня есть новый (дополнительный) веб-сервис REST для предоставления, и я хотел бы использовать другой JAX-B XMLпривязка для этого нового веб-сервиса.Я понимаю, что MOXy может сделать это, но я не могу понять, как настроить конечную точку CXF, чтобы она использовала MOXy для маршалинга / демаршаллинга (и, кроме того, как сообщить Moxy о моем собственном файле отображения XML).Я также хотел бы, чтобы этот новый веб-сервис возвращал либо XML, либо JSON в зависимости от заголовка Accept.Я также читал, что MOXy 2.4+ может с этим справиться!

В идеале я мог бы использовать MOXy для этой новой конечной точки, не затрагивая другие существующие сервлеты.

1 Ответ

2 голосов
/ 24 января 2012

Примечание: Я EclipseLink JAXB (MOXy) и член JAXB (JSR-222) экспертная группа.

От руки Я не знаю точной конфигурации для CXF, но ниже я предоставил некоторые ссылки на использование MOXy с Spring.Пожалуйста, не стесняйтесь связаться со мной , и я могу помочь вам реализовать это:

Моя проблема в том, что теперь у меня есть новый (дополнительный) веб-сервис REST, и я хотел бы использовать другую привязку XML JAX-B для этого нового веб-сервиса.Я понимаю, что 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;
    }

} 

Для примера завершения

Для получения дополнительной информации об использовании MOXy с пружиной

Мне также хотелось бы, чтобы этот новый веб-сервис возвращал либо XML, либо JSON в зависимости от заголовка Accept.Я также читал, что MOXy 2.4+ может справиться с этим!

Да, в EclipseLink 2.4 добавляется привязка JSON.Чтобы использовать это в своем приложении, нужно просто создать 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:

Для получения дополнительной информации

...