Springboot -- 用更優(yōu)雅的方式發(fā)HTTP請求(RestTemplate詳解)

RestTemplate是Spring提供的用于訪問Rest服務(wù)的客戶端，RestTemplate提供了多種便捷訪問遠(yuǎn)程Http服務(wù)的方法,能夠大大提高客戶端的編寫效率。

我之前的HTTP開發(fā)是用apache的HttpClient開發(fā)，代碼復(fù)雜，還得操心資源回收等雷猪。代碼很復(fù)雜，冗余代碼多晰房，稍微截個(gè)圖求摇，這是我封裝好的一個(gè)post請求工具：

本教程將帶領(lǐng)大家實(shí)現(xiàn)Spring生態(tài)內(nèi)RestTemplate的Get請求和Post請求還有exchange指定請求類型的實(shí)踐和RestTemplate核心方法源碼的分析，看完你就會用優(yōu)雅的方式來發(fā)HTTP請求嫉你。

1. 簡述RestTemplate

是Spring用于同步client端的核心類月帝，簡化了與http服務(wù)的通信，并滿足RestFul原則幽污，程序代碼可以給它提供URL嚷辅，并提取結(jié)果。默認(rèn)情況下距误，RestTemplate默認(rèn)依賴jdk的HTTP連接工具簸搞。當(dāng)然你也可以通過setRequestFactory屬性切換到不同的HTTP源，比如Apache HttpComponents准潭、Netty和OkHttp趁俊。

RestTemplate能大幅簡化了提交表單數(shù)據(jù)的難度，并且附帶了自動轉(zhuǎn)換JSON數(shù)據(jù)的功能刑然，但只有理解了HttpEntity的組成結(jié)構(gòu)（header與body）寺擂，且理解了與uriVariables之間的差異，才能真正掌握其用法泼掠。這一點(diǎn)在Post請求更加突出怔软，下面會介紹到。

該類的入口主要是根據(jù)HTTP的六個(gè)方法制定：

HTTP method	RestTemplate methods
DELETE	delete
GET	getForObject
	getForEntity
HEAD	headForHeaders
OPTIONS	optionsForAllow
POST	postForLocation
	postForObject
PUT	put
any	exchange
	execute

此外择镇，exchange和excute可以通用上述方法挡逼。

在內(nèi)部，RestTemplate默認(rèn)使用HttpMessageConverter實(shí)例將HTTP消息轉(zhuǎn)換成POJO或者從POJO轉(zhuǎn)換成HTTP消息腻豌。默認(rèn)情況下會注冊主mime類型的轉(zhuǎn)換器家坎，但也可以通過setMessageConverters注冊其他的轉(zhuǎn)換器。(其實(shí)這點(diǎn)在使用的時(shí)候是察覺不到的吝梅，很多方法有一個(gè)responseType 參數(shù)虱疏，它讓你傳入一個(gè)響應(yīng)體所映射成的對象，然后底層用HttpMessageConverter將其做映射)

HttpMessageConverterExtractor<T> responseExtractor =
                new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);

HttpMessageConverter.java源碼：

public interface HttpMessageConverter<T> {
        //指示此轉(zhuǎn)換器是否可以讀取給定的類憔涉。
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

        //指示此轉(zhuǎn)換器是否可以寫給定的類订框。
    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

        //返回List<MediaType>
    List<MediaType> getSupportedMediaTypes();

        //讀取一個(gè)inputMessage
    T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;

        //往output message寫一個(gè)Object
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException;

}

在內(nèi)部，RestTemplate默認(rèn)使用SimpleClientHttpRequestFactory和DefaultResponseErrorHandler來分別處理HTTP的創(chuàng)建和錯誤兜叨，但也可以通過setRequestFactory和setErrorHandler來覆蓋穿扳。

2. get請求實(shí)踐

2.1. getForObject()方法

public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables){}
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
public <T> T getForObject(URI url, Class<T> responseType)

getForObject()其實(shí)比getForEntity()多包含了將HTTP轉(zhuǎn)成POJO的功能衩侥，但是getForObject沒有處理response的能力。因?yàn)樗玫绞值木褪浅尚偷?code>pojo矛物。省略了很多response的信息茫死。

2.1.1 POJO:

public class Notice {
    private int status;
    private Object msg;
    private List<DataBean> data;
}
public  class DataBean {
  private int noticeId;
  private String noticeTitle;
  private Object noticeImg;
  private long noticeCreateTime;
  private long noticeUpdateTime;
  private String noticeContent;
}

