如何在CXF中使用PATCH方法

Question

我正在尝试在我的客户端使用PATCH方法使用JAX-RS的CXF实现.起初我将PATCH注释定义为

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

引用这里写的内容: 如何为JAX-RS提供@PATCH注释？

然后我发现@PATCH被添加到CXF 3.1.2中,所以我在我的maven的pom.xml中更改了版本,确实有public @interface PATCH内部版本,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上面发布的queston链接中的说法.他们用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服务使用我最初显示的接口定义

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);
}

AsyncHTTPConduit将使用PATCH将使用的实例.