RestTemplate 詳解

時間 2021-02-14

標籤 html java segmentfault app 負載均衡函數 post spa .net 欄目 HTML 简体版

原文原文鏈接

背景

這段時間本身作的項目中須要調用服務提供者的服務（接口），具體就是：我這邊須要將頁面所輸入的 Groovy 腳本代碼傳給別人提供的服務接口，而後那邊返回腳本編譯的結果給我，我須要將編譯結果展現在頁面，用的就是 RestTemplate 了，那 RestTemplate 是什麼呢？簡單說就是：簡化了發起 HTTP 請求以及處理響應的過程，而且支持 REST 。下文就稍微總結下。
html

如何使用

先講講如何使用吧，我項目是 SpringBoot 項目，能夠在啓動類中加入：java

@Bean
public RestTemplate restTemplate() {
  return new RestTemplate();
}

而後在 Controller 層中引入：segmentfault

@Autowired
private RestTemplate restTemplate;

接下來就能夠在 Controller 中各個方法中使用 restTemplate 了，可是 restTemplate 裏面有什麼方法呢？app

RestTemplate 內部方法

從圖中 RestTemplate 能夠看到有不少方法，咱們能夠提取出主要的幾種方法是：負載均衡

GET
POST
PUT
DELETE
HEAD
OPTIONS
EXCHANGE
EXECUTE

圖片中依然能夠知道 RestTemplate 類中的方法主要是來自接口 RestOperations，下面咱們具體看看這些方法裏面的具體實現與該如何使用。函數

Get 方法

在 RestTemplate 中，發送一個 GET 請求，咱們能夠經過以下兩種方式：post

getForEntityui

getForEntity 方法的返回值是一個ResponseEntity<T>，ResponseEntity<T>是 Spring 對 HTTP 請求響應的封裝，包括了幾個重要的元素，如響應碼、contentType、contentLength、響應消息體等。好比下面一個例子：spa
```
@RequestMapping("/gethello")
public String getHello() {
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/hello", String.class);
    String body = responseEntity.getBody();
    HttpStatus statusCode = responseEntity.getStatusCode();
    int statusCodeValue = responseEntity.getStatusCodeValue();
    HttpHeaders headers = responseEntity.getHeaders();
    StringBuffer result = new StringBuffer();
    result.append("responseEntity.getBody()：").append(body).append("<hr>")
            .append("responseEntity.getStatusCode()：").append(statusCode).append("<hr>")
            .append("responseEntity.getStatusCodeValue()：").append(statusCodeValue).append("<hr>")
            .append("responseEntity.getHeaders()：").append(headers).append("<hr>");
    return result.toString();
}
```
關於這段代碼，說以下幾點：.net
- getForEntity 的第一個參數爲我要調用的服務的地址，這裏我調用了服務提供者提供的 /hello 接口，注意這裏是經過服務名調用而不是服務地址，若是寫成服務地址就無法實現客戶端負載均衡了。（備註：我項目中須要經過 ConsulClient 去獲取服務名，而後在去獲取服務的 IP 和 Port，並把它拼接起來組合成個人服務地址，因此就無法實現客戶端的負載均衡了，若是要是實現負載均衡，能夠在 SpringBoot 啓動類的中加入註解 @LoadBalanced, 以下:
```
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
  return new RestTemplate();
}
```
  ）
- getForEntity 第二個參數 String.class 表示我但願返回的 body 類型是 String
- 拿到返回結果以後，將返回結果遍歷打印出來

有時候我在調用服務提供者提供的接口時，可能須要傳遞參數，有兩種不一樣的方式:

@RequestMapping("/sayhello")
public String sayHello() {
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={1}", String.class, "張三");
    return responseEntity.getBody();
}
@RequestMapping("/sayhello2")
public String sayHello2() {
    Map<String, String> map = new HashMap<>();
    map.put("name", "李四");
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={name}", String.class, map);
    return responseEntity.getBody();
}

能夠用一個數字作佔位符，最後是一個可變長度的參數，來一一替換前面的佔位符
也能夠前面使用 name={name} 這種形式，最後一個參數是一個 map，map 的 key 即爲前邊佔位符的名字，map的 value 爲參數值