示例：2.1.2 不帶參的get請求

    /**
     * 不帶參的get請求
     */
    @Test
    public void restTemplateGetTest(){
        RestTemplate restTemplate = new RestTemplate();
        Notice notice = restTemplate.getForObject("http://xxx.top/notice/list/1/5"
                , Notice.class);
        System.out.println(notice);
    }

控制臺打印：

INFO 19076 --- [           main] c.w.s.c.w.c.HelloControllerTest          
: Started HelloControllerTest in 5.532 seconds (JVM running for 7.233)

Notice{status=200, msg=null, data=[DataBean{noticeId=21, noticeTitle='aaa', noticeImg=null, 
noticeCreateTime=1525292723000, noticeUpdateTime=1525292723000, noticeContent='<p>aaa</p>'}, 
DataBean{noticeId=20, noticeTitle='ahaha', noticeImg=null, noticeCreateTime=1525291492000, 
noticeUpdateTime=1525291492000, noticeContent='<p>ah.......'

示例：2.1.3 帶參數(shù)的get請求1

Notice notice = restTemplate.getForObject("http://fantj.top/notice/list/{1}/{2}"
                , Notice.class,1,5);

明眼人一眼能看出是用了占位符{1}履羞。

示例：2.1.4 帶參數(shù)的get請求2

        Map<String,String> map = new HashMap();
        map.put("start","1");
        map.put("page","5");
        Notice notice = restTemplate.getForObject("http://fantj.top/notice/list/"
                , Notice.class,map);

明眼人一看就是利用map裝載參數(shù)峦萎，不過它默認(rèn)解析的是PathVariable的url形式。

2.2 getForEntity()方法

public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables){}
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables){}
public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType){}

與getForObject()方法不同的是返回的是ResponseEntity對象忆首，如果需要轉(zhuǎn)換成pojo爱榔，還需要json工具類的引入，這個(gè)按個(gè)人喜好用糙及。不會解析json的可以百度FastJson或者Jackson等工具類详幽。然后我們就研究一下ResponseEntity下面有啥方法。

ResponseEntity浸锨、HttpStatus唇聘、BodyBuilder結(jié)構(gòu)

ResponseEntity.java

public HttpStatus getStatusCode(){}
public int getStatusCodeValue(){}
public boolean equals(@Nullable Object other) {}
public String toString() {}
public static BodyBuilder status(HttpStatus status) {}
public static BodyBuilder ok() {}
public static <T> ResponseEntity<T> ok(T body) {}
public static BodyBuilder created(URI location) {}
...

HttpStatus.java

public enum HttpStatus {
public boolean is1xxInformational() {}
public boolean is2xxSuccessful() {}
public boolean is3xxRedirection() {}
public boolean is4xxClientError() {}
public boolean is5xxServerError() {}
public boolean isError() {}
}

BodyBuilder.java

