背景

之前用restTemplate做網(wǎng)絡間的請求，沒遇到過問題。今天先是出現(xiàn)了中文亂碼的問題，而后又出現(xiàn)了特殊字符丟失的問題，于是查找資料及翻看源碼，將問題解決也順便記錄下。

問題一：中文亂碼

描述

在創(chuàng)建課件時，使用GET方法傳遞類型和標題兩個參數(shù)到服務器，服務器返回一個課件編號。類型是固定數(shù)字1，不存在問題，而標題則是用戶輸入字符串，也就是任意字符串。發(fā)現(xiàn)輸入漢字的時候，結(jié)果網(wǎng)絡傳輸后在服務器端出現(xiàn)了亂碼。輸入標題為：開發(fā)測試001，結(jié)果在服務器上接收到的為：%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001。

分析

出現(xiàn)編碼問題，那肯定是對涉及到這個標題的編碼的位置出現(xiàn)了問題，于是查找涉及到的代碼位置：

public String createPptSlide(String title) {
        UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(host + PPT_SLIDE_INSERT);
        builder.queryParam("businessLineId", PPT_BUSINESS_LINE_ID);
        builder.queryParam("slideTitle", title);
        String url = builder.toUriString();
        restTemplate.getForEntity(url, JSONObject.class);
}

此處的String url已經(jīng)是編碼過了的http://xxx.com/slide/insertEmptySlide?businessLineId=1&slideTitle=%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001

于是繼續(xù)追蹤getForEntity方法，在執(zhí)行doExecute方法前，構(gòu)造URI時又進行了一次編碼，如下：

@Override
    public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> urlVariables)
            throws RestClientException {
        RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
        ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
        return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
    }
public <T> T execute(String url, HttpMethod method, RequestCallback requestCallback,
            ResponseExtractor<T> responseExtractor, Map<String, ?> urlVariables) throws RestClientException {
        URI expanded = new UriTemplate(url).expand(urlVariables);
        return doExecute(expanded, method, requestCallback, responseExtractor);
}
public URI expand(Map<String, ?> uriVariables) {
        UriComponents expandedComponents = this.uriComponents.expand(uriVariables);
        UriComponents encodedComponents = expandedComponents.encode();
        return encodedComponents.toUri();
}

結(jié)論

在程序構(gòu)建url時，程序代碼已經(jīng)對title進行了一次編碼，，傳入restTemplate后，restTemplate框架本身又會對其做一次編碼，最后服務器接收到的參數(shù)其實是做了兩次編碼，導致解碼后還是亂碼。

第一次編碼：%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001

第二次編碼：%25E5%25BC%2580%25E5%258F%2591%25E6%25B5%258B%25E8%25AF%2595001

解碼后：%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001

側(cè)面論證：

這里的編碼是URLencode，這個編碼簡單來講就是：將非字母數(shù)字字符都將被替換成百分號（%）后跟兩位十六進制數(shù)?？梢钥吹竭@一串的亂碼%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001很像urlencode后的結(jié)果，解碼后發(fā)現(xiàn)果真是這樣。

方案

傳入url前不對title進行編碼，直接拼接原始的參數(shù)，然后傳入到restTemplate，讓restTemplate框架來進行編碼。這樣解決了中文亂碼的問題，如下：

UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(host + PPT_SLIDE_INSERT);
        builder.queryParam("businessLineId", PPT_BUSINESS_LINE_ID);
        String url = builder.toUriString();
        // 不能 encode 參數(shù)
        if (StringUtils.isNotBlank(title)) {
            url = url + "&slideTitle=" + title;
        }
        restTemplate.getForEntity(url, JSONObject.class);
}

總結(jié)

項目中使用restTemplate的地方，在傳給restTemplate框架url的時候都進行了一次編碼，于是自己也照搬過來，殊不知restTemplate框架本身就會對url進行編碼。

其實從一個框架設計者的角度上將，urlencode是每個請求都會用到的，很順利的可以想到框架會包含這個urlencode功能，不需要編程人員將參數(shù)urlencode。

問題二：特殊字符串丟失

描述

在使用restTemplate傳遞課件標題的時候，發(fā)現(xiàn)有一些特殊字符串有數(shù)據(jù)丟失問題，例如傳遞課件標題：開發(fā)測試001&aaa，接收方接到的是：開發(fā)測試001，后面跟的&aaa字符丟失了。

分析

再一次懷疑是restTemplate里面自帶的編碼導致的問題，于是對比了直接使用urlencode與使用restTemplate編碼的結(jié)果，如下表：

明顯可以發(fā)現(xiàn)restTemplate對特殊字符“&”沒有進行url編碼，導致最后構(gòu)建成的url是這樣的：

http://xxx.com/slide/insertEmptySlide?businessLineId=1&slideTitle=%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001&aaa

這樣就會把&aaa中的aaa當成get請求中的一個參數(shù)來看待，從而得到的title只為：%E5%BC%80%E5%8F%91%E6%B5%8B%E8%AF%95001，導致丟失了&aaa字符，接收方解析也只能得到標題為：開發(fā)測試001。

結(jié)論

restTemplate在進行url編碼的時候，不會對某些特殊字符的編碼，例如&。

方案

既然restTemplate會忽略掉某些特殊字符的url編碼，那么我們就索性不用restTemplate編碼，直接自己編碼好，跳過restTemplate的編碼，實現(xiàn)方案為：

public String createPptSlide(String title) {
        UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(host + PPT_SLIDE_INSERT);
        builder.queryParam("businessLineId", PPT_BUSINESS_LINE_ID);
        builder.queryParam("slideTitle", title);
        URI uri = builder.build().encode().toUri();
        restTemplate.getForEntity(uri, JSONObject.class);
}

（ps：傳String的url，restTemplate都會再一次進行編碼，而直接傳URI可以跳過restTemplate的編碼）

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論