将 CXF REST 服务从 XML 移植到 JSON 响应答案

【问题标题】：Porting CXF REST Service from XML to JSON response将 CXF REST 服务从 XML 移植到 JSON 响应
【发布时间】：2016-08-11 10:07:01
【问题描述】：

我尝试转换包含一个非常简单的 REST 服务的教程（应该部署到 karaf）。

蓝图定义是

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ext="http://aries.apache.org/blueprint/xmlns/blueprint-ext/v1.1.0"
xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.1.0"
xmlns:cxf="http://cxf.apache.org/blueprint/core"
xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0  http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd http://www.osgi.org/xmlns/blueprint-ext/v1.1.0 https://svn.apache.org/repos/asf/aries/tags/blueprint-0.3.1/blueprint-core/src/main/resources/org/apache/aries/blueprint/ext/blueprint-ext.xsd http://cxf.apache.org/blueprint/jaxws http://cxf.apache.org/schemas/blueprint/jaxws.xsd http://cxf.apache.org/blueprint/jaxrs http://cxf.apache.org/schemas/blueprint/jaxrs.xsd http://cxf.apache.org/blueprint/core http://cxf.apache.org/schemas/blueprint/core.xsd http://camel.apache.org/schema/blueprint http://camel.apache.org/schema/blueprint/camel-blueprint.xsd http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.1.0 http://aries.apache.org/schemas/blueprint-cm/blueprint-cm-1.1.0.xsd http://aries.apache.org/blueprint/xmlns/blueprint-ext/v1.1.0 http://aries.apache.org/schemas/blueprint-ext/blueprint-ext-1.1.xsd">

    <cxf:bus id="personRestBus">
    </cxf:bus>
    <bean id="personServiceImpl" class="net.lr.tutorial.karaf.cxf.personrest.impl.PersonServiceImpl"/>
    <jaxrs:server address="/person" id="personService">
        <jaxrs:serviceBeans>
            <ref component-id="personServiceImpl" />
        </jaxrs:serviceBeans>
        <jaxrs:features>
            <cxf:logging />
        </jaxrs:features>
    </jaxrs:server>
</blueprint>

PersonService 接口超级简单：

@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface PersonService {
    @GET
    @Path("/")
    public Person[] getAll();

    @GET
    @Path("/{id}")
    public Person getPerson(@PathParam("id") String id);

    @PUT
    @Path("/{id}")
    public void updatePerson(@PathParam("id") String id, Person person);

    @POST
    @Path("/")
    public void addPerson(Person person);
}

模型如下所示：

package net.lr.tutorial.karaf.cxf.personrest.model;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Person {
    String id;
    String name;
    String url;

    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }

}

这是实现：包 net.lr.tutorial.karaf.cxf.personrest.impl;

import java.util.HashMap;
import java.util.Map;

import net.lr.tutorial.karaf.cxf.personrest.model.Person;
import net.lr.tutorial.karaf.cxf.personrest.model.PersonService;

public class PersonServiceImpl implements PersonService {
    Map<String, Person> personMap;

    public PersonServiceImpl() {
        personMap = new HashMap<String, Person>();
        Person person = createExamplePerson();
        personMap.put("1", person);
    }

    private Person createExamplePerson() {
        Person person = new Person();
        person.setId("1");
        person.setName("Ruediger");
        return person;
    }

    public Person[] getAll() {
        return personMap.values().toArray(new Person[]{});
    }

    public Person getPerson(String id) {
        return personMap.get(id);
    }

    public void updatePerson(String id, Person person) {
        person.setId(id);
        System.out.println("Update request received for " + person.getId() + " name:" + person.getName());
        personMap.put(id, person);
    }

    public void addPerson(Person person) {
        System.out.println("Add request received for " + person.getId() + " name:" + person.getName());
        personMap.put(person.getId(), person);
    }

}

测试如下所示：包 net.lr.tutorial.karaf.cxf.personservice.impl;

import java.io.InputStream;

import javax.ws.rs.core.Response;

import net.lr.tutorial.karaf.cxf.personrest.impl.PersonServiceImpl;
import net.lr.tutorial.karaf.cxf.personrest.model.Person;
import net.lr.tutorial.karaf.cxf.personrest.model.PersonService;

