【SpringBoot】SpringBoot 之RestTemplate的使用

RestTemplate介紹

　　調用遠程服務時就必須使用HTTP客戶端,主要有四種：JDK原生的URLConnection、Apache的Http Client、Netty的異步HTTP Client, Spring的RestTemplate。　　

　　解放了原先HttpClient的復雜提交，java中調用RESTful服務很典型的是使用HttpClient，對於常用的REST操作，這些方法屬於低等級的操作。使用HttpClient我們需要自己封裝Post請求，再根據響應的狀態碼判斷從響應中獲取header和body，有時候還需要自己做json轉換。

　　Spring框架提供的RestTemplate類可用於在應用中調用rest服務，它簡化了與http服務的通信方式，統一了RESTful的標准，封裝了http鏈接， 我們只需要傳入url及返回值類型即可。相較於之前常用的HttpClient，RestTemplate是一種更優雅的調用RESTful服務的方式。

　　在Spring應用程序中訪問第三方REST服務與使用Spring RestTemplate類有關。RestTemplate類的設計原則與許多其他Spring *模板類(例如JdbcTemplate、JmsTemplate)相同，為執行復雜任務提供了一種具有默認行為的簡化方法。

　　RestTemplate默認依賴JDK提供http連接的能力（HttpURLConnection），如果有需要的話也可以通過setRequestFactory方法替換為例如 Apache HttpComponents、Netty或OkHttp等其它HTTP library。

　　考慮到RestTemplate類是為調用REST服務而設計的，因此它的主要方法與REST的基礎緊密相連就不足為奇了，后者是HTTP協議的方法:HEAD、GET、POST、PUT、DELETE和OPTIONS。例如，RestTemplate類具有headForHeaders()、getForObject()、postForObject()、put()和delete()等方法。

RestTemplate實現

　　最新api地址：https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/RestTemplate.html

　　RestTemplate包含以下幾個部分：

• HttpMessageConverter 對象轉換器
• ClientHttpRequestFactory 默認是JDK的HttpURLConnection
• ResponseErrorHandler 異常處理
• ClientHttpRequestInterceptor 請求攔截器

　　RestTemplate是spring的一個rest客戶端，在spring-web這個包下，spring boot的依賴如下：

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

　　點進去可以看到spring-web

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>5.1.9.RELEASE</version>
</dependency>

　　所以如果在非spring的框架下直接引入spring-web這個包即可。

　　RestTemplate有三個實現

package org.springframework.web.client;

public class RestTemplate extends InterceptingHttpAccessor implements RestOperations {

    ...

    public RestTemplate() {
        ...
    }

    public RestTemplate(ClientHttpRequestFactory requestFactory) {
        ...
    }

    public RestTemplate(List<HttpMessageConverter<?>> messageConverters) {
        ...
    }
}

RestTemplate使用

　　新建一個SpringBoot Web工程，引入依賴spring-boot-starter-web

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

　　1、restTemplate獲取字符串

　　　　REST API代碼

@RequestMapping(value = "/employees", produces = MediaType.TEXT_HTML_VALUE, method = RequestMethod.GET)
public String getAllEmployeesHtml(Model model)
{
    model.addAttribute("employees", employeeMapper.getEmps());
    return "employees";
}

　　　　REST客戶端代碼

// 獲取字符串
@Test
public void test01() {
    String url = "http://localhost:8080/employees";
            String res1 = restTemplate.getForObject(url, String.class);
    System.out.println("getForObject======" + res1);
}

　　2、使用RestTemplate的自定義HTTP標頭

　　　　REST API代碼

@RequestMapping(value = "/employees", produces = MediaType.APPLICATION_JSON_VALUE,  method = RequestMethod.GET)
@ResponseBody
public List<Employee>  getAllEmployeesJSON()
{
    return employeeMapper.getEmps();
}

　　　　REST客戶端代碼

// 使用RestTemplate的自定義HTTP標頭
@Test
public void test02(){
    String url = "http://localhost:8080/employees";
            HttpHeaders headers = new HttpHeaders();
    headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    HttpEntity<String> entity = new HttpEntity<String>("parameters", headers);

    ResponseEntity<String> res2 = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
    System.out.println("exchange======" + res2);
}

　　3、獲取響應作為對象

　　　　REST API代碼

@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
@ResponseBody
public Employee get(@PathVariable("id") Integer id){
    return employeeMapper.getEmpById(id);
}

　　　　REST客戶端代碼

// 獲取響應作為對象
@Test
public void test03(){
    String url = "http://localhost:8080/employee/1";

    Employee res3 = restTemplate.getForObject(url, Employee.class);
    System.out.println("getForObject======" + res3);
}

// 獲取響應作為對象，並獲取響應對象狀態
@Test
public void test033(){
    String url = "http://localhost:8080/employee/1";
    ResponseEntity<Employee> res3 = restTemplate.getForEntity(url, Employee.class);
    System.out.println("getStatusCode======" + res3.getStatusCode());
    System.out.println("getForEntity======" + res3);
}

　　4、URL參數

　　　　REST API代碼

@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
@ResponseBody
public Employee get(@PathVariable("id") Integer id){
    return employeeMapper.getEmpById(id);
}

　　　　REST客戶端代碼

// URL參數
@Test
public void test04(){
    String url = "http://localhost:8080/employee/{id}";

    Map<String, String> params = new HashMap<String, String>();
    params.put("id", "1");
    Employee res4 = restTemplate.getForObject(url, Employee.class, params);
    System.out.println("getForObject======" + res4);
}

 　　5、HTTP POST方法

　　　　REST API代碼

@RequestMapping(value = "/employee", method = RequestMethod.POST)
@ResponseBody
public String save(@RequestBody Employee employee){
    System.out.println("post ====" + employee);
    return "success";
}

　　　　REST客戶端代碼

// HTTP POST方法
@Test
public void test05(){
    String url = "http://localhost:8080/employee";

    Employee newEmployee = new Employee(-1, "小黑", "1", "[e-mail]");
    String res5 = restTemplate.postForObject(url, newEmployee, String.class);
    System.out.println("postForObject======" + res5);
}

　　6、HTTP PUT方法示例

　　　　REST API代碼

@RequestMapping(value = "/employee", method = RequestMethod.PUT)
@ResponseBody
public String update(@RequestBody Employee employee){
    System.out.println("put ====" + employee);
    return "success";
}

　　　　REST客戶端代碼

// HTTP PUT方法示例
@Test
public void test06(){
    String url = "http://localhost:8080/employee";
    Employee newEmployee = new Employee(-1, "小黑", "1", "[e-mail]");
    restTemplate.put(url, newEmployee);
}

　　7、HTTP DELETE方法示例

　　　　REST API代碼

@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
@ResponseBody
public String delete(@PathVariable("id") Integer id){
    System.out.println("delete ====" + id);
    return "success";
}

　　　　REST客戶端代碼

// HTTP DELETE方法示例
@Test
public void test07(){
    String url = "http://localhost:8080/employee/1";
    restTemplate.delete(url);
}