79.6. 消耗 REST 请求 - Simple Binding Style
从 Camel 2.11 开始提供
Default 绑定风格是低级的,要求用户手动处理来自路由的 MessageContentsList 对象。因此,它将路由逻辑与 JAX-RS 操作的方法签名和参数索引紧密耦合。微不足道、困难和容易出错。
相反,SimpleConsumer 绑定样式执行以下映射,以便在 Camel 消息内 使请求数据更易访问 :
- JAX-RS 参数(@HeaderParam、@QueryParam 等)注入 IN 消息标头。标头名称与注解值匹配。
-
请求实体(POJO 或其他类型)成为 IN 消息正文。如果无法在 JAX-RS 方法签名中识别单个实体,它将回退到原始的
MessageContentsList。 -
二进制
@Multipart正文部分成为 IN 消息附件,支持DataHandler、InputStream、DataSource和 CXF 的Attachment类。 -
非二进制
@Multipart正文部分映射为 IN 消息标头。标头名称与 Body Part 名称匹配。
另外,以下规则适用于 Response 映射 :
-
如果消息正文类型与
javax.ws.rs.core.Response(user-built response)不同,则创建新的响应,并且消息正文设置为实体(因此其不是 null)。响应状态代码从Exchange.HTTP_RESPONSE_CODE标头获取,如果不存在,则默认为 200 OK。 -
如果消息正文类型等于
javax.ws.rs.core.Response,这表示用户已构建自定义响应,因此它会被遵守,并成为最终响应。 -
在所有情况下,自定义或默认
HeaderFilterStrategy允许的 Camel 标头都添加到 HTTP 响应中。
79.6.1. 启用 Simple Binding Style 复制链接链接已复制到粘贴板!
通过将消费者端点中的 bindingStyle 参数设置为 SimpleConsumer,可以激活这个绑定风格:
from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
.to("log:TEST?showAll=true");
79.6.2. 使用不同方法签名的请求绑定示例 复制链接链接已复制到粘贴板!
以下是方法签名列表以及来自 Simple 绑定的预期结果。
公共响应 doAction (BusinessObject 请求);
请求有效负载放置在 IN 消息正文中,替换原始的 MessageContentsList。
Public Response doAction (BusinessObject request, @HeaderParam ("abcd") String abcd, @QueryParam ("defg") String defg"); Request payload put in IN message body, 替换原始 MessageContentsList。两个请求参数都映射为 IN 消息标头,其名称为 abcd 和 defg。
公共响应 doAction (@HeaderParam ("abcd") String abcd, @QueryParam ("defg") String defg); Both request params mapped as IN message headers with name abcd and defg.原始 MessageContentsList 被保留,即使它只包含 2 参数。
公共响应 doAction (@Multipart (value="body1") BusinessObject 请求, @Multipart (value="body2") BusinessObject request2); 第一个参数作为带有名称 body1 的标头传输,第二个参数被映射为标头 body2。原始 MessageContentsList 保留为 IN message body。
公共响应 doAction (InputStream abcd); InputStream is unwrapped from the MessageContentsList,并保留为 IN 消息正文。
Public Response doAction (DataHandler abcd); DataHandler is unwrapped from the MessageContentsList,并保留为 IN 消息正文。
79.6.3. Simple Binding Style 的更多示例 复制链接链接已复制到粘贴板!
使用此方法给定 JAX-RS 资源类:
@POST @Path("/customers/{type}")
public Response newCustomer(Customer customer, @PathParam("type") String type, @QueryParam("active") @DefaultValue("true") boolean active) {
return null;
}
通过以下路由提供服务:
from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
.recipientList(simple("direct:${header.operationName}"));
from("direct:newCustomer")
.log("Request: type=${header.type}, active=${header.active}, customerData=${body}");
以下带有 XML 有效负载的 HTTP 请求(代表客户 DTO 是 JAXB-annotated):
POST /customers/gold?active=true
Payload:
<Customer>
<fullName>Raul Kripalani</fullName>
<country>Spain</country>
<project>Apache Camel</project>
</Customer>
将打印消息:
Request: type=gold, active=true, customerData=<Customer.toString() representation>
有关如何处理请求和写入响应的更多示例,请访问 https://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/jaxrs/simplebinding/。