import org.apache.cxf.endpoint.Server;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.client.JAXRSClientFactory;
import org.apache.cxf.jaxrs.client.WebClient;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;

public class PersonServiceRestTest {

    private static final String PERSONSERVICE_TESTURL = "http://localhost:8282/person";
    private static Server server;

    @BeforeClass
    public static void startServer() {
        PersonService personService = new PersonServiceImpl();;
        JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();
        factory.setAddress(PERSONSERVICE_TESTURL);
        factory.setServiceBean(personService);
        server = factory.create();
        server.start();
    }

    @Test
    public void testInterface() {
        PersonService personService = JAXRSClientFactory.create(PERSONSERVICE_TESTURL, PersonService.class);
        Person person = new Person();
        person.setId("1002");
        person.setName("Christian Schneider");
        personService.updatePerson("1002", person);

        Person person2 = personService.getPerson("1002");
        assertCorrectPerson(person2);
    }

    @Test
    public void testWebClient() {
        WebClient client = WebClient.create(PERSONSERVICE_TESTURL + "/1001");
        putPerson(client);
        Person person = client.get(Person.class);
        assertCorrectPerson(person);
    }

    private void putPerson(WebClient client) {
        InputStream is = this.getClass().getResourceAsStream("/person1.json");
        Response resp = client.put(is);
        System.out.println(resp);
    }

    @AfterClass
    public static void stopServer() {
        server.stop();
    }


    private void assertCorrectPerson(Person person) {
        Assert.assertNotNull(person);
        Assert.assertEquals("Christian Schneider", person.getName());
    }

}

testWebClient 测试产生这个警告，但这意味着我没有得到结果：

2016-08-16 11:02:52,306 [tp1293680734-19] 警告 WebApplicationExceptionMapper - javax.ws.rs.ClientErrorException： HTTP 415 不支持的媒体类型位于 org.apache.cxf.jaxrs.utils.SpecExceptions.toHttpException(SpecExceptions.java:117) 在 org.apache.cxf.jaxrs.utils.ExceptionUtils.toHttpException(ExceptionUtils.java:162) 在 org.apache.cxf.jaxrs.utils.JAXRSUtils.findTargetMethod(JAXRSUtils.java:530) 在 org.apache.cxf.jaxrs.interceptor.JAXRSInInterceptor.processRequest(JAXRSInInterceptor.java:177) 在 org.apache.cxf.jaxrs.interceptor.JAXRSInInterceptor.handleMessage(JAXRSInInterceptor.java:77) 在 org.apache.cxf.phase.PhaseInterceptorChain.doIntercept(PhaseInterceptorChain.java:308) 在 org.apache.cxf.transport.ChainInitiationObserver.onMessage(ChainInitiationObserver.java:121) 在 org.apache.cxf.transport.http.AbstractHTTPDestination.invoke(AbstractHTTPDestination.java:253) 在 org.apache.cxf.transport.http_jetty.JettyHTTPDestination.doService(JettyHTTPDestination.java:234) 在 org.apache.cxf.transport.http_jetty.JettyHTTPHandler.handle(JettyHTTPHandler.java:70) 在 org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1129) 在 org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1065) 在 org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141) 在 org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:215) 在 org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:97) 在 org.eclipse.jetty.server.Server.handle(Server.java:499) 在 org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:310) 在 org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:257) 在 org.eclipse.jetty.io.AbstractConnection$2.run(AbstractConnection.java:540) 在 org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:635) 在 org.eclipse.jetty.util.thread.QueuedThreadPool$3.run(QueuedThreadPool.java:555) 在 java.lang.Thread.run(Thread.java:745)

所以测试失败了。

testInterface 测试产生此错误：

