18.2. 配置 JAX-RS 客户端端点

18.2.1. 定义 JAX-RS 客户端端点

注入客户端代理

在 XML 语言(Blueprint XML 或 Spring XML)中实例化客户端代理的主要点是将其注入另一个 bean,然后使用客户端代理调用 REST 服务。要在 XML 中创建客户端代理 bean,请使用 jaxrs:client 元素。

命名空间

JAX-RS 客户端端点使用服务器端点 的不同 XML 命名空间来定义。下表显示了用于 XML 语言的命名空间:

XML 语言客户端端点的命名空间

蓝图(Blueprint)

http://cxf.apache.org/blueprint/jaxrs-client

Spring

http://cxf.apache.org/jaxrs-client

基本客户端端点定义

以下示例演示了如何在 Blueprint XML 或 Spring XML 中创建客户端代理:

<jaxrs:client id="restClient"
       address="http://localhost:8080/test/services/rest"
       serviceClass="org.apache.cxf.systest.jaxrs.BookStoreJaxrsJaxws"/>

您必须设置以下属性来定义基本客户端端点:

id
客户端代理的 bean ID 可用于将客户端代理注入到 XML 配置中的其他 Bean 中。
address
address 属性指定 REST 调用的基本 URL。
serviceClass
serviceClass 属性指定根资源类(由 @Path无关)来提供 REST 服务的描述。实际上,这是 服务器 类,但不直接由客户端使用。指定的类仅用于其元数据(通过 Java 反射和 JAX-RS 注释),用于动态构建客户端代理。

指定标头

您可以使用 jaxrs:headers 子元素将 HTTP 标头添加到客户端代理调用中,如下所示:

<jaxrs:client id="restClient"
       address="http://localhost:8080/test/services/rest"
       serviceClass="org.apache.cxf.systest.jaxrs.BookStoreJaxrsJaxws"
       inheritHeaders="true">
       <jaxrs:headers>
           <entry key="Accept" value="text/xml"/>
       </jaxrs:headers>
</jaxrs:client>

18.2.2. jaxrs:client 属性

属性

表 18.3 “JAX-RS 客户端端点属性” 描述 jaxrs:client 元素中可用的属性。

表 18.3. JAX-RS 客户端端点属性

属性描述

address

指定消费者发出请求的端点的 HTTP 地址。这个值覆盖合同中设定的值。

bindingId

指定消费者使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。

总线

指定 Spring bean 配置总线管理端点的 ID。

inheritHeaders

如果从此代理创建子资源代理,则指定是否会继承为此代理设置的标头。默认为 false

username

指定用于简单用户名/密码身份验证的用户名。

password

指定用于简单用户名/密码验证的密码。

modelRef

将模型 schema 指定为类路径资源(例如,classpath :/path/to/model.xml的 URL)。有关如何定义 JAX-RS 模型架构的详细信息,请参阅 第 18.3 节 “使用模型架构定义 REST 服务”

serviceClass

指定服务接口的名称或资源类(通过 @PATH标注),重新利用 JAX-RS 服务器实施。在这种情况下,指定的类 不会 直接调用(实际上是一个服务器类)。指定的类仅用于其元数据(通过 Java 反射和 JAX-RS 注释),用于动态构建客户端代理。

serviceName

指定在使用 JMS 传输的特殊情况下,为 JAX-RS 端点指定服务 QName(使用 ns:name)。详情请查看 “使用 JMS 传输”一节

threadSafe

指定客户端代理是否为 thread-safe。默认为 false

transportId

用于选择非标准传输层(替换 HTTP)。特别是,您可以通过将此属性设置为 http://cxf.apache.org/transports/jms 来选择 JMS 传输。详情请查看 “使用 JMS 传输”一节

abstract

(仅限 Spring) 指定 bean 是否为抽象 bean。abstract Bean 充当拥塞 Bean 定义且没有实例化的父项。默认值为 false。将其设置为 true 指示 bean 工厂不会实例化 bean。

dependent-on

(Spring only) 指定端点在实例化前需要被实例化的 Bean 列表,然后才能实例化它。

18.2.3. jaxrs:client Child Elements

子元素

表 18.4 “JAX-RS 客户端端点子元素” 描述 jaxrs:client 元素的子元素。

表 18.4. JAX-RS 客户端端点子元素

元素描述

jaxrs:executor

 

jaxrs:features

指定 Beans 列表,用于配置 Apache CXF 的高级功能。您可以提供 bean 引用列表或嵌入式 Bean 列表。

jaxrs:binding

未使用.

jaxrs:dataBinding

指定实施端点使用的数据绑定的类。这使用嵌入式 bean 定义进行指定。如需了解更多详细信息,请参阅 “指定数据绑定”一节

jaxrs:inInterceptors

指定进程入站响应的拦截器列表。更多信息请参阅 第 VII 部分 “开发 Apache CXF Interceptors”

jaxrs:inFaultInterceptors

指定处理入站错误信息的拦截器列表。更多信息请参阅 第 VII 部分 “开发 Apache CXF Interceptors”

jaxrs:outInterceptors

指定处理出站请求的拦截器列表。更多信息请参阅 第 VII 部分 “开发 Apache CXF Interceptors”

jaxrs:outFaultInterceptors

指定处理出站错误信息的拦截器列表。更多信息请参阅 第 VII 部分 “开发 Apache CXF Interceptors”

jaxrs:properties

指定传递给端点的属性映射。

jaxrs:providers

使您能够使用此端点注册一个或多个自定义 JAX-RS 提供程序。此元素的子项是(an 元素)的实例或引用(ref 元素)JAX-RS 提供程序。

jaxrs:modelBeans

由一个或多个 org.apache.cxf.jaxrs.model.UserResource Bean 组成,它们是资源模型的基本元素(与 jaxrs:resource 元素)的引用列表。详情请查看 第 18.3 节 “使用模型架构定义 REST 服务”

jaxrs:model

在此端点中直接定义资源模型(即 jaxrs:model 元素包含一个或多个 jaxrs:resource 元素)。详情请查看 第 18.3 节 “使用模型架构定义 REST 服务”

jaxrs:headers

用于设置传出消息上的标头。详情请查看 “指定标头”一节

jaxrs:schemaLocations

指定验证 XML 消息内容的一个或多个 XML 模式。此元素可以包含一个或多个 jaxrs:schemaLocation 元素,各自指定 XML 架构文件的位置(通常是 类路径 URL)。详情请查看 “模式验证”一节