SpringBoot 如何使用 RestTemplate 優(yōu)雅的進行 Restful 資源訪問痛单?

1、在 pom.xml 里引入依賴:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2劲腿、直接使用 new RestTemplate() 使用 RestTemplate

示例代碼(注意這有坑旭绒,下面解釋):

String baiduHtml = new RestTemplate().getForObject("https://www.baidu.com", String.class);
System.out.println(baiduHtml);

注:不能直接使用 @Autowired 自動注入 RestTemplate 使用。因為谆棱,官網(wǎng)文檔有寫:

Since RestTemplate instances often need to be customized before being used, Spring Boot does not provide any single auto-configured RestTemplate bean.

3快压、使用 RestTemplateBuilder,官網(wǎng)文檔也有寫垃瞧,提供了自動配置的 RestTemplateBuilder蔫劣,可以用 RestTemplateBuilder 創(chuàng)建 RestTemplate

示例代碼:

@Autowired
private RestTemplateBuilder restTemplateBuilder;
@Autowired
private RestTemplate restTemplate;
@Bean
public RestTemplate getRestTemplate() {
    return restTemplateBuilder.build();
}

//調(diào)用方式:
String baiduHtml = restTemplate.getForObject("https://www.baidu.com", String.class);
System.out.println(baiduHtml);

這樣處理之后(在 SpringBootApplication 入口中定義),在任何地方就可以直接使用自動配置的 RestTemplate 了个从。

4脉幢、編寫配置類使用:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
@Configuration
public class RestTemplateConfig {
    @Autowired
    private RestTemplateBuilder restTemplateBuilder;
    @Bean
    public RestTemplate restTemplate(){
        return restTemplateBuilder.build();
    }
}

然后就可以在其他地方直接使用 @Autowired 注入使用了歪沃。

通過以上三種方式(2、3嫌松、4)都可以使用 RestTemplate 訪問第三方接口沪曙,但是上面說的有個坑,在這里:
使用 new RestTemplate()RestTemplateBuilder 創(chuàng)建的 RestTemplate 訪問的時候萎羔,編碼有問題液走,我使用 new RestTemplate() 訪問百度,得到亂碼的HTML贾陷,但是使用 RestTemplateBuilder 創(chuàng)建的 RestTemplate 訪問的時候缘眶,確是正常的!K璺稀巷懈!

來看源碼,一探究竟:
通過集成 actuator 查看所有 beans 發(fā)現(xiàn)這么一個 Bean

"restTemplateBuilder": {
  aliases: [ ],
  scope: "singleton",
  type: "org.springframework.boot.web.client.RestTemplateBuilder",
  resource: "class path resource [org/springframework/boot/autoconfigure/web/client/RestTemplateAutoConfiguration.class]",
  dependencies: [ ]
}

根據(jù) resource 找到這個 RestTemplateAutoConfiguration 類:

@Configuration
@AutoConfigureAfter({HttpMessageConvertersAutoConfiguration.class})
@ConditionalOnClass({RestTemplate.class})
public class RestTemplateAutoConfiguration {
    private final ObjectProvider<HttpMessageConverters> messageConverters;
    private final ObjectProvider<RestTemplateCustomizer> restTemplateCustomizers;

    public RestTemplateAutoConfiguration(ObjectProvider<HttpMessageConverters> messageConverters, ObjectProvider<RestTemplateCustomizer> restTemplateCustomizers) {
        this.messageConverters = messageConverters;
        this.restTemplateCustomizers = restTemplateCustomizers;
    }

    @Bean
    @ConditionalOnMissingBean
    public RestTemplateBuilder restTemplateBuilder() {
        RestTemplateBuilder builder = new RestTemplateBuilder(new RestTemplateCustomizer[0]);
        HttpMessageConverters converters = (HttpMessageConverters)this.messageConverters.getIfUnique();
        if(converters != null) {
            builder = builder.messageConverters(converters.getConverters());
            //↑ ↑ ↑ 看這里慌洪,猜測編碼轉(zhuǎn)換應(yīng)該是這里加入了轉(zhuǎn)換器
        }

        List customizers = (List)this.restTemplateCustomizers.orderedStream().collect(Collectors.toList());
        if(!CollectionUtils.isEmpty(customizers)) {
            builder = builder.customizers(customizers);
        }

        return builder;
    }
}

看這個類上面有注解:

@AutoConfigureAfter({HttpMessageConvertersAutoConfiguration.class})

