子资源的 Jersey 重用参数验证

Question

我必须遵循泽西岛的端点结构：

/objects/
/objects/:id
/objects/:id/:field
/objects/:id/:field/:subfield

我使用的 ID 具有非常特定的格式，因此在向数据库发出请求之前，我首先检查格式是否有效。

现在我必须将这段代码放入每个以:id 为参数的函数的POST、PUT、GET、DELETE 函数中。所以这只是意味着提前返回。

if (!isIdValid(id)){
    return Response.status(Response.StatusType.BAD_REQUEST)
                   .entity("The ID you've provided is invalid")
                   .build();
}

（实际上错误实体是一个包含更多错误信息的对象）

然后对于使用:field 或:subfield 参数的每个函数，代码类似。每次都必须复制这种检查和错误处理行为。当我开始复制粘贴内容时，我开始思考：应该有更好的方法吗？

我想将:id 检查代码放在/objects/:id 级别，然后假设所有进一步的嵌套级别都有一个有效的ID。进一步嵌套的其他参数也是如此。

我一直在研究使用子资源定位器，但随后您创建了一个返回子资源新实例的函数。如果验证失败，我无法将Response-object 的条件返回置于该级别。

@Path("{id}")
function Class<ObjectFieldResource> getObjectById(@PathParam("id") String id){
    return ObjectFieldResource.class;
}

我可以开始抛出异常，但我宁愿避免这种情况，因为我并不认为无效输入是一个异常。

如何最好地实施这样的结构？我查看了 bean 验证，但这似乎不允许我为我的特定格式 + 自定义错误响应定义验证。

我在实现子资源的方式上是否遗漏了什么？

Answer 1

解决方案 1

如果您可以使用正则表达式检查而不是 isIdValid 方法，则可以像这样定义您的资源

@POST
@Path("objects/{id:\\d+}")
public Response doSmth(@PathParam("id") String id) {
...
}

如果id 格式无效，调用者将处于“未找到”响应状态，甚至无法到达您的doSmth 方法。

显然，您可以对所有相等的路径值使用字符串常量。

final static String ID_RES = "objects/{id:\\d+}";

@POST
@Path(ID_RES)
public Response postSmth(@PathParam("id") String id) {
...
}
...
@GET
@Path(ID_RES)
public Object getSmth(@PathParam("id") String id) {
...
}

也可以读取full description的Path#value参数

解决方案 2

使用需要 URI 检查的 filter 方法在您的 REST 服务器 javax.ws.rs.container.ContainerRequestFilter 实现中创建和注册。

单个过滤器参数具有来自女巫的ContainerRequestContext 类型，您可以调用getUriInfo 来获取URI 和方法abortWith(Response response)，如果您的资源ID 验证失败，可以使用该方法中止调用方请求。

参见泽西手册的Chapter 10. Filters and Interceptors 章节。