CXF：找不到类的消息正文编写器 - 自动映射非简单资源

Question

我正在使用适用于简单数据类型（例如：字符串、整数）的 CXF 休息客户端。 但是，当我尝试使用自定义对象时，我得到了：

Exception in thread "main" org.apache.cxf.interceptor.Fault: .No message body writer found for class : class com.company.datatype.normal.MyObject.
    at org.apache.cxf.jaxrs.client.ClientProxyImpl$BodyWriter.handleMessage(ClientProxyImpl.java:523)
    at org.apache.cxf.phase.PhaseInterceptorChain.doIntercept(PhaseInterceptorChain.java:263)
    at org.apache.cxf.jaxrs.client.ClientProxyImpl.doChainedInvocation(ClientProxyImpl.java:438)
    at org.apache.cxf.jaxrs.client.ClientProxyImpl.invoke(ClientProxyImpl.java:177)
    at $Proxy13.execute(Unknown Source)
    at com.company.JaxTestClient.main(JaxTestClient.java:26)
Caused by: org.apache.cxf.jaxrs.client.ClientWebApplicationException: .No message body writer found for class : class com.company.datatype.normal.MyObject.
    at org.apache.cxf.jaxrs.client.AbstractClient.reportMessageHandlerProblem(AbstractClient.java:491)
    at org.apache.cxf.jaxrs.client.AbstractClient.writeBody(AbstractClient.java:401)
    at org.apache.cxf.jaxrs.client.ClientProxyImpl$BodyWriter.handleMessage(ClientProxyImpl.java:515)
    ... 5 more

我这样称呼它：

JaxExample jaxExample = JAXRSClientFactory.create( "http://localhost:8111/", JaxExample.class );
MyObject before = ...
MyObject after = jaxExample.execute( before );

这是接口中的方法：

@POST
@Path( "execute" )
@Produces( "application/json" )
MyObject execute( MyObject myObject );

restlet 库通过将 XStream 依赖项添加到它“正常工作”的路径来非常简单地完成此操作。 CXF 有类似的东西吗？

编辑#1：

我已将此作为对 CXF 问题管理系统的功能改进发布在此处。 我只能希望这会得到关注。

Answer 1

它不是开箱即用的，但 CXF 确实支持 JSON 绑定到 rest 服务。 请参阅此处的 cxf jax-rs json 文档。 您仍然需要进行一些最低限度的配置才能使提供程序可用，并且如果您想更好地控制 JSON 的形成方式，则需要熟悉 jettison。

编辑：根据评论请求，这里有一些代码。 我对此没有太多经验，但以下代码在快速测试系统中作为示例。

//TestApi parts
@GET
@Path ( "test" )
@Produces ( "application/json" )
public Demo getDemo () {
    Demo d = new Demo ();
    d.id = 1;
    d.name = "test";
    return d;
}

//client config for a TestApi interface
List providers = new ArrayList ();
JSONProvider jsonProvider = new JSONProvider ();
Map<String, String> map = new HashMap<String, String> ();
map.put ( "http://www.myserviceapi.com", "myapi" );
jsonProvider.setNamespaceMap ( map );
providers.add ( jsonProvider );
TestApi proxy = JAXRSClientFactory.create ( url, TestApi.class, 
    providers, true );

Demo d = proxy.getDemo ();
if ( d != null ) {
    System.out.println ( d.id + ":" + d.name );
}

//the Demo class
@XmlRootElement ( name = "demo", namespace = "http://www.myserviceapi.com" )
@XmlType ( name = "demo", namespace = "http://www.myserviceapi.com", 
    propOrder = { "name", "id" } )
@XmlAccessorType ( XmlAccessType.FIELD )
public class Demo {

    public String name;
    public int id;
}

笔记：

