使用RestTemplate，顯示請求資訊，響應資訊

口袋裡的貓發表於2020-12-01

使用RestTemplate，顯示請求資訊，響應資訊

這裡不講怎麼用RestTemplate具體細節用法，就是一個學習中的過程記錄

一個簡單的例子

public class App {
    public static void main(String[] args) {
        String url = "https://api.uixsj.cn/hitokoto/get";
        RestTemplate restTemplate = new RestTemplate();
        String body = restTemplate.getForObject(url, String.class);
        System.out.println(body);
    }
}

執行結果：

❓：現在我想看看他的請求頭，請求引數，響應頭，響應體的詳細資訊是怎麼樣子的，這樣也方便以後檢查請求引數是否完整，響應正確與否。

經過蒐集資料發現ClientHttpRequestInterceptor滿足需求，於是就有了下面的程式碼

列印請求頭/響應頭

public class App {
    public static void main(String[] args) {
        String url = "https://api.uixsj.cn/hitokoto/get";
        RestTemplate restTemplate = new RestTemplate();
        // 加上攔截器列印將請求請求，響應資訊列印出來
        restTemplate.setInterceptors(Collections.singletonList(new LoggingInterceptor()));
        String body = restTemplate.getForObject(url, String.class);
        System.out.println(body);
    }
}

@Slf4j
class LoggingInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        displayRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        displayResponse(response);
        return response;
    }

    /**
     * 顯示請求相關資訊
     * @param request
     * @param body
     */
    private void displayRequest(HttpRequest request, byte[] body) {
        log.debug("====request info====");
        log.debug("URI         : {}", request.getURI());
        log.debug("Method      : {}", request.getMethod());
        log.debug("Req Headers : {}", this.headersToString(request.getHeaders()));
        log.debug("Request body: {}", body == null ? "" : new String(body, StandardCharsets.UTF_8));
    }

    /**
     * 顯示響應相關資訊
     * @param response
     * @throws IOException
     */
    private void displayResponse(ClientHttpResponse response) throws IOException {
        StringBuilder inputStringBuilder = new StringBuilder();
        try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), StandardCharsets.UTF_8))) {
            String line = bufferedReader.readLine();
            while (line != null) {
                inputStringBuilder.append(line);
                inputStringBuilder.append('\n');
                line = bufferedReader.readLine();
            }
        }
        log.debug("====response info====");
        log.debug("Status code  : {}", response.getStatusCode());
        log.debug("Status text  : {}", response.getStatusText());
        log.debug("Resp Headers : {}", headersToString(response.getHeaders()));
        log.debug("Response body: {}", inputStringBuilder.toString());
    }

    /**
     * 將Http頭資訊格式化處理
     * @param httpHeaders
     * @return
     */
    private String headersToString(HttpHeaders httpHeaders) {
        if (Objects.isNull(httpHeaders)) {
            return "[]";
        }
        return httpHeaders.entrySet().stream()
                .map(entry -> {
                    List<String> values = entry.getValue();
                    return "\t" + entry.getKey() + ":" + (values.size() == 1 ?
                            "\"" + values.get(0) + "\"" :
                            values.stream().map(s -> "\"" + s + "\"").collect(Collectors.joining(", ")));
                })
                .collect(Collectors.joining(", \n", "\n[\n", "\n]\n"));
    }
}

執行結果：

執行過程中會報錯，具體錯誤資訊是

Exception in thread "main" org.springframework.web.client.ResourceAccessException: I/O error on GET request for "https://api.uixsj.cn/hitokoto/get": stream is closed; nested exception is java.io.IOException: stream is closed

這裡報錯資訊是流已關閉，報錯是在新增LoggingInterceptor後出現的，那就是新加程式碼引起的。在看看LoggingInterceptor的實現，什麼地方操作了流，並且關閉了流。

LoggingInterceptor.displayResponse這個方法裡面，為了讀取響應體操作了流response.getBody()，

try (...) {
}
// 這個try塊結束後就把流給關了

註釋掉程式碼中流操作相關程式碼，再次執行沒有錯誤資訊。因該是在攔截器後，RestTemplate也需要操作了response.getBody()的流（廢話）。

Response body 不能讀第二次這個很要命呀

問題找到了，初步的想到了幾種解決

改寫程式碼，不close流，讀取完之後再reset流
代理一下ClientHttpResponse每次呼叫getBody都返回一個新的輸入流

解決不能重複讀Response body

方法一：讀取完後不關閉流

