使用 Jersey 客户端的 PATCH 请求

Posted 2023-02-19

【中文标题】使用 Jersey 客户端的 PATCH 请求

【英文标题】：PATCH request using Jersey Client

【发布时间】：2014-04-16 19:21:46

【问题描述】：

我想执行我们的服务器支持的 PATCH 请求，以便使用 Jersey 客户端进行测试。我的代码如下，但我得到com.sun.jersey.api.client.ClientHandlerException: java.net.ProtocolException: HTTP method PATCH doesn't support output 异常。有人可以告诉我下面的代码有什么问题吗？

String complete_url = "http://localhost:8080/api/request";
String request = "[\"op\":\"add\", \"path\":\"/name\", \"value\":\"Hello\"]";
DefaultClientConfig config = new DefaultClientConfig();
    config.getProperties().put(URLConnectionClientHandler.PROPERTY_HTTP_URL_CONNECTION_SET_METHOD_WORKAROUND, true);
Client client = Client.create(config);
WebResource resource = client.resource(complete_url);
ClientResponse response = resource.header("Authorization", "Basic xyzabCDef")
 .type(new MediaType("application", "json-patch+json"))
 .method("PATCH", ClientResponse.class, request);

这是完整的例外，

com.sun.jersey.api.client.ClientHandlerException: java.net.ProtocolException: HTTP method PATCH doesn't support output
    at com.sun.jersey.client.urlconnection.URLConnectionClientHandler.handle(URLConnectionClientHandler.java:155)
    at com.sun.jersey.api.client.Client.handle(Client.java:652)
    at com.sun.jersey.api.client.WebResource.handle(WebResource.java:682)
    at com.sun.jersey.api.client.WebResource.access$200(WebResource.java:74)
    at com.sun.jersey.api.client.WebResource$Builder.method(WebResource.java:634)
    at com.acceptance.common.PatchTest.patch(PatchTest.java:42)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:47)
    at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
    at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:44)
    at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
    at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:271)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:70)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:50)
    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:238)
    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:63)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:236)
    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:53)
    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:229)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:309)
    at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:50)
    at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:467)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:683)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:390)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:197)
Caused by: java.net.ProtocolException: HTTP method PATCH doesn't support output
    at sun.net.www.protocol.http.HttpURLConnection.getOutputStream(HttpURLConnection.java:1021)
    at com.sun.jersey.client.urlconnection.URLConnectionClientHandler$1$1.getOutputStream(URLConnectionClientHandler.java:238)
    at com.sun.jersey.api.client.CommittingOutputStream.commitStream(CommittingOutputStream.java:117)
    at com.sun.jersey.api.client.CommittingOutputStream.write(CommittingOutputStream.java:89)
    at sun.nio.cs.StreamEncoder.writeBytes(StreamEncoder.java:202)
    at sun.nio.cs.StreamEncoder.implFlushBuffer(StreamEncoder.java:272)
    at sun.nio.cs.StreamEncoder.implFlush(StreamEncoder.java:276)
    at sun.nio.cs.StreamEncoder.flush(StreamEncoder.java:122)
    at java.io.OutputStreamWriter.flush(OutputStreamWriter.java:212)
    at java.io.BufferedWriter.flush(BufferedWriter.java:236)
    at com.sun.jersey.core.util.ReaderWriter.writeToAsString(ReaderWriter.java:191)
    at com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider.writeToAsString(AbstractMessageReaderWriterProvider.java:128)
    at com.sun.jersey.core.impl.provider.entity.StringProvider.writeTo(StringProvider.java:88)
    at com.sun.jersey.core.impl.provider.entity.StringProvider.writeTo(StringProvider.java:58)
    at com.sun.jersey.api.client.RequestWriter.writeRequestEntity(RequestWriter.java:300)
    at com.sun.jersey.client.urlconnection.URLConnectionClientHandler._invoke(URLConnectionClientHandler.java:217)
    at com.sun.jersey.client.urlconnection.URLConnectionClientHandler.handle(URLConnectionClientHandler.java:153)

【问题讨论】：

有什么方法可以抑制警告或完全避免警告？ - ***.com/a/67682124/16022919

【参考方案1】：

这是当前 JDK 实现中的一个错误，已在 JDK8 实现中修复。查看此链接以获取详细信息 https://bugs.openjdk.java.net/browse/JDK-7157360。 有办法解决这个问题，但泽西队决定不修复它https://github.com/eclipse-ee4j/jersey/issues/1639

我能想到的2个解决方案

使用支持HttpPatch方法的Apache Http Client 使用 Jersey 客户端 PostReplaceFilter，但必须修改容器代码并包含 X-HTTP-Method-Override 标头，其值为 PATCH 而 发出帖子请求。参考http://zcox.wordpress.com/2009/06/17/override-the-http-request-method-in-jersey/ ]

【讨论】：

我迁移到 Jersey 2.1 (2.35)，在创建客户端时添加这个属性很好 jerseyClient.property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true);，调用是：Response response = invocationBuilder.method("PATCH ", Entity.entity(jsonRequestString, MediaType.APPLICATION_JSON_TYPE));

【参考方案2】：

仅供参考 - 以防万一有人在 Jersey 2 中遇到这种情况，请参阅 HttpUrlConnectorProvider documentation

