spring框架自带的http工具RestTemplate用法

Dear 丶 2023-10-14 17:00 44阅读 0赞

### 1. RestTemplate是什么？ ###

RestTemplate是由Spring框架提供的一个可用于应用中调用rest服务的类它简化了与http服务的通信方式。  
RestTemplate是一个执行HTTP请求的同步阻塞式工具类，它仅仅只是在 HTTP 客户端库（例如 JDK HttpURLConnection，Apache HttpComponents，okHttp 等）基础上，封装了更加简单易用的模板方法 API，方便程序员利用已提供的模板方法发起网络请求和处理，能很大程度上提升我们的开发效率。

### 2. HttpClient、OKhttp、RestTemplate对比 ###

HttpClient：代码复杂，还得操心资源回收等。代码很复杂，冗余代码多，不建议直接使用。

创建HttpClient对象。
    创建请求方法的实例，并指定请求URL。如果需要发送GET请求，创建HttpGet对象；如果需要发送POST请求，创建HttpPost对象。
    如果需要发送请求参数，可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数；对于HttpPost对象而言，也可调用setEntity(HttpEntity entity)方法来设置请求参数。
    调用HttpClient对象的execute(HttpUriRequest request)发送请求，该方法返回一个HttpResponse。
    调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头；调用HttpResponse的getEntity()方法可获取HttpEntity对象，该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
    释放连接。无论执行方法是否成功，都必须释放连接。

okhttp：OkHttp是一个高效的HTTP客户端，允许所有同一个主机地址的请求共享同一个socket连接；连接池减少请求延时；透明的GZIP压缩减少响应数据的大小；缓存响应内容，避免一些完全重复的请求。

RestTemplate： 是 Spring 提供的用于访问Rest服务的客户端， RestTemplate 提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。

## 3. 使用RestTemplate ##

pom

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

初始化

RestTemplate restTemplate = new RestTemplate(); //使用了JDK自带的HttpURLConnection
    RestTemplate restTemplate = new RestTemplate(new HttpComponentsClientHttpRequestFactory());
    //集成 HttpClient客户端
    RestTemplate restTemplate = new RestTemplate(new OkHttp3ClientHttpRequestFactory());
    //集成 okhttp

常用接口和参数:  
getForObject：返回值直接是响应体内容转为的 JSON 对象  
getForEntity：返回值的封装包含有响应头, 响应状态码的 ResponseEntity对象  
url：请求路径  
requestEntity：HttpEntity对象，封装了请求头和请求体  
responseType：返回数据类型  
uriVariables：支持PathVariable类型的数据。

### 4. Get ###

RestTemplate restTemplate = new RestTemplate();
    ResponseEntity<String> entity = restTemplate.getForEntity(uri, String.class);
    // TODO 处理响应

@Test
    public void test1() {
        
        RestTemplate restTemplate = new RestTemplate();
        String url = "http://localhost:8080/chat16/test/get";
        //getForObject方法，获取响应体，将其转换为第二个参数指定的类型
        BookDto bookDto = restTemplate.getForObject(url, BookDto.class);
        System.out.println(bookDto);
    }
     
    @Test
    public void test2() {
        
        RestTemplate restTemplate = new RestTemplate();
        String url = "http://localhost:8080/chat16/test/get";
        //getForEntity方法，返回值为ResponseEntity类型
        // ResponseEntity中包含了响应结果中的所有信息，比如头、状态、body
        ResponseEntity<BookDto> responseEntity = restTemplate.getForEntity(url, BookDto.class);
        //状态码
        System.out.println(responseEntity.getStatusCode());
        //获取头
        System.out.println("头：" + responseEntity.getHeaders());
        //获取body
        BookDto bookDto = responseEntity.getBody();
        System.out.println(bookDto);
    }

@Test
    public void test3() {
        
        RestTemplate restTemplate = new RestTemplate();
        //url中有动态参数
        String url = "http://localhost:8080/chat16/test/get/{id}/{name}";
        Map<String, String> uriVariables = new HashMap<>();
        uriVariables.put("id", "1");
        uriVariables.put("name", "SpringMVC系列");
        //使用getForObject或者getForEntity方法
        BookDto bookDto = restTemplate.getForObject(url, BookDto.class, uriVariables);
        System.out.println(bookDto);
    }
     
    @Test
    public void test4() {
        
        RestTemplate restTemplate = new RestTemplate();
        //url中有动态参数
        String url = "http://localhost:8080/chat16/test/get/{id}/{name}";
        Map<String, String> uriVariables = new HashMap<>();
        uriVariables.put("id", "1");
        uriVariables.put("name", "SpringMVC系列");
        //getForEntity方法
        ResponseEntity<BookDto> responseEntity = restTemplate.getForEntity(url, BookDto.class, uriVariables);
        BookDto bookDto = responseEntity.getBody();
        System.out.println(bookDto);
    }

### 5. Post ###

RestTemplate restTemplate = new RestTemplate();
    // headers
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
    HttpEntity<Object> objectHttpEntity = new HttpEntity<>(headers);
    
    ResponseEntity<String> entity = restTemplate.postForEntity(uri, request, String.class);
    // TODO 处理响应

public static void main(String[] args) {
        
            RestTemplate restTemplate = new RestTemplate();
            //三种方式请求
            String url = "https://restapi.amap.com/v3/weather/weatherInfo?city=110101&key=3ff9482454cb60bcb73f65c8c48d4209](https://restapi.amap.com/v3/weather/weatherInfo?city=110101&key=3ff9482454cb60bcb73f65c8c48d4209)";
            Map<String,Object> params=new HashMap<>();
            ResponseEntity<String> result = restTemplate.postForEntity(url,params, String.class);
            System.out.println(result.getStatusCode().getReasonPhrase());
            System.out.println(result.getStatusCodeValue());
            System.out.println(result.getBody());
        }

@Autowired
    private RestTemplate restTemplate;
    
    /**
     * 模拟表单提交，post请求
     */
    @Test
    public void testPostByForm(){
        
        //请求地址
        String url = "http://localhost:8080/testPostByForm";
    
        // 请求头设置,x-www-form-urlencoded格式的数据
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    
        //提交参数设置
        MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
        map.add("userName", "唐三藏");
        map.add("userPwd", "123456");
    
        // 组装请求体
        HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);
    
        //发起请求
        ResponseBean responseBean = restTemplate.postForObject(url, request, ResponseBean.class);
        System.out.println(responseBean.toString());
    }

### 6. Put ###

@Autowired
    private RestTemplate restTemplate;
    /**
     * 模拟JSON提交，put请求
     */
    @Test
    public void testPutByJson(){
        
        //请求地址
        String url = "http://localhost:8080/testPutByJson";
        //入参
        RequestBean request = new RequestBean();
        request.setUserName("唐三藏");
        request.setUserPwd("123456789");
    
        //模拟JSON提交，put请求
        restTemplate.put(url, request);
    }

### 7. Delete ###

@Autowired
    private RestTemplate restTemplate;
    /**
     * 模拟JSON提交，delete请求
     */
    @Test
    public void testDeleteByJson(){
        
        //请求地址
        String url = "http://localhost:8080/testDeleteByJson";
    
        //模拟JSON提交，delete请求
        restTemplate.delete(url);
    }