// 略...
InputStream responseBody = response.getBody();
BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(responseBody, StandardCharsets.UTF_8));
String line = bufferedReader.readLine();
while (line != null) {
    inputStringBuilder.append(line);
    inputStringBuilder.append('\n');
    line = bufferedReader.readLine();
}
responseBody.reset();
// 略...

很遺憾，執行後依舊有錯誤

Exception in thread "main" org.springframework.web.client.ResourceAccessException: I/O error on GET request for "https://api.uixsj.cn/hitokoto/get": mark/reset not supported; nested exception is java.io.IOException: mark/reset not supported

說的很清楚，不支援mark/reset方法。很明顯了它不允許隨意修改讀取定位。沒辦法只轉為第二種方法了。

方法二：代理，每次都返回一個新的流

靜態代理實現ClientHttpResponse介面，好在ClientHttpResponse實現的介面數量不多，實現的程式碼如下。

@Slf4j
class LoggingInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        displayRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        // 包裝代理一下
        response = new ClientHttpResponseWrapper(response);
        displayResponse(response);
        return response;
    }

    /**
     * 顯示請求相關資訊
     * @param request
     * @param body
     */
    private void displayRequest(HttpRequest request, byte[] body) {
        // 略...
    }

    /**
     * 顯示響應相關資訊
     * @param response
     * @throws IOException
     */
    private void displayResponse(ClientHttpResponse response) throws IOException {
        StringBuilder inputStringBuilder = new StringBuilder();
        try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), StandardCharsets.UTF_8))) {
            String line = bufferedReader.readLine();
            while (line != null) {
                inputStringBuilder.append(line);
                inputStringBuilder.append('\n');
                line = bufferedReader.readLine();
            }
        }
        // 略...
    }

    /**
     * 將Http頭資訊格式化處理
     * @param httpHeaders
     * @return
     */
    private String headersToString(HttpHeaders httpHeaders) {
        // 略...
    }

    private class ClientHttpResponseWrapper implements ClientHttpResponse {
        private ClientHttpResponse clientHttpResponse;
        private byte[] body;

        public ClientHttpResponseWrapper(ClientHttpResponse clientHttpResponse) {
            this.clientHttpResponse = clientHttpResponse;
        }

        @Override
        public HttpStatus getStatusCode() throws IOException {
            return this.clientHttpResponse.getStatusCode();
        }

        @Override
        public int getRawStatusCode() throws IOException {
            return this.clientHttpResponse.getRawStatusCode();
        }

        @Override
        public String getStatusText() throws IOException {
            return this.clientHttpResponse.getStatusText();
        }

        @Override
        public void close() {
            this.clientHttpResponse.close();
        }

        /**
         * 快取body每次返回一個新的輸入流
         * @return
         * @throws IOException
         */
        @Override
        public InputStream getBody() throws IOException {
            if (Objects.isNull(this.body)) {
                this.body = StreamUtils.copyToByteArray(this.clientHttpResponse.getBody());
            }
            return new ByteArrayInputStream(this.body == null ? new byte[0] : this.body);
        }

        @Override
        public HttpHeaders getHeaders() {
            return this.clientHttpResponse.getHeaders();
        }
    }
}

執行效果：

程式碼執行沒問題，但是總感覺程式碼寫出來笨笨的，要重寫這麼多用不著的方法，看著不舒服，換個寫法。

動態代理


public class App {
    public static void main(String[] args) {
        String url = "https://api.uixsj.cn/hitokoto/get";
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.setInterceptors(Collections.singletonList(new LoggingInterceptor()));
        String body = restTemplate.getForObject(url, String.class);
        System.out.println(body);
    }

}

@Slf4j
class LoggingInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        displayRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        // 包裝代理一下
        response = (ClientHttpResponse) Proxy.newProxyInstance(response.getClass().getClassLoader(), new Class[]{ClientHttpResponse.class}, new ClientHttpResponseHandler(response));
        displayResponse(response);
        return response;
    }

    /**
     * 顯示請求相關資訊
     * @param request
     * @param body
     */
    private void displayRequest(HttpRequest request, byte[] body) {
        // 略......
    }

    /**
     * 顯示響應相關資訊
     * @param response
     * @throws IOException
     */
    private void displayResponse(ClientHttpResponse response) throws IOException {
        StringBuilder inputStringBuilder = new StringBuilder();
        try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), StandardCharsets.UTF_8))) {
            String line = bufferedReader.readLine();
            while (line != null) {
                inputStringBuilder.append(line);
                inputStringBuilder.append('\n');
                line = bufferedReader.readLine();
            }
        }
        // 略......
    }

    /**
     * 將Http頭資訊格式化處理
     * @param httpHeaders
     * @return
     */
    private String headersToString(HttpHeaders httpHeaders) {
        // 略......
    }

    private static class ClientHttpResponseHandler implements InvocationHandler {
        private static final String methodName = "getBody";
        private ClientHttpResponse clientHttpResponse;
        private byte[] body;

        ClientHttpResponseHandler(ClientHttpResponse clientHttpResponse) {
            this.clientHttpResponse = clientHttpResponse;
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            if (StringUtils.equals(methodName, method.getName())) {
                if (Objects.isNull(this.body)) {
                    this.body = StreamUtils.copyToByteArray(this.clientHttpResponse.getBody());
                }
                return new ByteArrayInputStream(this.body == null ? new byte[0] : this.body);
            }
            return method.invoke(this.clientHttpResponse, args);
        }
    }
}