2016-08-16 11:20:34,232 [main] WARN PhaseInterceptorChain - {http://model.personrest.cxf.karaf.tutorial.lr.net/}PersonService 的拦截器有抛出异常，现在展开 org.apache.cxf.interceptor.Fault：否已为班级找到消息正文作者 net.lr.tutorial.karaf.cxf.personrest.model.Person，ContentType：应用程序/json 在 org.apache.cxf.jaxrs.client.ClientProxyImpl$BodyWriter.doWriteBody(ClientProxyImpl.java:882) 在 org.apache.cxf.jaxrs.client.AbstractClient$AbstractBodyWriter.handleMessage(AbstractClient.java:1091) 在 org.apache.cxf.phase.PhaseInterceptorChain.doIntercept(PhaseInterceptorChain.java:308) 在 org.apache.cxf.jaxrs.client.AbstractClient.doRunInterceptorChain(AbstractClient.java:649) 在 org.apache.cxf.jaxrs.client.ClientProxyImpl.doChainedInvocation(ClientProxyImpl.java:747) 在 org.apache.cxf.jaxrs.client.ClientProxyImpl.invoke(ClientProxyImpl.java:228) 在 com.sun.proxy.$Proxy19.updatePerson（未知来源） net.lr.tutorial.karaf.cxf.personservice.impl.PersonServiceRestTest.testInterface(PersonServiceRestTest.java:47) 在 sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) 在 sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) 在 sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) 在 java.lang.reflect.Method.invoke(Method.java:498) 在 org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50) 在 org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) 在 org.junit.runners.model.FrameworkMethod.invokeExplosively（FrameworkMethod.java:47）在 org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17) 在 org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325) 在 org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78) 在 org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57) 在 org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) 在 org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) 在 org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) 在 org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) 在 org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) 在 org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26) 在 org.junit.internal.runners.statements.RunAfters.evaluate(RunAfters.java:27) 在 org.junit.runners.ParentRunner.run(ParentRunner.java:363) 在 org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:86) 在 org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:459) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:675) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:382) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:192) 原因：javax.ws.rs.ProcessingException：没有消息正文编写器被发现上课 net.lr.tutorial.karaf.cxf.personrest.model.Person，ContentType：应用程序/json

我能够将服务部署到 karaf 并进行交互。但测试不成功。如果可能的话，我想避免使用像 jackson 这样的外部框架。

谢谢！

【问题讨论】：

您在哪个单元测试中遇到此错误

标签： java json rest cxf

【解决方案1】：

您的服务正在接受任何 MediaType，因为您尚未为 @Consumes 设置默认值（请参阅 documentation）。建议将 content-type 设置为接受

@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface PersonService {

您需要在客户端设置内容类型

client.type( MediaType.APPLICATION_JSON);

我不确定，但我认为您需要在 <jax-rs_server> 中定义 JSON 提供程序

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

<jaxrs:server address="/person" id="personService">
    <jaxrs:serviceBeans>
        <ref component-id="personServiceImpl" />
    </jaxrs:serviceBeans>
    <jaxrs:features>
        <cxf:logging />
    </jaxrs:features>
   <jaxrs:providers>
        <ref bean="jackson" />
    </jaxrs:providers>
</jaxrs:server>

【讨论】：

谢谢，我按照你说的修改了服务定义。问题是：我想将此服务部署到 karaf，所以我有一个蓝图 xml。我需要使用杰克逊吗？或者我可以在没有的情况下达到相同的结果吗？
CXF 和 JAXB 需要一个额外的包来处理 JSON。 stackoverflow.com/questions/38789307/…。 Jackson 是 CXF, 的常见依赖项，它可能包含在您的部署中（查找 jackson*）。如果没有，那么你可以在这里cxf.apache.org/docs/… 找到 maven 配置。也可以使用Moxy 或Jettison
您的问题现在在 bean Person 的反序列化中。您的服务器不知道如何在 JSON 中执行此操作。见stackoverflow.com/questions/11773846/…
当我将服务部署到 karaf 时，我可以愉快地与之交互。我可以发布 JSON 文件并创建人员对象，我还可以获取人员列表或检索单个对象。所以序列化和反序列化确实有效。因此，在 karaf 中存在一个为 JSON 实现的依赖项。但是，如果我为搜索术语做一个功能列表和 grep，我会得到 camel-jackson 用于 jackson camel-restlet 用于休息，camel-xmljson 用于 json，但没有独立的 jettison 或 jackson。这怎么行？
然而 JSON 依赖在我的 karaf 中实现了，我发现我需要一个像 Jackson 这样的 JSON Provider。我添加了 Maven 依赖项。我是否需要将杰克逊的 bean 定义放入一个新的 web.xml 文件中？到目前为止，我只有蓝图 xml 文件。