java - 如何在CXF中使用PATCH方法

Question

我正在尝试使用 JAX-RS 的 CXF 实现在我的客户端中使用 PATCH 方法。一开始我把PATCH注解定义为

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

引用这里写的内容: How to have a @PATCH annotation for JAX-RS?

然后我发现@PATCH 被添加到 CXF 3.1.2 中，所以我在我的 maven 的 pom.xml 中更改了版本并且确实有 public @interface PATCH inside package org。 apache.cxf.jaxrs.ext; 代码实际上和我上面发布的完全一样。

但是，当我尝试在我的服务定义中使用此注释时

@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public interface AbcService {

    @PATCH
    @Path("/abc/efg")
    public SomeDTO patchSomething(RequestObject request);
}

我最终得到了 java.net.ProtocolException: Invalid HTTP method: PATCH 正如我在上面发布的问题链接中所说的那样。他们与 Jersey 讨论了一些解决方案，但是我可以在 CXF 中做什么，以便我可以使用:

AbcService abcService = JAXRSClientFactory.create(myURI, AbcService.class, myProviders, true);
abcService.patchSomething(new RequestObject('something'));

所以我有几个问题:

1. 我怎样才能完成这项工作？不，我需要编写自定义 CXF 拦截器吗？
2. 如果它不起作用，他们为什么要将 PATCH 注释添加到 CXF 中？
3. 其他主题中的一些人说提到的 PATCH 注释定义对他们有用。怎么来的 ？它是否只会在客户端造成麻烦，如果是，为什么会这样？
4. 为什么我在 CXF 文档中找不到这个注释？我在 http://cxf.apache.org/javadoc/latest/ 查看了 org.apache.cxf.jaxrs.ext 包而且我没有看到任何 PATCH。然而在最新的cxf 3.1.2中我真的可以在这个包中找到它。

Answer 1

原来是因为在JAVA7中，HttpURLConnection不支持PATCH，该类中支持的方法静态定义为

   private static final String[] methods = {
        "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"
    };

但是可以在 CXF 中发送 PATCH 请求，但 Conduit 对象必须是 AsyncHTTPConduit 类型。要使 CXF 使用 AsyncHTTPConduit，您可以像这样以编程方式实现它

AbcService service = JAXRSClientFactory.create(myURI, AbcService.class, myProviders, true);
WebClient.getConfig(service).getRequestContext().put("use.async.http.conduit", true);
service.patchEnvironmentParameters(patchRequest);

或者

WebClient client = WebClient.create("http://localhost:53261/v1-0/api/environment/parameters");
WebClient.getConfig(client).getRequestContext().put("use.async.http.conduit", true);
client.invoke("PATCH", "{}");

但是要小心!!为了使这项工作正常进行，您已将此依赖项放入您的项目中

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-transports-http-hc</artifactId>
  <version>${cxf.version}</version>
</dependency>

还要确保您使用相同版本的 cxf-rt-transports-http-hc 和 cxf。

但是正如您所看到的，我所描述的并没有解决原始问题，因此我只是提出了 1 个特定的 PATCH 请求。然而，在我的项目中，有许多 PATCH 服务使用我最初展示的接口(interface)定义

public interface AbcService {

    @PATCH
    @Path("/abc/efg")
    public SomeDTO patchSomething(RequestObject request);
}

因此，为了仅在 PATCH 方法上使用 AsyncHTTPConduit，我必须编写自定义 CXF 拦截器，您可以在此处了解更多信息 http://cxf.apache.org/docs/interceptors.html我编写的拦截器在 PRE_LOGIC 阶段运行，它会检查使用了哪种方法，如果是 PATCH，它会定义 conduit 属性。然后在服务调用的后期阶段，CXF 使用这个属性来选择应该使用哪个 Conduit 实现，等等之后

if ( message.get(Message.HTTP_REQUEST_METHOD).equals("PATCH") {
  message.put("use.async.http.conduit", true);
}

PATCH 将使用 AsyncHTTPConduit 实例。