在我目前的架构中,我有一个JAX-RS资源,它位于后面:
/categories
/categories/{catId}
这样实现:
@Path("/categories")
@Produces("application/json")
public class CategoryResourcesApi {
@GET
public Response getCategories() {
// ...
}
@GET @Path("/{catId}")
public Response getCategory(@PathParam("catId") String catId) {
// ...
}
// ...
}
和另一个服务:
/products
/products/{prodId}
并有类似的实现:
@Path("/products")
@Produces("application/json")
public class ProductResourcesApi {
@GET
public Response getProducts() {
// ...
}
// ...
}
除了这些直截了当的路径,我还需要提供这些:
/categories/{catId}/products
/categories/{catId}/products/{prodId}
这将是与特定类别相关的产品。
最自然的事情是make ProductResourcesApi
为它们服务,但顺便说一下,我理解JAX-RS注释结构,这只能由CategoryResourcesApi
(或最终由第三个)提供我认为,班级。
我在资源实施中使用@Context
和其他注释,因此直接new ProductResourcesAPI().getProducts()
无法正常工作。
有没有办法在JAX-RS(或Jersey)框架内从一个资源路径转发到另一个资源路径?我还有其他选择吗?如果可能的话,我想保持所有这些易于维护,这就是为什么我为每个根资源选择一个资源的原因。
答案 0 :(得分:8)
为此,您可以使用Sub-resource locators,它基本上是资源类中返回另一个资源类的方法。关于链接中的示例的事情是它们自己实例化资源类,例如
@Path("/item")
public class ItemResource {
@Path("content")
public ItemContentResource getItemContentResource() {
return new ItemContentResource();
}
}
public class ItemContentResource {
@PUT
@Path("{version}")
public void put(@PathParam("version") int version)
}
}
有效,但我不确定它是否会保留注入,例如,如果您想将@Context UriInfo
注入ItemContentResource
中的字段。如果你注入方法参数,它应该可以工作。
为了解决这个问题,有ResourceContext
,在使用时,应该保留所有注射。例如,在您目前的情况下,您可以执行
@Path("/categories")
@Produces("application/json")
public static class CategoryResourcesApi {
@Context
private ResourceContext resourceContext;
@Path("/{catId}/products")
public ProductResourcesApi getProducts() {
return resourceContext.getResource(ProductResourcesApi.class);
}
}
@Path("/products")
@Produces("application/json")
public static class ProductResourcesApi {
@Context
private UriInfo info;
@GET
@Path("/{id}")
public Response getProducts(
@PathParam("id") String prodId,
@PathParam("catId") String catId) {
}
}
getProducts
将映射到URI /categories/{catId}/products/{prodId}
。您只需要检查catId
是否为空(仅当您需要它进行任何查找时)我想确定该请求是对根产品资源还是父类别资源的请求。我想,代码重用需要付出很小的代价。
只看你的评论,我相信过去Swagger并不支持子资源定位器,但我相信现在他们这样做了。如果您遇到问题,可能需要搜索任何讨论。 Here's讨论,another one和another one