1. 提供程序列表是您在客户端上对 JSON 提供程序进行代码配置的地方。 特别是，您会看到命名空间映射。 这需要与您的服务器端配置相匹配。 我对 Jettison 选项了解不多，因此我对操纵所有用于控制编组过程的各种旋钮帮助不大。
2. CXF 中的 Jettison 通过将 JAXB 提供程序中的 XML 编组到 JSON 中来工作。 因此，您必须确保将有效负载对象全部标记（或以其他方式配置）以编组为应用程序/xml，然后才能将它们编组为 JSON。 如果您知道解决此问题的方法（除了编写自己的消息正文作者），我很想听听。
3. 我在服务器上使用 spring 所以我的配置有所有 xml 的东西。 本质上，您需要通过相同的过程将 JSONProvider 添加到具有相同命名空间配置的服务中 go。 没有方便的代码，但我想它会很好地反映客户端。

作为一个例子，这有点脏，但希望能让你继续前进。

Edit2：基于 xstream 的消息正文编写器示例，以避免 jaxb。

@Produces ( "application/json" )
@Consumes ( "application/json" )
@Provider
public class XstreamJsonProvider implements MessageBodyReader<Object>,
    MessageBodyWriter<Object> {

@Override
public boolean isWriteable ( Class<?> type, Type genericType, 
    Annotation[] annotations, MediaType mediaType ) {
    return MediaType.APPLICATION_JSON_TYPE.equals ( mediaType ) 
        && type.equals ( Demo.class );
}

@Override
public long getSize ( Object t, Class<?> type, Type genericType, 
    Annotation[] annotations, MediaType mediaType ) {
    // I'm being lazy - should compute the actual size
    return -1;
}

@Override
public void writeTo ( Object t, Class<?> type, Type genericType, 
    Annotation[] annotations, MediaType mediaType, 
    MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream ) 
    throws IOException, WebApplicationException {
    // deal with thread safe use of xstream, etc.
    XStream xstream = new XStream ( new JettisonMappedXmlDriver () );
    xstream.setMode ( XStream.NO_REFERENCES );
    // add safer encoding, error handling, etc.
    xstream.toXML ( t, entityStream );
}

@Override
public boolean isReadable ( Class<?> type, Type genericType, 
    Annotation[] annotations, MediaType mediaType ) {
    return MediaType.APPLICATION_JSON_TYPE.equals ( mediaType ) 
        && type.equals ( Demo.class );
}

@Override
public Object readFrom ( Class<Object> type, Type genericType, 
    Annotation[] annotations, MediaType mediaType, 
    MultivaluedMap<String, String> httpHeaders, InputStream entityStream ) 
    throws IOException, WebApplicationException {
    // add error handling, etc.
    XStream xstream = new XStream ( new JettisonMappedXmlDriver () );
    return xstream.fromXML ( entityStream );
}
}

//now your client just needs this
List providers = new ArrayList ();
XstreamJsonProvider jsonProvider = new XstreamJsonProvider ();
providers.add ( jsonProvider );
TestApi proxy = JAXRSClientFactory.create ( url, TestApi.class, 
    providers, true );

Demo d = proxy.getDemo ();
if ( d != null ) {
    System.out.println ( d.id + ":" + d.name );
}

示例代码缺少强大的媒体类型支持、错误处理、线程安全等部分。但是，它应该可以用最少的代码解决 jaxb 问题。

编辑 3 - 示例服务器端配置正如我之前所说，我的服务器端配置为 spring。 这是一个用于连接提供程序的示例配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jaxrs="http://cxf.apache.org/jaxrs"
xmlns:cxf="http://cxf.apache.org/core"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
    http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd">

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

<jaxrs:server id="TestApi">
    <jaxrs:serviceBeans>
        <ref bean="testApi" />
    </jaxrs:serviceBeans>
    <jaxrs:providers>
        <bean id="xstreamJsonProvider" class="webtests.rest.XstreamJsonProvider" />
    </jaxrs:providers>
</jaxrs:server>

<bean id="testApi" class="webtests.rest.TestApi">
</bean>

</beans>

我还注意到，在我使用的最新版本的 cxf 中，媒体类型存在差异，因此上面关于 xstream 消息正文读取器/写入器的示例需要快速修改，其中 isWritable/isReadable 更改为：

