通過 Spring RestTemplate 調用帶請求體的 Delete 方法（Delete With Request Body）

        Spring 框架的RestTemplate 類定義了一些我們在通過 java 代碼調用 Rest 服務時經常需要用到的方法，使得我們通過 java 調用 rest 服務時更加方便、簡單。但是 RestTemplate 的 delete 方法並不支持傳入請求體（Request Body）。經測試，通過調用 RestTemplate 類的exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<ResponseResult> responseType, Object... uriVariables)  方法，將 method 指定為 org.springframework.http.HttpMethod.DELETE，並傳入 requestEntity（請求體） 對象時，在服務端得到的 Request Body 仍然為 null。可見 RestTemplate 默認並不支持對 DELETE 方法使用請求體。

        通過查閱資料發現 RestTemplate 默認是使用 spring 自身的 SimpleClientHttpRequestFactory 創建請求對象和對其進行相關設置（如請求頭、請求體等），它只支持 PUT 和 POST 方法帶請求體，RestTemplate 的 DELETE 方法不支持傳入請求體是因為 JDK 中 HttpURLConnection 對象的 delete 方法不支持傳入請求體（如果對 HttpURLConnection 對象的 delete 方法傳入請求體，在運行時會拋出 IOException）。

        我們可以通過修改 RestTemplate 的 RequestFactory 實現 delete 方法對請求體的支持，比如改成 Apache HTTPClient’s HttpComponents 的ClientHttpRequestFactory，由於 ClientHttpRequestFactory 默認的 DELETE 方法也不支持請求體，所以我們除了修改 RestTemplate 的 RequestFactory 之外，還需要定義一個支持傳輸請求的的 DELETE 請求模型，完整的代碼如下：

RestTemplate restTemplate = new RestTemplate();
 
public static class HttpEntityEnclosingDeleteRequest extends HttpEntityEnclosingRequestBase {
 
    public HttpEntityEnclosingDeleteRequest(final URI uri) {
        super();
        setURI(uri);
    }
 
    @Override
    public String getMethod() {
        return "DELETE";
    }
}
 
@Test
public void bodyWithDeleteRequest() throws Exception {
    restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory() {
        @Override
        protected HttpUriRequest createHttpUriRequest(HttpMethod httpMethod, URI uri) {
            if (HttpMethod.DELETE == httpMethod) {
                return new HttpEntityEnclosingDeleteRequest(uri);
            }
            return super.createHttpUriRequest(httpMethod, uri);
        }
    });
 
    ResponseEntity<String> exchange = restTemplate.exchange(
            "http://example.com/file";,
            HttpMethod.DELETE,
            new HttpEntity<String>("some sample body sent along the DELETE request"),
            String.class);
    assertEquals("Got body: some sample body sent along the DELETE request", exchange.getBody());
}

 

服務端的 java 代碼：

@RequestMapping(value = "/file", method = DELETE)
@ResponseBody
public String deleteSecci(@RequestBody String body) {
    return "Got body: " + body;
}