第一個調用地址也能夠是一個URI而不是字符串，這個時候咱們構建一個URI便可，參數神馬的都包含在URI中了，以下：

@RequestMapping("/sayhello3")
public String sayHello3() {
    UriComponents uriComponents = UriComponentsBuilder.fromUriString("http://HELLO-SERVICE/sayhello?name={name}").build().expand("王五").encode();
    URI uri = uriComponents.toUri();
    ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);
    return responseEntity.getBody();
}

經過Spring中提供的UriComponents來構建Uri便可。

固然，服務提供者不只能夠返回String，也能夠返回一個自定義類型的對象，好比個人服務提供者中有以下方法：

@RequestMapping(value = "/getbook1", method = RequestMethod.GET)
public Book book1() {
    return new Book("三國演義", 90, "羅貫中", "花城出版社");
}

對於該方法我能夠在服務消費者中經過以下方式來調用：

@RequestMapping("/book1")
public Book book1() {
    ResponseEntity<Book> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/getbook1", Book.class);
    return responseEntity.getBody();
}

運行結果以下：

getForObject

getForObject 函數其實是對 getForEntity 函數的進一步封裝，若是你只關注返回的消息體的內容，對其餘信息都不關注，此時可使用 getForObject，舉一個簡單的例子，以下：
```
@RequestMapping("/book2")
public Book book2() {
    Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);
    return book;
}
```

POST 方法

在 RestTemplate 中，POST 請求能夠經過以下三個方法來發起：

postForEntity

該方法和get請求中的getForEntity方法相似，以下例子：

@RequestMapping("/book3")
public Book book3() {
    Book book = new Book();
    book.setName("紅樓夢");
    ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://HELLO-SERVICE/getbook2", book, Book.class);
    return responseEntity.getBody();
}

方法的第一參數表示要調用的服務的地址
方法的第二個參數表示上傳的參數
方法的第三個參數表示返回的消息體的數據類型

我這裏建立了一個Book對象，這個Book對象只有name屬性有值，將之傳遞到服務提供者那裏去，服務提供者代碼以下：

@RequestMapping(value = "/getbook2", method = RequestMethod.POST)
public Book book2(@RequestBody Book book) {
    System.out.println(book.getName());
    book.setPrice(33);
    book.setAuthor("曹雪芹");
    book.setPublisher("人民文學出版社");
    return book;
}

服務提供者接收到服務消費者傳來的參數book，給其餘屬性設置上值再返回，調用結果以下：

postForObject

若是你只關注，返回的消息體，能夠直接使用postForObject。用法和getForObject一致。
postForLocation

postForLocation 也是提交新資源，提交成功以後，返回新資源的 URI，postForLocation 的參數和前面兩種的參數基本一致，只不過該方法的返回值爲 URI ，這個只須要服務提供者返回一個 URI 便可，該 URI 表示新資源的位置。

PUT 方法

在 RestTemplate 中，PUT 請求能夠經過 put 方法調用，put 方法的參數和前面介紹的 postForEntity 方法的參數基本一致，只是 put 方法沒有返回值而已。舉一個簡單的例子，以下：

@RequestMapping("/put")
public void put() {
    Book book = new Book();
    book.setName("紅樓夢");
    restTemplate.put("http://HELLO-SERVICE/getbook3/{1}", book, 99);
}

book對象是我要提交的參數，最後的99用來替換前面的佔位符{1}

DELETE 方法

delete 請求咱們能夠經過 delete 方法調用來實現，以下例子：

@RequestMapping("/delete")
public void delete() {
    restTemplate.delete("http://HELLO-SERVICE/getbook4/{1}", 100);
}

HEADER 方法

返回資源的全部 HTTP headers。

OPTIONS

問能夠執行哪些方法。

EXCHANGE

與其它接口的不一樣：

容許調用者指定HTTP請求的方法（GET,POST,PUT等）
能夠在請求中增長body以及頭信息，其內容經過參數 HttpEntity<?>requestEntity 描述
exchange支持‘含參數的類型’（即泛型類）做爲返回類型，該特性經過 ParameterizedTypeReference<T>responseType 描述