return MediaType.APPLICATION_JSON_TYPE.getType ().equals ( mediaType.getType () )
    && MediaType.APPLICATION_JSON_TYPE.getSubtype ().equals ( mediaType.getSubtype () )
    && type.equals ( Demo.class );

编辑 4 - 非弹簧配置使用您选择的 servlet 容器，配置

org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet

至少有 2 个初始化参数：

jaxrs.serviceClasses
jaxrs.providers

其中 serviceClasses 是你要绑定的服务实现的空格分隔列表，例如上面提到的 TestApi，providers 是空格分隔的消息体提供者列表，例如上面提到的 XstreamJsonProvider。 在 tomcat 中，您可以将以下内容添加到 web.xml 中：

<servlet>
    <servlet-name>cxfservlet</servlet-name>
    <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
    <init-param>
        <param-name>jaxrs.serviceClasses</param-name>
        <param-value>webtests.rest.TestApi</param-value>
    </init-param>
    <init-param>
        <param-name>jaxrs.providers</param-name>
        <param-value>webtests.rest.XstreamJsonProvider</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

这几乎是在没有 spring 的情况下运行它的最快方法。 如果您不使用 servlet 容器，则需要使用 XstreamJsonProvider 实例配置 JAXRSServerFactoryBean.setProviders 并通过 JAXRSServerFactoryBean.setResourceProvider 方法设置服务实现。 检查 CXFNonSpringJaxrsServlet.init 方法以了解它们在 servlet 容器中设置时的操作方式。

无论您的情况如何，这都应该让您继续前进。

Answer 2

我在从 CXF 2.7.0 升级到 3.0.2 时遇到了这个问题。 这是我为解决它所做的：

在我的 pom.xml 中包含以下内容

    <dependency>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-rt-rs-extension-providers</artifactId>
        <version>3.0.2</version>
    </dependency>

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

并添加了以下提供者

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

Answer 3

如果你使用 jaxrs:client 路由配置，可以选择使用 JacksonJsonProvider 提供

<jaxrs:client id="serviceId"
    serviceClass="classname"
    address="">
    <jaxrs:providers>
        <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider">
            <property name="mapper" ref="jacksonMapper" />
        </bean>
    </jaxrs:providers>
</jaxrs:client>

<bean id="jacksonMapper" class="org.codehaus.jackson.map.ObjectMapper">
</bean>

您需要在类路径中包含 jackson-mapper-asl 和 jackson-jaxr 工件

Answer 4

以编程方式创建服务器时，您可以通过设置 Providers 为 json/xml 添加消息正文编写器。

JAXRSServerFactoryBean bean = new JAXRSServerFactoryBean();
bean.setAddress("http://localhost:9000/");

List<Object> providers = new ArrayList<Object>();
providers.add(new JacksonJaxbJsonProvider());
providers.add(new JacksonJaxbXMLProvider());
bean.setProviders(providers);

List<Class< ? >> resourceClasses = new ArrayList<Class< ? >>();
resourceClasses.add(YourRestServiceImpl.class);
bean.setResourceClasses(resourceClasses);

bean.setResourceProvider(YourRestServiceImpl.class, new SingletonResourceProvider(new YourRestServiceImpl()));

BindingFactoryManager manager = bean.getBus().getExtension(BindingFactoryManager.class);
JAXRSBindingFactory restFactory = new JAXRSBindingFactory();
restFactory.setBus(bean.getBus());
manager.registerBindingFactory(JAXRSBindingFactory.JAXRS_BINDING_ID, restFactory);

bean.create();

Answer 5

您还可以配置 CXFNonSpringJAXRSServlet（假设使用 JSONProvider）：

<init-param>
  <param-name>jaxrs.providers</param-name>
  <param-value>
      org.apache.cxf.jaxrs.provider.JSONProvider
      (writeXsiType=false)
  </param-value> 
</init-param>

Answer 6