顧名思義顶燕,是在 HttpMessageConvertersAutoConfiguration 這個配置類之后配置此類。繼續(xù)進入 HttpMessageConvertersAutoConfiguration 類:

@Configuration
@ConditionalOnClass({HttpMessageConverter.class})
@AutoConfigureAfter({GsonAutoConfiguration.class, JacksonAutoConfiguration.class, JsonbAutoConfiguration.class})
@Import({JacksonHttpMessageConvertersConfiguration.class, GsonHttpMessageConvertersConfiguration.class, JsonbHttpMessageConvertersConfiguration.class})
public class HttpMessageConvertersAutoConfiguration {
    static final String PREFERRED_MAPPER_PROPERTY = "spring.http.converters.preferred-json-mapper";
    private final List<HttpMessageConverter<?>> converters;

    public HttpMessageConvertersAutoConfiguration(ObjectProvider<HttpMessageConverter<?>> convertersProvider) {
        this.converters = (List)convertersProvider.orderedStream().collect(Collectors.toList());
    }

    @Bean
    @ConditionalOnMissingBean
    public HttpMessageConverters messageConverters() {
        return new HttpMessageConverters(this.converters);
    }

    @Configuration
    @ConditionalOnClass({StringHttpMessageConverter.class})
    @EnableConfigurationProperties({HttpProperties.class})
    protected static class StringHttpMessageConverterConfiguration {
        private final Encoding properties;

        protected StringHttpMessageConverterConfiguration(HttpProperties httpProperties) {
            this.properties = httpProperties.getEncoding();
        }

        @Bean
        @ConditionalOnMissingBean
        public StringHttpMessageConverter stringHttpMessageConverter() {
            StringHttpMessageConverter converter = new StringHttpMessageConverter(this.properties.getCharset());
            converter.setWriteAcceptCharset(false);
            return converter;
        }
    }
}

可以看到這個類中有一個 protected 的內(nèi)部類冈爹,里面配置了名為 StringHttpMessageConverterBean涌攻,他內(nèi)部使用了 HttpProperties.class 這個配置類里面的配置,再深入 HttpProperties 看看犯助,代碼過多癣漆,所以省略了很多:

@ConfigurationProperties(
    prefix = "spring.http"
)
public class HttpProperties {
    private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();

    //...省略其他代碼

    public HttpProperties.Encoding getEncoding() {
        return this.encoding;
    }

    public static class Encoding {
        public static final Charset DEFAULT_CHARSET;
        private Charset charset;

        public Encoding() {
            this.charset = DEFAULT_CHARSET;
        }

        public Charset getCharset() {
            return this.charset;
        }
        
        //...省略其他代碼
        
        static {
            DEFAULT_CHARSET = StandardCharsets.UTF_8;
        }
        //...省略其他代碼
    }
}

到這里似乎就漸漸明白了,如果使用 RestTemplateBuilder 創(chuàng)建的 RestTemplate剂买,它默認就是用了 spring.http.encoding.charset 這個配置的編碼惠爽。在 application.properties 中配置的時候,可以看到這個編碼默認就是 UTF-8瞬哼,截圖如下:

spring.http.encoding.charset

那么我們來實驗一下婚肆,修改 application.properties 增加配置:

spring.http.encoding.charset=ISO-8859-1

如果不出意外,使用 RestTemplateBuilder 創(chuàng)建的 RestTemplate 訪問的時候應(yīng)該是會是亂碼坐慰。

    @Autowired
    private RestTemplate restTemplate;
    private String getRestResponse(String url) {
        try {
            return new RestTemplate().getForObject(url, String.class);
        } catch(Exception ex) {
            return ex.toString();
        }
    }
    private String getRestResponse2(String url) {
        try {
            return restTemplate.getForObject(url, String.class);
        } catch(Exception ex) {
            return ex.toString();
        }
    }
    @Override
    public void run(ApplicationArguments applicationArguments) throws Exception {
        System.out.println(getRestResponse("https://www.baidu.com"));
        System.out.println(getRestResponse2("https://www.baidu.com"));
    }

此時较性,第二種方式獲取到的百度源代碼和第一種方式獲取到的源代碼一致,都是亂碼结胀,可見直接使用 new RestTemplate() 將使用默認編碼 ISO-8859-1赞咙。