并使用 SET_METHOD_WORKAROUND 属性，如下所示：

Client jerseyClient = ClientBuilder.newClient()
        .property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true)
        ... etc ...

我花了很长时间才找到这个 - 认为我可以帮助缩短其他人的学习曲线。

【讨论】：

它奏效了 ;) 无论如何，PATCH 自 2010 年 (rfc 5789) 以来就是 HTTP 标准的一部分……很奇怪，在 2017 年，Jersey 仍然不原生支持它

它解决了这个错误，但是我使用一个可以正常工作的客户端获得未经授权的 401，以便获取需要授权的呼叫，尽管如此？

【参考方案3】：

如果您使用的是 HttpsUrlConnection（注意 的），那么设置 HttpUrlConnectorProvider.SET_METHOD_WORKAROUND 将不起作用。继续阅读以获得详细的解决方案。

在我的例子中，设置HttpUrlConnectorProvider.SET_METHOD_WORKAROUNDproperty 会导致NoSuchFieldException，因为我的HttpUrlConnection 实例实际上是类型：sun.net.www.protocol.https.HttpsURLConnectionImpl，它是超级的：javax.net.ssl.HttpsURLConnection（继承自HttpUrlConnection）。

所以当杰克逊代码尝试从我的连接实例超级（javax.net.ssl.HttpsURLConnection 的实例）获取方法字段时：

/**
 * Workaround for a bug in @code HttpURLConnection.setRequestMethod(String)
 * The implementation of Sun/Oracle is throwing a @code ProtocolException
 * when the method is other than the HTTP/1.1 default methods. So to use @code PROPFIND
 * and others, we must apply this workaround.
 *
 * See issue http://java.net/jira/browse/JERSEY-639
 */
private static void setRequestMethodViaJreBugWorkaround(final HttpURLConnection httpURLConnection, final String method) 
    try 
        httpURLConnection.setRequestMethod(method); // Check whether we are running on a buggy JRE
     catch (final ProtocolException pe) 
        try 
            final Class<?> httpURLConnectionClass = httpURLConnection.getClass();
            AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() 
                @Override
                public Object run() throws NoSuchFieldException, IllegalAccessException 
                    final Field methodField = httpURLConnectionClass.getSuperclass().getDeclaredField("method");
                    methodField.setAccessible(true);
                    methodField.set(httpURLConnection, method);
                    return null;
                
            );
         catch (final PrivilegedActionException e) 
            final Throwable cause = e.getCause();
            if (cause instanceof RuntimeException) 
                throw (RuntimeException) cause;
             else 
                throw new RuntimeException(cause);
            
        
    

我们得到一个NoSuchFieldException 指出名为method 的字段不存在（因为 getDeclaredFields() 带来了所有字段，无论它们的可访问性如何，但仅适用于当前类，而不是当前类的任何基类可能继承自）。

所以我查看了 Java 的 HttpUrlConnection 代码，发现允许的方法由 private static String[] 指定：

 /* Adding PATCH to the valid HTTP methods */
 private static final String[] methods = 
     "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"
 ;

解决方案是使用反射更改此方法数组：

 try 
         Field methodsField = HttpURLConnection.class.getDeclaredField("methods");
         methodsField.setAccessible(true);
         // get the methods field modifiers
         Field modifiersField = Field.class.getDeclaredField("modifiers");
         // bypass the "private" modifier 
         modifiersField.setAccessible(true);

         // remove the "final" modifier
         modifiersField.setInt(methodsField, methodsField.getModifiers() & ~Modifier.FINAL);

         /* valid HTTP methods */
         String[] methods = 
                    "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "PATCH"
         ;
         // set the new methods - including patch
         methodsField.set(null, methods);

      catch (SecurityException | IllegalArgumentException | IllegalAccessException | NoSuchFieldException e) 
      e.printStackTrace();
     

由于方法字段是静态的，因此更改其值适用于任何扩展 HttpUrlConnection 的具体实例，包括 HttpsUrlConnection。

旁注：我希望 Java 将 PATCH 方法添加到 JDK 或 Jackson 以在其解决方法中通过整个层次结构执行字段查找。

无论如何，我希望这个解决方案能为您节省一些时间。

【讨论】：

非常感谢您发布此信息！几年后我都想不通，我告诉同事我可以实现这个功能，因为我已经看到其他人这样做了，但没有意识到中间的不同课程会为我搞砸！

感谢上述使用 java 反射的解决方案，它对我有用。

非常高级的答案！

【参考方案4】：

简单的答案是：

依赖关系

<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.core/jersey-client -->
 <dependency>
     <groupId>org.glassfish.jersey.core</groupId>
     <artifactId>jersey-client</artifactId>
     <version>2.27</version>
 </dependency>

需要加HttpUrlConnectorProvider.SET_METHOD_WORKAROUND=true

Client client = ClientBuilder.newClient(clientConfig).property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true);

请求

client.target("base_url").path("end_point").request().headers("your_headers")
       .build("PATCH", Entity.entity("body_you_want_to_pass", "content-type"))
       .invoke();

【讨论】：

嗯，这给了我一个错误“不支持的方法”。但同样的“PATCH”方法适用于 javascript 客户端

您是否使用与我提到的相同的依赖项？

是的，我使用了相同版本的上述依赖项。