如何为JAX-RS提供@PATCH注释？

Question

JAX-RS 具有 HTTP 谓词的注释，如 GET（@GET）和 POST（@POST），但没有@PATCH注释。如何为补丁 HTTP 动词添加注释？

如下所示：

@PATCH
public Response someCode() {
    // Code to handle the request
}

Answer 1

在泽西岛，这可以正常工作，但是当使用泽西岛客户端测试您的资源类时，您将获得异常：

java.net.ProtocolException: Invalid HTTP method: PATCH

通过设置客户端属性，可以解决这个问题

HttpUrlConnectorProvider.SET_METHOD_WORKAROUND 

但是等待，然后您将以以下例外结束：

javax.ws.rs.ProcessingException: java.net.ProtocolException: HTTP method PATCH doesn't support output

因此，除了使用Jersey 2.10版的Apache HTTP客户端库之外，没有其他方法，很容易配置为使用Apache HTTP客户端，您只需要在扩展< code>JerseyTest的测试类中覆盖客户端配置方法。

@Override
protected void configureClient(ClientConfig config) {
  config.register(CustomJacksonJsonProvider.class);
  ConnectorProvider connectorProvider = new ApacheConnectorProvider();
  config.connectorProvider(connectorProvider);
}

您还需要添加另一个Maven依赖项，jersey apache连接器和Jerrey测试框架提供程序外部，请参阅jersey文档

Answer 2

JAX-RS 2.1将< code>@PATCH添加到支持的HTTP方法列表中。

使用 Swagger 记录 REST API 时，可以使用 io.swagger.jaxrs 包中定义的现有@PATCH注释。

Dropwizard在＜code＞io.Dropwizard中定义了＜code＞补丁package。

如果上面提到的方法不适合你，你可以编写自己的@PATCH注释：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@HttpMethod("PATCH")
public @interface PATCH { }

@HttpMethod注释用于将HTTP方法的名称与注释关联起来，从而创建JAX-RS规范所称的资源方法指示符。

您自己的@PATCH注释在Swagger中应该可以正常工作。

Answer 3

我在这里得到了答案。

只需定义一个自定义补丁注释，这意味着您必须使用以下代码编写一个PATCH.java文件：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@HttpMethod("PATCH")
public @interface PATCH {
}

导入包含PATCH.java的包，然后可以像使用其他HTTP方法注释一样使用它:

@PATCH
@Path("/data/{keyspace}")
@Produces({ "application/json" })
public void patchRow(@PathParam("keyspace") String keyspace, String body) 
throws Exception

我使用这个@PATCH向我的REST服务发送了一些JSON。