为什么在使用CXF-RS组件时使用<cxf:rsserver>而不是普通的<jaxrs:server>?</jaxrs:server> </cxf:rsserver>

时间:2014-01-29 19:48:54

标签: java spring web-services apache-camel cxfrs

作为this question的后续行动,我对如何正确使用CXF-RS组件仍感到有些困惑。

我很困惑为什么我们需要<cxf:rsServer>标签来指定CXF-RS端点(或者甚至有这样一个概念?),当我完全可以使用<jaxrs:server>标签时。

这是Camel和CXF的配置XML:

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:jaxrs="http://cxf.apache.org/jaxrs"
    xmlns:camel="http://camel.apache.org/schema/spring"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd      
        http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
        http://cxf.apache.org/transports/http/configuration http://cxf.apache.org/schemas/configuration/http-conf.xsd
        http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
        http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">

    <jaxrs:server id="userService" address="/users">
        <jaxrs:serviceBeans>
            <bean class="com.example.UserServiceNoop" />
        </jaxrs:serviceBeans>
        <jaxrs:providers>
            <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider" />
        </jaxrs:providers>
    </jaxrs:server>

    <bean id="user" class="org.apache.camel.component.direct.DirectComponent" />

    <camel:camelContext id="someCamelContext">
        <camel:route id="userServiceRoute">
            <camel:from uri="cxfrs:bean:userService" />
            <camel:routingSlip>
                <camel:simple>user:${header.operationName}</camel:simple>
            </camel:routingSlip>
        </camel:route>

        <camel:route id="userServiceRetrieveUser">
            <from uri="user:retrieveUser" />
            <!-- Assume this is going to a useful Processor -->

        </camel:route>  
    </camel:camelContext>
</beans>

UserService.java:

package com.example;

/* a bunch of imports... */

public interface UserService {
    @GET
    @Path(value="/{user.id}")
    @Produces({MediaType.APPLICATION_JSON})
    public User retrieveUser(
        @PathParam("user.id") Integer id
    );
}

UserServiceNoop.java

package com.example;

/* a bunch of imports ... */

public class UserServiceNoop implements UserService 
{
    @Override
    public User retrieveUser(Integer id) {
        throw new RuntimeException();
    }
}

在这个例子中,我没有使用任何<cxf:rsServer>标签,但它工作正常。我知道它通过CXF-RS组件,因为当我运行应用程序时,它不会抛出任何RuntimeExceptions,这是使用CXF-RS时的预期行为(不会调用服务类中的方法实现)。

我是不是因为没有使用这个标签而错过了什么?

谢谢!

2 个答案:

答案 0 :(得分:0)

如果要将CXF端点用作某些内容的使用者,请使用cxf:reserver标记。比如说在复杂的Apache Camel路由或Spring集成中。当您是提供请求的端点的提供者时使用。

答案 1 :(得分:0)

正如另一个答案所说,cxf:rsServer主要用于通过骆驼路线进行处理,就像jaxrs:server中一样,请求的处理由经典控制器完成。

例如:

  1. 经典JAXRS服务器:

您将声明经典的Bean Rest(控制器)并在其中注入服务。

XML配置示例(提取):

<jaxrs:server id="deviceServiceSvcV1" address="/device/v1">
    <jaxrs:serviceBeans>
        <ref component-id="deviceServiceRest" />
    </jaxrs:serviceBeans>
    <!-- and other providers, interceptors, etc... here --> 
</jaxrs:server>

<!-- Service bean -->
<bean id="deviceServiceRest" class="org.mycomp.device.rest.v1.ws.api.DeviceServiceRest">
    <property name="deviceService" ref="deviceService" />
</bean>

Controller类将以经典方式处理请求/响应(例如,调用注入的服务)。

  1. cxf:rsServer的骆驼路线

XML配置示例(提取):

<cxf:rsServer id="rsServer" address="/device/v1"
    serviceClass="org.mycomp.device.rest.v1.ws.api.DeviceServiceRest">
    <cxf:properties>
        <!-- whatever here -->
    </cxf:properties>
    <!-- and other interceptors, etc... here -->         
</cxf:rsServer>

并在课程中:

@Produces({ MediaType.APPLICATION_XML })
@Path("/")
public class DeviceServiceRest {

    @GET
    public Response listDevicess( 
            @QueryParam("model") String model,
            @QueryParam("sid") String sid,
    ) {
        return null; // never used
    }

    @GET
    @Path("{id}")
    public Response getDeviceById(
            @PathParam("id") String id,
            @QueryParam("model") String model,
            @QueryParam("sid") String sid
    ){               
        return null; // never used
    }
}

REST控制器具有空方法(返回null),但我认为最新的camel-cxf现在支持Interface,这比使方法返回null更为优雅。 现在,可以通过骆驼路线实现请求处理,如下所示:

from("cxfrs:bean:rsServer?synchronous=true")
    .routeId("cxf-device-rest-v1")
    .process( new CheckAuthenticationProcessor())
    .choice()
        .when(header("operationName").isEqualTo("listDevice"))
            .setHeader("backenOperation").constant("list")
            .setHeader("backendResource").constant("device")
            
        .endChoice()
        .when(header("operationName").isEqualTo("getDeviceById"))
            .setHeader("backenOperation").constant("retrieve")
            .setHeader("backendResource").constant("device")
        .endChoice()
    .end()
    .bean("requestProcessor")
    .to(InOut, backendEndpoint)
    .process(checkResponseStatusCode())
    .bean(new HttpResponseProcessor())
;

您还可以根据需要从路由控制请求/响应处理。

这是实现REST API(服务器端)的两种不同类型,但我认为这有点老了,因为像spring-boot这样的现代框架不需要这些。

我发现第二种方法有点过于矫kill过正,因为我喜欢将Camel用于集成目的,但是将其用于REST API可能需要讨论。 我看到的一个用例是用于异步处理的HTTP REST Web服务,响应202接受的服务以及骆驼路线以异步模式集成请求,特别是当可以轻松使用特定的骆驼组件而不是复杂的骆驼组件时类(或任何需要的EIP模式)。