47.4. 使用 Apache CXF 扩展

概述

Apache CXF 提供标准的 JAX-WS 注入机制的扩展,允许开发人员使用单一注解替换一系列注入注解。单个注解放置在一个 bean 上,其中包含使用注解提取的数据字段。例如,如果资源方法预期一个请求 URI 中包含名为 id 的三个查询参数,则键入,它可使用一个 @QueryParam 注释来将所有参数注入到 Bean 中并包含相应字段。

注意

请考虑使用 @BeanParam 注释(自 JAX-RS 2.0 起可用)。标准化的 @BeanParam 方法比专用 Apache CXF 扩展更灵活,因此建议的替代方案。详情请查看 第 47.2.6 节 “将参数注入 Java Bean”

支持的注入注解

这个扩展不支持所有注入参数。它只支持以下内容:

  • @PathParam
  • @QueryParam
  • @MatrixParam
  • @FormParam

语法

要指定注解将使用串行注入程序,您需要执行两个操作:

  1. 将注解的参数指定为空字符串。例如 @PathParam("") 指定一系列 URI 模板变量被序列化为 bean。
  2. 确保注解的参数是一个 bean,其中包含与要注入的值匹配的字段。

示例

例 47.7 “将查询参数注入 Bean” 显示将多个 Query 参数注入到 bean 的示例。资源方法预期请求 URI 包含两个查询参数: typeid。其值注入了 Monster an 的对应字段。

例 47.7. 将查询参数注入 Bean

import javax.ws.rs.QueryParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
...

@Path("/monstersforhire/")
public class MonsterService
{
  ...
  @POST
  public void updateMonster(@QueryParam("") Monster bean)
  {
    ...
  }
  ...
}

public class Monster
{
  String type;
  String id;

  ...
}