執行結果：

總結

使用RestTemplate想要顯示詳細請求資訊，和響應資訊
新增攔截器
攔截器中操作InputSteam導致流關閉，不能重複讀Response body
嘗試不關閉流，重置流的方案失敗
使用代理解決 Response body 不能讀第二次讀的問題
- 靜態代理（可以重複讀Response body了）
- 動態代理（可以重複讀Response body了）
靜態代理的程式碼有點囉嗦，動態代理又有點不夠味，看來『茴』字不好寫呀

Spring Boot使用AOP在控制檯列印請求、響應資訊
2019-02-20
Spring Boot
ChinaFile：供應鏈資訊圖顯示蘋果影響力已覆蓋全球
2013-02-17
蘋果
ThinkPHP 請求與響應
2019-12-12
PHP
HTTP 請求與響應
2018-12-05
HTTP
Http請求與響應
2018-04-08
HTTP
WebxFrameworkFilter 請求響應流程
2014-07-03
WebFrameworkFilter
Django請求響應物件
2016-03-08
Django物件
Go如何響應http請求？
2019-04-03
GoHTTP
HTTP的請求與響應
2019-03-16
HTTP
理解Http請求與響應
2016-11-25
HTTP
DRF之請求與響應
2024-04-22
fdisk -l顯示資訊詳解
2015-11-23
不能顯式攔截ajax請求的302響應？
2023-10-01
Linux顯示磁碟使用率資訊（iostat)
2016-05-19
LinuxiOS
精講RestTemplate第4篇-POST請求方法使用詳解
2020-08-09
REST
HTTP請求與響應簡析
2019-04-19
HTTP
SpringMVC 入門、請求、響應
2021-12-19
SpringMVC
request和response——請求響應物件
2022-03-27
物件
HTTP請求頭與響應頭
2018-05-27
HTTP
springboot+aop切點記錄請求和響應資訊
2018-11-07
Spring Boot
nginx日誌中顯示cookie資訊
2016-12-22
NginxCookie
精講RestTemplate第3篇-GET請求使用方法詳解
2020-08-05
REST
如何使用cURL獲得請求/響應具體耗時？
2021-12-13
android 網路請求時，顯示progrossBar
2019-03-19
AndroidROS
HTTP請求格式和HTTP響應格式
2018-07-25
HTTP
作業4_請求與響應
2020-12-17
curl 請求獲取響應時間
2020-11-17
Django REST framework的請求與響應
2020-11-04
DjangoRESTFramework
處理請求(AFURLRequestSerialization)和響應(AFURLResponseSerialization)
2018-05-21
jquery的ajax請求servlet與響應
2017-11-29
jQueryServlet
ifconfig為什麼沒有顯示對應IP資訊
2018-01-24
http請求頭與響應頭的應用
2018-09-10
HTTP
用 Linux 命令顯示硬體資訊
2019-10-04
Linux
Mysql 顯示錶的相關資訊 --命令
2018-09-05
MySql
顯示v$sqltext中完整的sql資訊
2014-06-13
SQL
精講RestTemplate第5篇-DELETE、PUT等請求方法使用詳解
2020-08-10
RESTdelete
精講RestTemplate第10篇-使用代理作為跳板傳送請求
2020-08-18
REST
4.爬蟲 requests庫講解 GET請求 POST請求響應
2019-04-09
爬蟲

使用RestTemplate，顯示請求資訊，響應資訊

使用RestTemplate，顯示請求資訊，響應資訊

列印請求頭/響應頭

解決不能重複讀Response body

方法一：讀取完後不關閉流

方法二：代理，每次都返回一個新的流

總結

相關文章