public interface BodyBuilder extends HeadersBuilder<BodyBuilder> {
    //設(shè)置正文的長度，以字節(jié)為單位柱搜，由Content-Length標(biāo)頭
      BodyBuilder contentLength(long contentLength);
    //設(shè)置body的MediaType 類型
      BodyBuilder contentType(MediaType contentType);
    //設(shè)置響應(yīng)實(shí)體的主體并返回它迟郎。
      <T> ResponseEntity<T> body(@Nullable T body);
｝

可以看出來，ResponseEntity包含了HttpStatus和BodyBuilder的這些信息聪蘸，這更方便我們處理response原生的東西宪肖。

示例：

@Test
public void rtGetEntity(){
        RestTemplate restTemplate = new RestTemplate();
        ResponseEntity<Notice> entity = restTemplate.getForEntity("http://fantj.top/notice/list/1/5"
                , Notice.class);

        HttpStatus statusCode = entity.getStatusCode();
        System.out.println("statusCode.is2xxSuccessful()"+statusCode.is2xxSuccessful());

        Notice body = entity.getBody();
        System.out.println("entity.getBody()"+body);


        ResponseEntity.BodyBuilder status = ResponseEntity.status(statusCode);
        status.contentLength(100);
        status.body("我在這里添加一句話");
        ResponseEntity<Class<Notice>> body1 = status.body(Notice.class);
        Class<Notice> body2 = body1.getBody();
        System.out.println("body1.toString()"+body1.toString());
    }

statusCode.is2xxSuccessful()true
entity.getBody()Notice{status=200, msg=null, data=[DataBean{noticeId=21, noticeTitle='aaa', ...
body1.toString()<200 OK,class com.waylau.spring.cloud.weather.pojo.Notice,{Content-Length=[100]}>

當(dāng)然，還有getHeaders()等方法沒有舉例健爬。

3. post請求實(shí)踐

同樣的,post請求也有postForObject和postForEntity匈庭。

public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables)
            throws RestClientException {}
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {}
public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {}

示例

我用一個(gè)驗(yàn)證郵箱的接口來測試。

@Test
public void rtPostObject(){
    RestTemplate restTemplate = new RestTemplate();
    String url = "http://47.xxx.xxx.96/register/checkEmail";
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    MultiValueMap<String, String> map= new LinkedMultiValueMap<>();
    map.add("email", "844072586@qq.com");

    HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);
    ResponseEntity<String> response = restTemplate.postForEntity( url, request , String.class );
    System.out.println(response.getBody());
}

執(zhí)行結(jié)果：

{"status":500,"msg":"該郵箱已被注冊","data":null}

代碼中浑劳，MultiValueMap是Map的一個(gè)子類，它的一個(gè)key可以存儲多個(gè)value夭拌，簡單的看下這個(gè)接口：

public interface MultiValueMap<K, V> extends Map<K, List<V>> {...}

為什么用MultiValueMap?因?yàn)?code>HttpEntity接受的request類型是它魔熏。

public HttpEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers){}
我這里只展示它的一個(gè)construct,從它可以看到我們傳入的map是請求體，headers是請求頭鸽扁。

為什么用HttpEntity是因?yàn)?code>restTemplate.postForEntity方法雖然表面上接收的request是@Nullable Object request類型蒜绽，但是你追蹤下去會發(fā)現(xiàn)，這個(gè)request是用HttpEntity來解析桶现。核心代碼如下：

if (requestBody instanceof HttpEntity) {
    this.requestEntity = (HttpEntity<?>) requestBody;
}else if (requestBody != null) {
    this.requestEntity = new HttpEntity<>(requestBody);
}else {
    this.requestEntity = HttpEntity.EMPTY;
}

我曾嘗試用map來傳遞參數(shù)躲雅，編譯不會報(bào)錯，但是執(zhí)行不了骡和，是無效的url request請求(400 ERROR)相赁。其實(shí)這樣的請求方式已經(jīng)滿足post請求了相寇，cookie也是屬于header的一部分∨タ疲可以按需求設(shè)置請求頭和請求體唤衫。其它方法與之類似。

4. 使用exchange指定調(diào)用方式

exchange()方法跟上面的getForObject()绵脯、getForEntity()佳励、postForObject()、postForEntity()等方法不同之處在于它可以指定請求的HTTP類型蛆挫。

但是你會發(fā)現(xiàn)exchange的方法中似乎都有@Nullable HttpEntity<?> requestEntity這個(gè)參數(shù)赃承，這就意味著我們至少要用HttpEntity來傳遞這個(gè)請求體，之前說過源碼所以建議就使用HttpEntity提高性能悴侵。

示例

    @Test
    public void rtExchangeTest() throws JSONException {
        RestTemplate restTemplate = new RestTemplate();
        String url = "http://xxx.top/notice/list";
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        JSONObject jsonObj = new JSONObject();
        jsonObj.put("start",1);
        jsonObj.put("page",5);

        HttpEntity<String> entity = new HttpEntity<>(jsonObj.toString(), headers);
        ResponseEntity<JSONObject> exchange = restTemplate.exchange(url, 
                                          HttpMethod.GET, entity, JSONObject.class);
        System.out.println(exchange.getBody());
    }

這次可以看到瞧剖，我使用了JSONObject對象傳入和返回。

當(dāng)然畜挨，HttpMethod方法還有很多筒繁，用法類似。

5. excute()指定調(diào)用方式

excute()的用法與exchange()大同小異了巴元，它同樣可以指定不同的HttpMethod毡咏，不同的是它返回的對象是響應(yīng)體所映射成的對象<T>，而不是ResponseEntity<T>逮刨。

需要強(qiáng)調(diào)的是呕缭，execute()方法是以上所有方法的底層調(diào)用。隨便看一個(gè)：

    @Override
    @Nullable
    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {

        RequestCallback requestCallback = httpEntityCallback(request, responseType);
        HttpMessageConverterExtractor<T> responseExtractor =
                new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
        return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
    }