RestTemplate的使用

r囧r小猫 2023-10-16 14:00 82阅读 0赞

#### GET请求 ####

在RestTemplate中，发送一个GET请求，我们可以通过如下两种方式：

**第一种：getForEntity**  
getForEntity方法的返回值是一个`ResponseEntity`，`ResponseEntity`是`Spring`对`HTTP`请求响应的封装，包括了几个重要的元素，如**响应码、contentType、contentLength、响应消息体**等。比如下面一个例子：

@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();
    }

*  `getForEntity`的**第一个参数为要调用的服务的地址**，这里调用了服务提供者提供的/hello接口，注意这里是通过**服务名调用而不是服务地址，如果写成服务地址就没法实现客户端负载均衡了**。
 *  `getForEntity`**第二个参数String.class表示希望返回的body类型是String类型**
 *  拿到返回结果之后，将返回结果遍历打印出来  
    **最终显示结果如下**：  
    ![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA55Sw6YeO6YeM55qE56i76I2J5Lq6_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]

**有时候我在调用服务提供者提供的接口时，可能需要传递参数，有两种不同的方式，如下：**

@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();
    }

**运行结果如下：**![在这里插入图片描述][50b8dd24acbb49ebb332821f1ed9e7bb.png_pic_center]

**第二种：getForObject**

getForObject函数实际上是对getForEntity函数的进一步封装，**如果你只关注返回的消息体的内容，对其他信息都不关注，此时可以使用getForObject**，举一个简单的例子，如下：

@RequestMapping("/book2")
    public Book book2() {
        
        Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);
        return book;
    }

**getForObject也有几个重载方法**![在这里插入图片描述][a65816842cb94864955b7540089c0840.png_pic_center]

#### 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，给其他属性设置上值再返回，调用结果如下：**![在这里插入图片描述][e655f843a67e448a9ad57aeb82efd9a8.png_pic_center]

**第二种：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);
    }

#### DELETE请求 ####

delete请求我们可以通过delete方法调用来实现

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

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA55Sw6YeO6YeM55qE56i76I2J5Lq6_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]: https://img-blog.csdnimg.cn/883a0a8c91e848a885e13820a023ee0a.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA55Sw6YeO6YeM55qE56i76I2J5Lq6,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center
[50b8dd24acbb49ebb332821f1ed9e7bb.png_pic_center]: https://img-blog.csdnimg.cn/50b8dd24acbb49ebb332821f1ed9e7bb.png#pic_center
[a65816842cb94864955b7540089c0840.png_pic_center]: https://img-blog.csdnimg.cn/a65816842cb94864955b7540089c0840.png#pic_center
[e655f843a67e448a9ad57aeb82efd9a8.png_pic_center]: https://img-blog.csdnimg.cn/e655f843a67e448a9ad57aeb82efd9a8.png#pic_center