RestTemplate简单使用

素颜马尾好姑娘i 2023-09-30 09:47 19阅读 0赞

#### 文章目录 ####

*   *   *   *  简介
             *  一、RestTemplate
             *   *  1、新建配置类
                 *  2、get 请求
                 *  3、post 请求
                 *  4、其他请求方式
                 *  5、源码说明 get 请求不支持 body 传参

##### 简介 #####

RestTemplate 深度解析 [https://my.oschina.net/lifany/blog/688889][https_my.oschina.net_lifany_blog_688889]

method GET must not have a request body. 错误解决办法[https://blog.csdn.net/weixin\_44299027/article/details/106646412][https_blog.csdn.net_weixin_44299027_article_details_106646412]

*  网络编程（含 UrlConnection 发送 HTTP 请求下载文件）：[https://blog.csdn.net/qq\_41538097/article/details/118722718][https_blog.csdn.net_qq_41538097_article_details_118722718]
 *  Apache HttpComponents 简单使用：[https://blog.csdn.net/qq\_41538097/article/details/123719298][https_blog.csdn.net_qq_41538097_article_details_123719298]
 *  RestTemplate简单使用：[https://blog.csdn.net/qq\_41538097/article/details/123560238][https_blog.csdn.net_qq_41538097_article_details_123560238]
 *  okhttp3简单使用：[https://blog.csdn.net/qq\_41538097/article/details/123677614][https_blog.csdn.net_qq_41538097_article_details_123677614]
 *  HttpURLConnection 简单使用：[https://blog.csdn.net/qq\_41538097/article/details/123697432][https_blog.csdn.net_qq_41538097_article_details_123697432]

##### 一、RestTemplate #####

spring 自带

*  默认的 RestTemplate 是不支持 get 方式通过 Body 携带参数（get 方法不支持传递 request，所以不支持传递 json 类型数据）
 *  默认使用的是SimpleClientHttpRequestFactory
 *  RestTemplate 支持通过 setRequestFactory 设置 HTTP 请求客户端工具，支持 jdk、httpclient、okHttp 等

RestTemplate 详细配置使用可参考 [https://www.cnblogs.com/wyq178/p/9058030.html][https_www.cnblogs.com_wyq178_p_9058030.html]

###### 1、新建配置类 ######

新建 RestTemplateConfig 配置类注入 RestTemplate，可以配置其他工厂设置参数，默认使用 SimpleClientHttpRequestFactory

@Configuration
    public class RestTemplateConfig {
        
    
        @Bean
        public RestTemplate restTemplate() {
        
            // 默认的是JDK提供http连接，需要的话可通过setRequestFactory方法替换为例如Apache HttpComponents、Netty或//OkHttp等其它HTTP library（需要导包）
    /*        OkHttp3ClientHttpRequestFactory factory = new OkHttp3ClientHttpRequestFactory();
            factory.setReadTimeout(5000);//单位为ms
            factory.setConnectTimeout(5000);//单位为ms
            return new RestTemplate(factory);*/
            return new RestTemplate();
        }
    }

###### 2、get 请求 ######

新建 RestTempController 控制层带参数

@GetMapping("/get/url_path_params")
        public JSONObject getUrlPathParams(@RequestParam(value = "name",required = true) String userName,@RequestParam(value = "id")int id) {
        
            JSONObject jsonObject = JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
            jsonObject.put("body", new Student(id, userName));
            return jsonObject;
        }

springboot 测试

@Test
        public void getUrlPathParams() {
        
            String url = "http://127.0.0.1:8080/rest/get/url_path_params?name={name}&id={id}";
            ResponseEntity<JSONObject> responseEntity = restTemplate.getForEntity(url, JSONObject.class, "admin", 99);
            log.info(JSON.toJSONString(responseEntity.getBody()));
        }

执行结果  
![在这里插入图片描述][e73ad1a9bfd244e497e09c81735c28bc.png]  
get 请求（可以打开源码查看重载方法）

*  getForEntity() 方法的返回值是一个 ResponseEntity，包括了响应码、contentType、contentLength、响应消息体
 *  getForObject() 只返回响应消息体，没有响应码等

###### 3、post 请求 ######

新建 RestTempController 控制层带参数

@PostMapping(value = "/post/params_bean")
        public JSONObject postParamsBean(@RequestBody Map<String, Object> map) {
        
            JSONObject jsonObject = JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
            jsonObject.put("body", map);
            return jsonObject;
        }

springboot 测试

@Test
        public void postParamsBean() {
        
            try {
        
                ClientHttpRequestFactory requestFactory = restTemplate.getRequestFactory();
                System.out.println(requestFactory);
                String url = "http://127.0.0.1:8080/rest/post/params_bean";
                HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.valueOf(MediaType.APPLICATION_JSON_VALUE));
    			/*Map<String, Object> map = new HashMap<>();
                map.put("id", 18);
                map.put("name", "test");*/
                //String str = "{\"id\": 1, \"name\": \"admin\"}";
                Student student = new Student(18, "root");
                HttpEntity httpEntity = new HttpEntity(student, headers);
                ResponseEntity<JSONObject> responseEntity = restTemplate.postForEntity(url, httpEntity, JSONObject.class);
                log.info(Objects.requireNonNull(responseEntity.getBody()).toJSONString());
                log.info(responseEntity.getStatusCode().toString());
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }

执行结果  
![在这里插入图片描述][73029b76a75b47e683b4da2fa02c91d2.png]  
注意： cotroller 层接口参数类型为 Map 类型，测试类中传递 json 字符串、Map、实体类都可以

post请求（可以打开源码查看重载方法）

*  postForEntity() 方法的返回值是一个 ResponseEntity，包括了响应码、contentType、contentLength、响应消息体
 *  postForObject() 只返回响应消息体，没有响应码等

###### 4、其他请求方式 ######

GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE 都可以使用通用的 exchange 和execute 方法，其他请求类型不常用，可参考源码实现  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16]

###### 5、源码说明 get 请求不支持 body 传参 ######

如下 SimpleClientHttpRequestFactory 类的 prepareConnection() 方法

DoOutput 默认值为 false，设置为 true 可进行输出。  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
SimpleBufferingClientHttpRequest.executeInternal() 将 body 中的参数写出到流  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
上面方法中的 this.connection.getOutputStream() 最终调用sun.net.www.protocol.http.HttpURLConnection 类的 getOutputStream0() 方法（如果你将 get 请求的 DoOutput 设置为 true，将被强制修改为 post 请求，最终会报一个`405 Method Not Allowed` 的错误）

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

[https_my.oschina.net_lifany_blog_688889]: https://my.oschina.net/lifany/blog/688889
[https_blog.csdn.net_weixin_44299027_article_details_106646412]: https://blog.csdn.net/weixin_44299027/article/details/106646412
[https_blog.csdn.net_qq_41538097_article_details_118722718]: https://blog.csdn.net/qq_41538097/article/details/118722718
[https_blog.csdn.net_qq_41538097_article_details_123719298]: https://blog.csdn.net/qq_41538097/article/details/123719298
[https_blog.csdn.net_qq_41538097_article_details_123560238]: https://blog.csdn.net/qq_41538097/article/details/123560238
[https_blog.csdn.net_qq_41538097_article_details_123677614]: https://blog.csdn.net/qq_41538097/article/details/123677614
[https_blog.csdn.net_qq_41538097_article_details_123697432]: https://blog.csdn.net/qq_41538097/article/details/123697432
[https_www.cnblogs.com_wyq178_p_9058030.html]: https://www.cnblogs.com/wyq178/p/9058030.html
[e73ad1a9bfd244e497e09c81735c28bc.png]: https://img-blog.csdnimg.cn/e73ad1a9bfd244e497e09c81735c28bc.png
[73029b76a75b47e683b4da2fa02c91d2.png]: https://img-blog.csdnimg.cn/73029b76a75b47e683b4da2fa02c91d2.png
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/9b3bb49aa4fd426092596e92cb67bbdf.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5LiN5oeC5LiA5LyR,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/f8ee2549d56948bb9e0157c281bfe9bb.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5LiN5oeC5LiA5LyR,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/59df1982d9224b34a8b7bafd13de3d89.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5LiN5oeC5LiA5LyR,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LiN5oeC5LiA5LyR_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/715d11ac3a694067841fd86ef405b559.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5LiN5oeC5LiA5LyR,size_20,color_FFFFFF,t_70,g_se,x_16