精讲RestTemplate-POST请求方法使用详解

谁借莪１个温暖的怀抱￠ 2022-11-21 15:20 1097阅读 0赞

**前言：**

其实POST请求方法和GET请求方法上大同小异，RestTemplate的POST请求也包含两个主要方法：

*  postForObject()
 *  postForEntity()

> 二者的主要区别在于，postForObject()返回值是HTTP协议的响应体。postForEntity()返回的是ResponseEntity，ResponseEntity是对HTTP响应的封装，除了包含响应体，还包含HTTP状态码、contentType、contentLength、Header等信息。

**一、postForObject发送JSON格式请求**

写一个单元测试用例，测试用例的内容是向指定的URL提交一个Post。

@SpringBootTest
    class PostTests { 
    
       @Resource
       private RestTemplate restTemplate;
    
       @Test
       void testSimple()  { 
          // 请求地址
          String url = "http://jsonplaceholder.typicode.com/posts";
    
          // 要发送的数据对象
          PostDTO postDTO = new PostDTO();
          postDTO.setUserId(110);
          postDTO.setTitle("zimug 发布文章");
          postDTO.setBody("zimug 发布文章 测试内容");
    
          // 发送post请求，并输出结果
          PostDTO result = restTemplate.postForObject(url, postDTO, PostDTO.class);
          System.out.println(result);
       }
    }

*  jsonplaceholder.typicode.com是一个可以提供在线免费RESTful测试服务的一个网站。
 *  ”/posts"服务接收PostDTO参数对象，并将请求结果以JSON字符串的形式进行响应。响应结果就是请求参数对象对应的JSON字符串。
 *  所以postForObject方法第二个参数是请求数据对象，第三个参数是返回值类型。

最终将返回值的打印结果如下：

![在这里插入图片描述][20201102164956828.png_pic_center]

**二、postForObject模拟表单数据提交**

下面给大家写一个使用postForObject模拟表单数据提交的例子，即：提交x-www-form-urlencoded格式的数据。

@Test
    public void testForm() { 
       // 请求地址
       String url = "http://jsonplaceholder.typicode.com/posts";
    
       // 请求头设置,x-www-form-urlencoded格式的数据
       HttpHeaders headers = new HttpHeaders();
       headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    
       //提交参数设置
       MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
       map.add("title", "zimug 发布文章第二篇");
       map.add("body", "zimug 发布文章第二篇 测试内容");
    
       // 组装请求体
       HttpEntity<MultiValueMap<String, String>> request =
                   new HttpEntity<MultiValueMap<String, String>>(map, headers);
    
       // 发送post请求，并打印结果，以String类型接收响应结果JSON字符串
       String result = restTemplate.postForObject(url, request, String.class);
       System.out.println(result);
    }

请求数据打印结果如下：

![在这里插入图片描述][20201102165113732.png_pic_center]

**三、 url支持占位符语法**

如果url地址上面需要传递一些动态参数，可以使用占位符的方式：

String url = "http://jsonplaceholder.typicode.com/{1}/{2}";
    String url = "http://jsonplaceholder.typicode.com/{type}/{id}";

**四、postForEntity()方法**

上面的所有的postForObject请求传参方法，postForEntity都可以使用，使用方法上也几乎是一致的，只是在返回结果接收的时候略有差别。使用`ResponseEntity<T> responseEntity`  
来接收响应结果。用responseEntity.getBody()获取响应体。响应体内容同postForObject方法返回结果一致。剩下的这些响应信息就是postForEntity比postForObject多出来的内容。

*  HttpStatus statusCode = responseEntity.getStatusCode();获取整体的响应状态信息
 *  int statusCodeValue = responseEntity.getStatusCodeValue(); 获取响应码值
 *  HttpHeaders headers = responseEntity.getHeaders();获取响应头等

@Test
    public void testEntityPoJo() { 
       // 请求地址
       String url = "http://jsonplaceholder.typicode.com/posts";
    
       // 要发送的数据对象
       PostDTO postDTO = new PostDTO();
       postDTO.setUserId(110);
       postDTO.setTitle("zimug 发布文章");
       postDTO.setBody("zimug 发布文章 测试内容");
    
       // 发送post请求，并输出结果
       ResponseEntity<String> responseEntity
                   = restTemplate.postForEntity(url, postDTO, String.class);
       String body = responseEntity.getBody(); // 获取响应体
       System.out.println("HTTP 响应body：" + postDTO.toString());
    
    
       //以下是postForEntity比postForObject多出来的内容
       HttpStatus statusCode = responseEntity.getStatusCode(); // 获取响应码
       int statusCodeValue = responseEntity.getStatusCodeValue(); // 获取响应码值
       HttpHeaders headers = responseEntity.getHeaders(); // 获取响应头
    
    
       System.out.println("HTTP 响应状态：" + statusCode);
       System.out.println("HTTP 响应状态码：" + statusCodeValue);
       System.out.println("HTTP Headers信息：" + headers);
    }

输出打印结果

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ1MjcwNjY3_size_1_color_FFFFFF_t_70_pic_center]

**五、postForLocation() 方法的使用**

postForLocation的传参的类型、个数、用法基本都和postForObject()或postForEntity()一致。和前两者的唯一区别在于返回值是一个URI。该URI返回值体现的是：用于提交完成数据之后的页面跳转，或数据提交完成之后的下一步数据操作URI。

@Test
    public void testURI() { 
       // 请求地址
       String url = "http://jsonplaceholder.typicode.com/posts";
    
       PostDTO postDTO = new PostDTO();
       postDTO.setUserId(110);
       postDTO.setTitle("zimug 发布文章");
       postDTO.setBody("zimug 发布文章 测试内容");
    
       // 发送post请求，并输出结果
       URI uri = restTemplate.postForLocation(url,postDTO);
       System.out.println(uri);
    }

输出结果如下，含义是：提交了post之后，该post的id是101，可以通过如下的连接去获取数据。  
![在这里插入图片描述][20201102165456849.png_pic_center]  
**结语：**  
我这还有大量的Java学习资料，如果有需要的，可以[点击进入，暗号：csjk][csjk],免费领取！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ1MjcwNjY3_size_1_color_FFFFFF_t_70_pic_center 1]  
还有大量的资料，只要是Java方面的，这里都有。由于这里只能展示小部分，所以需要的请[点击进入，暗号：csjk][csjk]。

> 祝各位小伙伴工作顺利哦！

[20201102164956828.png_pic_center]: /images/20221120/5551a8890e92475aaf241ec591f3cff2.png
[20201102165113732.png_pic_center]: /images/20221120/c9bdaf9c81334130974b58fb817128c3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ1MjcwNjY3_size_1_color_FFFFFF_t_70_pic_center]: /images/20221120/47be2edbc3424f5c84c70375fd03ed11.png
[20201102165456849.png_pic_center]: /images/20221120/ad0f63260dfc452c840be5c7b721b0c1.png
[csjk]: https://jq.qq.com/?_wv=1027&k=WjEsUGf8
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ1MjcwNjY3_size_1_color_FFFFFF_t_70_pic_center 1]: /images/20221120/aa9668b102804650aab97b9c5065b297.png