46.5. 使用子资源

概述

服务可能需要由多个资源处理。例如，在订购处理服务的最佳实践表明每个客户都作为唯一资源进行处理。每个顺序也会作为唯一资源进行处理。

使用 JAX-RS API，您要将客户资源和顺序资源 实施为子资源。子资源是可通过根资源类访问的资源。它们通过将 @Path 注释添加到资源类的方法来定义。子资源可以通过以下两种方式之一实现：

指定子资源

子资源通过利用 @Path 注释方式指定。子资源的 URI 构造如下：

  1. 将 sub-resource 的 @Path 注释的值附加到子资源的 @Path 注释的值。

    父资源的 @Path 注释可能位于资源类中的方法，该类返回包含子资源的类对象。

  2. 重复上一步，直到达到 root 资源。
  3. assembled URI 附加到部署该服务的基础 URI 中。

例如，例 46.6 “订购子资源” 中显示的子资源的 URI 可以是 baseURI/customerservice/order/12。

例 46.6. 订购子资源

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }
}

子资源方法

子资源方法使用 @Path 注释和其中一个 HTTP 动词标注进行解码。子资源方法直接负责使用指定的 HTTP 动词处理资源上发出的请求。

例 46.7 “子资源方法” 显示具有三个子资源方法的资源类：

  • getOrder （） 处理其 URI 匹配 /customerservice/orders/{orderId}/ 的资源的 HTTP GET 请求。
  • updateOrder （） 处理 URI 匹配 /customerservice/orders/{orderId}/ 的资源的 HTTP PUT 请求。
  • newOrder （） 处理 /customerservice/orders/ 上资源的 HTTP POST 请求。

例 46.7. 子资源方法

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  @Path("/orders/{orderId}/")
  @PUT
  public Order updateOrder(@PathParam("orderId") String orderId,
                           Order order)
  {
    ...
  }

  @Path("/orders/")
  @POST
  public Order newOrder(Order order)
  {
    ...
  }
}
注意

具有相同 URI 模板的子资源方法等同于由子资源 locator 返回的资源类。

子资源 locators

子资源 locators 不与其中一个 HTTP 动词注解中分离，且不会直接处理子资源上的请求。相反，子资源 locator 会返回一个可处理请求的资源类的实例。

除了没有 HTTP 动词注解外，子资源 locators 还不能有任何实体参数。子资源 locator 方法使用所有参数都必须使用 第 47 章 将信息传递到资源类和方法 中描述的一个注解。

如 例 46.8 “子资源 locator 返回特定类” 所示，子资源定位为可重复使用的类，而不是将所有方法放在一个超级类中。processOrder （） 方法是一个子资源 locator。对与 URI 模板 /orders/{orderId}/ /orders/{orderId}/ 匹配的 URI 发出请求时，它会返回一个 Order 类的实例。Order 类使用 HTTP 动词注解进行解码的方法。PUT 请求由 updateOrder （） 方法处理。

例 46.8. 子资源 locator 返回特定类

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  public Order processOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  ...
}

public class Order
{
  ...
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  @PUT
  public Order updateOrder(@PathParam("orderId") String orderId,
                           Order order)
  {
    ...
  }

}

子资源 locators 在运行时处理，以便支持多形器。子资源 locator 的返回值可以是通用 对象、抽象类或类层次结构的顶部。例如，如果您的服务需要处理 PayPal 订单和信用卡订单，则来自 例 46.8 “子资源 locator 返回特定类” 的 processOrder （） 方法的签名可能会保持不变。您只需要实施两个类，即 ppOrder 和 ccOder 来扩展 Order 类。processOrder （） 的实现将根据所需的逻辑实例化子资源的实现。