如何在 Jersey 客户端的 DELETE 请求中发送附件数据？

Question

我在 Jersey 2.x 中有以下服务器端代码：

@Path("/store/remove/from/group")
@DELETE
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Produces(MediaType.TEXT_PLAIN)
public Response removeStoresFromGroup(@FormParam("storeName") List<String> storeNames, @FormParam("groupName") String groupName) {
    //......
}

在客户端，我想使用 Jersey 2.x 客户端向上述 Web 服务发送删除请求。但是，从Jersey client API的文档中，我没有找到如何在DELETE请求中包含以下数据：

WebTarget webTarget = client.target("/store/remove/from/group");
MultivaluedMap<String, String> formData = new MultivaluedHashMap<String, String>();
List<String> storeName = new ArrayList<String>();
storeName.add("Store1");
storeName.add("Store2");
storeName.add("Store3");

formData.addAll("storeName", storeName);
formData.add("groupName", "Group A");

Response response = webTarget.request().accept(MediaType.TEXT_PLAIN).delete();   //The delete() method doesn't take any entity body in the request.

从 Jersey 客户端 API 来看，SyncInvoker 类不支持将实体主体作为参数的 delete 方法。所以我只能使用 POST 或 PUT 将数据发送到服务器，如下所示（但不能用于 DELETE）：

Response response = webTarget.request().accept(MediaType.TEXT_PLAIN).post(Entity.form(formData)); 

但我想使用 DELETE 请求，因为该请求正在删除一些资源。如何通过 Jersey 客户端发送带有某些实体数据的 DELETE 请求？

Answer 1

我也使用过 RESTeasy Jersey 客户端并为我工作：

响应响应 = client.target(yourUrlToCall).request(MediaType.APPLICATION_JSON) .build("DELETE", Entity.entity(yourJsonDTO, MediaType.APPLICATION_JSON)).invoke();

对于解决一些正常使用get()、delete()等不“允许”的复杂场景非常有用。

Answer 2

请注意：如果你使用JAX RS Client API的resteasy实现，你可以使用build().invoke()：

client.target("$baseUrl$restEndPoint/$entityId")
                .request("application/json")
                .build("DELETE", Entity.entity(entity, MediaType.APPLICATION_JSON))
                .invoke()

但它不适用于jersey

Answer 3

基于 Jersey 2.18 版本的代码，JerseyInvocation 类使用预定义的 HashMap 来验证 HTTP 方法及其实体如下：

map.put("DELETE", EntityPresence.MUST_BE_NULL);
map.put("GET", EntityPresence.MUST_BE_NULL);
...

这就是为什么我们得到这个错误“Entity must be null for http method DELETE”。

同时请注意，它还提供了一个 Jersey 客户端配置属性ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION 来决定是否停止其余的执行，所以这里我们可以使用这个属性来抑制验证，以便继续发送一个DELETE向实体请求。例如

    ClientConfig config = new ClientConfig();
    config.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
    Client client = ClientBuilder.newClient(config);
    ...

Answer 4

带有实体主体 is not strictly forbidden 的 DELETE 但它非常罕见，并且被某些框架/服务器忽略。实体主体的需要可能表明 DELETE 未按预期使用。

例如：如果GET /customers/4711 返回一位客户，而您发送DELETE /customers/4711，则此资源上的下一个GET 应返回404。您删除了一个由 URL 标识的资源，例如 defined in the spec。

您的 URL /store/remove/from/group 似乎无法识别资源。使用 /store/4711 或 /groups/4711 之类的标识符并在其上发送 DELETE 不符合您的需求，因为您希望“从组中删除商店”而不是删除商店或组。

假设你有一个组资源

{
  "id" : 4711,
  "stores" : [123, 456, 789]
}

你想要这样的结果

{
  "id" : 4711,
  "stores" : [123, 789]
}

您没有删除任何内容。您正在修改资源，因此 PUT、POST 或 PATCH 是合适的方法。 JSON-Patch 是描述此类更改的好格式。请求如下所示：

PATCH /groups/4711 HTTP/1.1
Content-Type: application/json-patch

[
  {
    "op" : "remove"
    "path" : "stores/1"
  }
]

Answer 5

您可以使用webTarget.request().accept(MediaType.TEXT_PLAIN).method("DELETE",yourEntity) 调用带有实体的DELETE。