第 1 步：将 bean class 添加到dataFormat列表中：

<dataFormats>
    <json id="jack" library="Jackson" prettyPrint="true"
          unmarshalTypeName="{ur bean class path}" /> 
</dataFormats>

第 2 步：在客户端调用之前编组 bean：

<marchal id="marsh" ref="jack"/>

Answer 7

You can try with mentioning "Accept: application/json" in your rest client header as well, if you are expecting your object as JSON in response.

Answer 8

如果您使用的是“cxf-rt-rs-client”版本 3.03。 或以上确保 xml 名称空间和 schemaLocation 声明如下

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:jaxrs="http://cxf.apache.org/jaxrs" 
    xmlns:jaxrs-client="http://cxf.apache.org/jaxrs-client"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd http://cxf.apache.org/jaxrs-client http://cxf.apache.org/schemas/jaxrs-client.xsd">

并确保客户端有 JacksonJsonProvider 或您的自定义 JsonProvider

<jaxrs-client:client id="serviceClient" address="${cxf.endpoint.service.address}" serviceClass="serviceClass">
        <jaxrs-client:headers>
            <entry key="Accept" value="application/json"></entry>
        </jaxrs-client:headers>
        <jaxrs-client:providers>
            <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider">
            <property name="mapper" ref="jacksonMapper" />
        </bean>
        </jaxrs-client:providers>
</jaxrs-client:client>

Answer 9

在我的场景中，当没有正确配置没有端口号的 rest url 以进行负载平衡时，我遇到了类似的错误。 我用端口号验证了 rest url 并且没有发生此问题。 所以我们不得不更新负载平衡配置来解决这个问题。

Answer 10

上述更改均不适合我。 请在下面查看我的工作配置：

依赖项：

            <dependency>
                <groupId>org.apache.cxf</groupId>
                <artifactId>cxf-rt-frontend-jaxrs</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>org.apache.cxf</groupId>
                <artifactId>cxf-rt-rs-extension-providers</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>org.codehaus.jackson</groupId>
                <artifactId>jackson-jaxrs</artifactId>
                <version>1.9.13</version>
            </dependency>
            <dependency>
                <groupId>org.codehaus.jettison</groupId>
                <artifactId>jettison</artifactId>
                <version>1.4.0</version>
            </dependency>

web.xml：

     <servlet>
        <servlet-name>cfxServlet</servlet-name>
        <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
        <init-param>
            <param-name>javax.ws.rs.Application</param-name>
            <param-value>com.MyApplication</param-value>
        </init-param>
        <init-param>
            <param-name>jaxrs.providers</param-name>
            <param-value>org.codehaus.jackson.jaxrs.JacksonJsonProvider</param-value>
        </init-param>
        <init-param>
            <param-name>jaxrs.extensions</param-name>
            <param-value> 
            json=application/json 
        </param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>cfxServlet</servlet-name>
        <url-pattern>/v1/*</url-pattern>
    </servlet-mapping>

享受编码.. :)

Answer 11

在同一个项目中同时拥有 org.codehaus.jackson 和 com.fasterxml.jackson 依赖项将导致此“无消息正文编写器”问题，无论注释如何。

在我的例子中，Bean 由 com.fasterxml.jackson -> jackson-jaxrs-json-provider 编组，由 org.codehaus.jackson -> jackson-jaxrs 解组

因此，删除/更新从 org.codehaus.jackson 到 com.fasterxml.jackson.jaxrs 的所有引用解决了这个问题。

我已经在 cxf-servlet.xml、pom.xml 和所有 java 类导入中更新了它。

pom.xml

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-rs-extension-providers</artifactId>
    <version>3.5.2</version>
</dependency>

<dependency>
     <groupId>com.fasterxml.jackson.jaxrs</groupId>
     <artifactId>jackson-jaxrs-json-provider</artifactId>
     <version>2.13.4</version>
</dependency>

cxf-servlet.xml 中的提供者

<jaxrs:providers>
   <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider" />
</jaxrs:providers>