RestTemplate常用方法以及个别示例

逃离我推掉我的手 2024-04-17 15:04 70阅读 0赞

RestTemplate定义了36个与REST资源交互的方法，其中的大多数都对应于HTTP的方法。  
共有11个独立的方法，其中十个有三种重载形式，而第十一个则重载了六次，所以形成了36个方法。

*  **delete()**：在特定的URL上对资源执行HTTP DELETE操作；
 *  **exchange()**：在URL上执行特定的HTTP方法，返回包含对象的ResponseEntity，这个对象是从响应体中映射得到的；
 *  **execute()**：在URL上执行特定的HTTP方法，返回一个从响应体映射得到的对象；
 *  **getForEntity()**：发送一个HTTP GET请求，返回的ResponseEntity包含了响应体所映射成的对象；
 *  **getForObject()**：发送一个HTTP GET请求，返回的请求体将映射为一个对象；
 *  **postForEntity()**：POST 数据到一个URL，返回包含一个对象的ResponseEntity，这个对象是从响应体中映射得到的；
 *  **postForObject()**：POST 数据到一个URL，返回根据响应体匹配形成的对象；
 *  **headForHeaders()**：发送HTTP HEAD请求，返回包含特定资源URL的HTTP头；
 *  **optionsForAllow()**：发送HTTP OPTIONS请求，返回对特定URL的Allow头信息；
 *  **postForLocation()**：POST 数据到一个URL，返回新创建资源的URL；
 *  **put()**：PUT 资源到特定的URL；
 *  **getMessageConverters()**：

## Get请求： ##

![在这里插入图片描述][20190828100331603.png]  
注：getForEntity()的返回值类型是ResponseEntity泛型类

看一下 ResponseEntity 的文档描述:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzM4Mjg0NA_size_16_color_FFFFFF_t_70]  
可以看到 它继承了HttpEntity. 封装了返回的响应信息,包括 响应状态,响应头 和 响应体.

**测试getForEntity()方法：**

1.  无参数的 getForEntity 方法

@RequestMapping("getForEntity")
    public Student getStu() {
        ResponseEntity<Student> responseEntity = restTemplate.getForEntity("http://localhost/getAll", Student.class);
        HttpHeaders headers = responseEntity.getHeaders();	//获取返回信息的请求头
        HttpStatus statusCode = responseEntity.getStatusCode();	
        int code = statusCode.value();	//获取返回信息的响应状态
    
        Student student= responseEntity.getBody();	//获取返回信息的响应体
    
        System.out.println(student.toString());
        return student;
    }

1.  有参数的 getForEntity 请求

@RequestMapping("getForEntity")
    public UserEntity getById2(@RequestBody Student student) {
        ResponseEntity<UserEntity> responseEntity = restTemplate.getForEntity("http://localhost/get",student,UserEntity.class);
        UserEntity userEntity = responseEntity.getBody();
        return userEntity;
    }

1.  有参数的 get 请求,使用map封装参数

@RequestMapping("getForEntity")
    public UserEntity getById2(@RequestBody Student student) {
        HashMap<String, Student> map = new HashMap<>();
        map.put("student",student);
            
        ResponseEntity<UserEntity> responseEntity = restTemplate.getForEntity("http://localhost/get",map,UserEntity.class);
        UserEntity userEntity = responseEntity.getBody();
        return userEntity;
    }

注：通过以上代码，我们可以获取Http请求的全部信息(状态码，响应头，响应体)。但是，通常情况下我们并不想要Http请求的全部信息，只需要相应体即可.对于这种情况，RestTemplate提供了 getForObject() 方法用来只获取 响应体信息。getForObject 和 getForEntity 用法几乎相同，指示返回值返回的是 响应体，省去了我们再去 getBody() 。

**测试getForObject()方法：**

1.  无参数的 getForObject方法

@RequestMapping("getForEntity")
    public Student getStu() {
        Student student= restTemplate.getForObject("http://localhost/getAll", Student.class);
        System.out.println(student.toString());
        return student;
    }

1.  有参数的 getForObject请求

@RequestMapping("getForEntity")
    public UserEntity getById2(@RequestBody Student student) {
        Student student= restTemplate.getForObject("http://localhost/get",student,Student.class);
        return student;
    }

1.  有参数的 get 请求,使用map封装参数

@RequestMapping("getForEntity")
    public UserEntity getById2(@RequestBody Student student) {
        HashMap<String, Student> map = new HashMap<>();
        map.put("student",student);
            
        Student student = restTemplate.getForObject("http://localhost/get",map,Student.class);
        return student ;
    }

## Post请求： ##

**测试postForEntity()方法：**

1.  无参数的 postForEntity方法

@RequestMapping("getForEntity")
    public Student postStu() {
        ResponseEntity<Student> responseEntity = restTemplate.postForEntity("http://localhost/getAll", Student.class);
        HttpHeaders headers = responseEntity.getHeaders();	//获取返回信息的请求头
        HttpStatus statusCode = responseEntity.getStatusCode();	
        int code = statusCode.value();	//获取返回信息的响应状态
    
        Student student= responseEntity.getBody();
    
        System.out.println(student.toString());
        return student;
    }

浏览器访问:  
`http://localhost/getForEntity?username=itguang&password=123456&age=20&email=123@123.com`  
返回的ResponseEntity包含：提交的数据，响应码，响应头，响应体

1.  有参数的 postForEntity 请求

@RequestMapping("getForEntity")
    public UserEntity getById2(@RequestBody Student student) {
        ResponseEntity<UserEntity> responseEntity = restTemplate.postForEntity("http://localhost/get",student,UserEntity.class);
        UserEntity userEntity = responseEntity.getBody();
        return userEntity;
    }

1.  以下示例不再一一列举，情况如此，并无很大差异；

[20190828100331603.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e3826d6a7a304942a2c25ecf802da830.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzM4Mjg0NA_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/8f9a675242c94c12bfd502cc7d3bb09f.png