那么問題來了,如何在使用 new RestTemplate() 的時候同樣是 UTF-8 編碼呢糟港?在創(chuàng)建 RestTemplate 之后做一點處理即可攀操,代碼如下:

    private String getRestResponse(String url) {
        try {
            RestTemplate rest = new RestTemplate();
            for (HttpMessageConverter<?> converter : rest.getMessageConverters()) {
                if (converter instanceof StringHttpMessageConverter) {
                    ((StringHttpMessageConverter)converter).setDefaultCharset(Charset.forName("UTF-8"));
                    break;
                }
            }
            return rest.getForObject(url, String.class);
        } catch(Exception ex) {
            return ex.toString();
        }
    }

此時,RestTemplate 亂碼問題已經(jīng)得到解決秸抚。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末速和,一起剝皮案震驚了整個濱河市歹垫,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌颠放,老刑警劉巖排惨,帶你破解...
    沈念sama閱讀 216,372評論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異碰凶,居然都是意外死亡暮芭,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3 392
  • 文/潘曉璐 我一進店門痒留,熙熙樓的掌柜王于貴愁眉苦臉地迎上來谴麦,“玉大人蠢沿,你說我怎么就攤上這事伸头。” “怎么了舷蟀?”我有些...
    開封第一講書人閱讀 162,415評論 0 353
  • 文/不壞的土叔 我叫張陵恤磷,是天一觀的道長。 經(jīng)常有香客問我野宜,道長扫步,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,157評論 1 292
  • 正文 為了忘掉前任匈子,我火速辦了婚禮河胎,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘虎敦。我一直安慰自己游岳,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,171評論 6 388
  • 文/花漫 我一把揭開白布其徙。 她就那樣靜靜地躺著胚迫,像睡著了一般。 火紅的嫁衣襯著肌膚如雪唾那。 梳的紋絲不亂的頭發(fā)上访锻,一...
    開封第一講書人閱讀 51,125評論 1 297
  • 那天,我揣著相機與錄音闹获,去河邊找鬼期犬。 笑死,一個胖子當(dāng)著我的面吹牛避诽,可吹牛的內(nèi)容都是我干的龟虎。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼茎用,長吁一口氣:“原來是場噩夢啊……” “哼遣总!你這毒婦竟也來了睬罗?” 一聲冷哼從身側(cè)響起旭斥,我...
    開封第一講書人閱讀 38,887評論 0 274
  • 序言:老撾萬榮一對情侶失蹤容达,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后垂券,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體算芯,經(jīng)...
    沈念sama閱讀 45,310評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,533評論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了兜辞。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,690評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡啸罢,死狀恐怖允懂,靈堂內(nèi)的尸體忽然破棺而出蕾总,到底是詐尸還是另有隱情,我是刑警寧澤杨凑,帶...
    沈念sama閱讀 35,411評論 5 343
  • 正文 年R本政府宣布窍仰,位于F島的核電站,受9級特大地震影響啄枕,放射性物質(zhì)發(fā)生泄漏脆淹。R本人自食惡果不足惜蝗蛙,卻給世界環(huán)境...
    茶點故事閱讀 41,004評論 3 325
  • 文/蒙蒙 一泰涂、第九天 我趴在偏房一處隱蔽的房頂上張望陕截。 院中可真熱鬧驳棱,春花似錦、人聲如沸农曲。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽乳规。三九已至形葬,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間暮的,已是汗流浹背笙以。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1 268
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留冻辩,地道東北人猖腕。 一個月前我還...
    沈念sama閱讀 47,693評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像微猖,于是被迫代替她去往敵國和親谈息。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,577評論 2 353

推薦閱讀更多精彩內(nèi)容

  • 文章核心 其實凛剥,本不想把標(biāo)題寫的那么恐怖侠仇,只是發(fā)現(xiàn)很多人干了幾年java以后,都自認為是一個不錯的java程序員了...
    java菜閱讀 1,919評論 6 49
  • 什么是Spring Spring是一個開源的Java EE開發(fā)框架。Spring框架的核心功能可以應(yīng)用在任何Jav...
    jemmm閱讀 16,461評論 1 133
  • 文章作者:Tyan博客:noahsnail.com 3.4 Dependencies A typical ente...
    SnailTyan閱讀 4,151評論 2 7
  • 最近想系統(tǒng)的學(xué)習(xí)一下Spring的相關(guān)知識逻炊,在這里分享一下互亮。也希望能幫助那些對英文技術(shù)文檔閱讀比較困難的朋友。接下...
    Aiibai閱讀 1,555評論 5 16
  • 昨天收看韋志中網(wǎng)絡(luò)學(xué)校的校長時間余素,老師講了一句話我很受觸動:一個人要成就一件事豹休,一定要有信心,有方向桨吊、有方法威根、有行...
    茶話心語閱讀 134評論 0 0