springboot配置并使用RestTemplate

用多少眼泪才能让你相信  金牌会员 | 2025-1-3 15:46:43 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 823|帖子 823|积分 2469

目录
一、RestTemplate配置
1、将RestTemplate初始化为Bean
2、使用HttpClient作为RestTemplate客户端
（1）引入HttpClient依靠
（2）修改RestTemplate配置类
3、设置拦截器
（1）新增拦截器类
（2）设置拦截器
4、新增支持的媒体类型
二、RestTemplate使用
1、RestTemplate注入
2、无参数get请求测试
（1）Controller代码
（2）RestTemplate单元测试
3、带参get请求测试
（1）Controller代码
（2）RestTemplate单元测试
4、带占位符参数的get请求测试
（1）Controller代码
（2）RestTemplate单元测试
5、post请求测试
（1）Article实体类
（2）Controller代码
（3）RestTemplate单元测试
6、设置请求头
（1）Article实体类
（2）Controller代码
（3）RestTemplate单元测试
7、上传文件
（1）Controller代码
（2）RestTemplate单元测试
8、文件下载
（1）Controller代码
（2）RestTemplate单元测试
三、参考

一、RestTemplate配置

1、将RestTemplate初始化为Bean

  1. package com.xiaobai.conf;
  3. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.web.client.RestTemplate;
  8. import java.util.Collections;
  10. /**
  11. * @Author 王天文
  12. * @Date 2024/12/29 18:06
  13. * @Description: RestTemplate配置类
  14. */
  15. @Configuration
  16. public class RestTemplateConf {
  18.     /**
  19.      * 当指定类型Bean不存在时，会创建一个新的Bean，如果用户自定义了Bean,将使用用户自定义的Bean
  20.      * @return
  21.      */
  22.     @ConditionalOnMissingBean(RestTemplate.class)
  23.     @Bean
  24.     public RestTemplate restTemplate() {
  25.         // 使用JDK自带的HttpURLConnection作为客户端
  26.         RestTemplate restTemplate = new RestTemplate();
  27.         return restTemplate;
  28.     }
  29. }
复制代码
2、使用HttpClient作为RestTemplate客户端

（1）引入HttpClient依靠

  1.         <!--httpclient-->
  2.         <dependency>
  3.             <groupId>org.apache.httpcomponents</groupId>
  4.             <artifactId>httpclient</artifactId>
  5.             <version>4.5.7</version>
  6.         </dependency>
复制代码
（2）修改RestTemplate配置类

  1. package com.xiaobai.conf;
  3. import org.apache.http.client.config.RequestConfig;
  4. import org.apache.http.impl.client.CloseableHttpClient;
  5. import org.apache.http.impl.client.HttpClientBuilder;
  6. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.http.client.ClientHttpRequestFactory;
  10. import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
  11. import org.springframework.web.client.RestTemplate;
  13. import java.util.Collections;
  15. /**
  16. * @Author 王天文
  17. * @Date 2024/12/29 18:06
  18. * @Description: RestTemplate配置类
  19. */
  20. @Configuration
  21. public class RestTemplateConf {
  23.     /**
  24.      * 当指定类型Bean不存在时，会创建一个新的Bean，如果用户自定义了Bean,将使用用户自定义的Bean
  25.      * @return
  26.      */
  27.     @ConditionalOnMissingBean(RestTemplate.class)
  28.     @Bean
  29.     public RestTemplate restTemplate() {
  30.         // 使用httpclient作为底层客户端
  31.         RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
  32.         return restTemplate;
  33.     }
  35.     /**
  36.      * 使用httpclient作为底层客户端
  37.      * @return
  38.      */
  39.     @Bean
  40.     public ClientHttpRequestFactory getClientHttpRequestFactory() {
  41.         int timeout = 50000;
  43.         RequestConfig requestConfig = RequestConfig.custom()
  44.                 .setConnectTimeout(timeout)
  45.                 .setConnectionRequestTimeout(timeout)
  46.                 .setSocketTimeout(timeout)
  47.                 .build();
  49.         CloseableHttpClient httpClient = HttpClientBuilder.create()
  50.                 .setDefaultRequestConfig(requestConfig)
  51.                 .build();
  52.         return new HttpComponentsClientHttpRequestFactory(httpClient);
  53.     }
  54. }
复制代码
3、设置拦截器

（1）新增拦截器类

  1. package com.xiaobai.conf;
  3. import org.springframework.http.HttpRequest;
  4. import org.springframework.http.client.ClientHttpRequestExecution;
  5. import org.springframework.http.client.ClientHttpRequestInterceptor;
  6. import org.springframework.http.client.ClientHttpResponse;
  8. import java.io.IOException;
  10. /**
  11. * @Author 王天文
  12. * @Date 2024/12/22 21:51
  13. * @Description: restTemplate拦截器
  14. */
  15. public class RestTemplateInterceptor implements ClientHttpRequestInterceptor {
  17.     @Override
  18.     public ClientHttpResponse intercept(HttpRequest httpRequest,
  19.                                         byte[] bytes,
  20.                                         ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
  22.         ClientHttpResponse httpResponse = clientHttpRequestExecution.execute(httpRequest, bytes);
  23.         return httpResponse;
  24.     }
  25. }
复制代码
（2）设置拦截器

  1. package com.xiaobai.conf;
  3. import org.apache.http.client.config.RequestConfig;
  4. import org.apache.http.impl.client.CloseableHttpClient;
  5. import org.apache.http.impl.client.HttpClientBuilder;
  6. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.http.client.ClientHttpRequestFactory;
  10. import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
  11. import org.springframework.web.client.RestTemplate;
  13. import java.util.Collections;
  15. /**
  16. * @Author 王天文
  17. * @Date 2024/12/29 18:06
  18. * @Description: RestTemplate配置类
  19. */
  20. @Configuration
  21. public class RestTemplateConf {
  23.     /**
  24.      * 当指定类型Bean不存在时，会创建一个新的Bean，如果用户自定义了Bean,将使用用户自定义的Bean
  25.      * @return
  26.      */
  27.     @ConditionalOnMissingBean(RestTemplate.class)
  28.     @Bean
  29.     public RestTemplate restTemplate() {
  30.         // 使用JDK自带的HttpURLConnection作为客户端
  31.         RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
  33.         // 设置拦截器
  34.         restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));
  35.         return restTemplate;
  36.     }
  38.     /**
  39.      * 使用httpclient作为底层客户端
  40.      * @return
  41.      */
  42.     @Bean
  43.     public ClientHttpRequestFactory getClientHttpRequestFactory() {
  44.         int timeout = 50000;
  46.         RequestConfig requestConfig = RequestConfig.custom()
  47.                 .setConnectTimeout(timeout)
  48.                 .setConnectionRequestTimeout(timeout)
  49.                 .setSocketTimeout(timeout)
  50.                 .build();
  52.         CloseableHttpClient httpClient = HttpClientBuilder.create()
  53.                 .setDefaultRequestConfig(requestConfig)
  54.                 .build();
  55.         return new HttpComponentsClientHttpRequestFactory(httpClient);
  56.     }
  58.     /**
  59.      * 拦截器
  60.      * @return
  61.      */
  62.     @Bean
  63.     public RestTemplateInterceptor restTemplateInterceptor() {
  64.         return new RestTemplateInterceptor();
  65.     }
  66. }
复制代码
4、新增支持的媒体类型

RestTemplate 只支持application/json格式，需要手动补充text/plan,text/html格式
  1. package com.xiaobai.conf;
  3. import org.apache.http.client.config.RequestConfig;
  4. import org.apache.http.impl.client.CloseableHttpClient;
  5. import org.apache.http.impl.client.HttpClientBuilder;
  6. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.http.MediaType;
  10. import org.springframework.http.client.ClientHttpRequestFactory;
  11. import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
  12. import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
  13. import org.springframework.web.client.RestTemplate;
  15. import java.util.Arrays;
  16. import java.util.Collections;
  18. /**
  19. * @Author 王天文
  20. * @Date 2024/12/29 18:06
  21. * @Description: RestTemplate配置类
  22. */
  23. @Configuration
  24. public class RestTemplateConf {
  26.     /**
  27.      * 当指定类型Bean不存在时，会创建一个新的Bean，如果用户自定义了Bean,将使用用户自定义的Bean
  28.      * @return
  29.      */
  30.     @ConditionalOnMissingBean(RestTemplate.class)
  31.     @Bean
  32.     public RestTemplate restTemplate() {
  33.         // 使用JDK自带的HttpURLConnection作为客户端
  34.         RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
  36.         // 设置拦截器
  37.         restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));
  39.         // 增加支持的媒体类型
  40.         restTemplate.getMessageConverters().add(mappingJackson2HttpMessageConverter());
  41.         return restTemplate;
  42.     }
  44.     /**
  45.      * 使用httpclient作为底层客户端
  46.      * @return
  47.      */
  48.     @Bean
  49.     public ClientHttpRequestFactory getClientHttpRequestFactory() {
  50.         int timeout = 50000;
  52.         RequestConfig requestConfig = RequestConfig.custom()
  53.                 .setConnectTimeout(timeout)
  54.                 .setConnectionRequestTimeout(timeout)
  55.                 .setSocketTimeout(timeout)
  56.                 .build();
  58.         CloseableHttpClient httpClient = HttpClientBuilder.create()
  59.                 .setDefaultRequestConfig(requestConfig)
  60.                 .build();
  61.         return new HttpComponentsClientHttpRequestFactory(httpClient);
  62.     }
  64.     /**
  65.      * 拦截器
  66.      * @return
  67.      */
  68.     @Bean
  69.     public RestTemplateInterceptor restTemplateInterceptor() {
  70.         return new RestTemplateInterceptor();
  71.     }
  73.     /**
  74.      * 媒体类型
  75.      * @return
  76.      */
  77.     @Bean
  78.     public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
  79.         // RestTemplate 只支持application/json格式，需要手动补充text/html格式
  80.         MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
  81.         mappingJackson2HttpMessageConverter.setSupportedMediaTypes(Arrays.asList(MediaType.TEXT_PLAIN, MediaType.TEXT_HTML));
  83.         return mappingJackson2HttpMessageConverter;
  84.     }
  85. }
复制代码
二、RestTemplate使用

1、RestTemplate注入

  1.     @Autowired
  2.     private RestTemplate restTemplate;
复制代码
2、无参数get请求测试

（1）Controller代码

  1.     @GetMapping(value = "/getString")
  2.     public String getString() {
  3.         return "操作成功";
  4.     }
复制代码
（2）RestTemplate单元测试

  1.     @Test
  2.     public void testGetString() {
  3.         ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8090/getString", String.class);
  4.         log.info(responseEntity.getBody());
  5.     }
复制代码
3、带参get请求测试

（1）Controller代码

  1.     @GetMapping("/getRequestByParam")
  2.     public Map<String, Object> getRequestByParam(@RequestParam("name") String name) {
  3.         log.info("名称：" + name);
  5.         Map<String, Object> map = new HashMap<>();
  6.         map.put("responseData", "请求成功");
  7.         return map;
  8.     }
复制代码
（2）RestTemplate单元测试

  1.     @Test
  2.     public void testParamGet() throws Exception {
  3.         Map<String, Object> param = new HashMap<>();
  4.         param.put("name", "张三");
  5.         ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8090/getRequestByParam?name={name}", String.class, param);
  7.         log.info("响应信息：{}", responseEntity.getBody());
  8.     }
复制代码
4、带占位符参数的get请求测试

（1）Controller代码

  1.     @GetMapping("/getRequestByPlaceHolder/{name}/{age}")
  2.     public Map<String, Object> getRequestByPlaceHolder(@PathVariable("name") String name,
  3.                                                        @PathVariable("age") String age) {
  4.         log.info("名称：" + name);
  5.         log.info("年龄：" + age);
  7.         Map<String, Object> map = new HashMap<>();
  8.         map.put("responseData", "请求成功");
  9.         return map;
  10.     }
复制代码
（2）RestTemplate单元测试

  1.     @Test
  2.     public void testPlaceholderGet() {
  3.         ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8090/getRequestByPlaceHolder/{1}/{2}", String.class, "张三", "25");
  5.         log.info("响应信息：{}", responseEntity.getBody());
  6.     }
复制代码
5、post请求测试

（1）Article实体类

  1. package com.xiaobai.aroundtest.entity;
  3. import lombok.Data;
  5. import java.io.Serializable;
  7. /**
  8. * @author wangtw
  9. * @date 2023/12/6 0:35
  10. * @description
  11. */
  12. @Data
  13. public class Article implements Serializable {
  15.     private static final long serialVersionUID = 1L;
  17.     /**
  18.      * 文章名称
  19.      */
  20.     private String name;
  22.     /**
  23.      * 描述
  24.      */
  25.     private String description;
  26. }
复制代码
（2）Controller代码

  1.     @PostMapping("/postRequest")
  2.     public Map<String, Object> postRequest(@RequestParam String name, @RequestBody Article article) {
  3.         log.info("名称：" + name);
  5.         log.info("文章名称：" + article.getName());
  6.         log.info("文章描述：" + article.getDescription());
  8.         Map<String, Object> map = new HashMap<>();
  9.         map.put("responseData", "请求成功");
  10.         return map;
  11.     }
复制代码
（3）RestTemplate单元测试

  1.     @Test
  2.     public void testPost() {
  4.         // 表单数据
  5.         Map<String, Object> formData = new HashMap<>();
  6.         formData.put("name", "解忧杂货店");
  7.         formData.put("description", "这是一本好书");
  9.         // 单独传参
  10.         Map<String, Object> param = new HashMap<>();
  11.         param.put("name", "东野圭吾");
  13.         // 请求调用
  14.         HttpEntity<Map<String, Object>> formEntity = new HttpEntity<>(formData);
  15.         ResponseEntity<String> responseEntity = restTemplate.postForEntity("http://localhost:8090/postRequest?name={name}", formEntity, String.class, param);
  16.         log.info("响应信息：{}", responseEntity.getBody());
  17.     }
复制代码
6、设置请求头

（1）Article实体类

  1. package com.xiaobai.aroundtest.entity;
  3. import lombok.Data;
  5. import java.io.Serializable;
  7. /**
  8. * @author wangtw
  9. * @date 2023/12/6 0:35
  10. * @description
  11. */
  12. @Data
  13. public class Article implements Serializable {
  15.     private static final long serialVersionUID = 1L;
  17.     /**
  18.      * 文章名称
  19.      */
  20.     private String name;
  22.     /**
  23.      * 描述
  24.      */
  25.     private String description;
  26. }
复制代码
（2）Controller代码

  1.     @PostMapping("/postRequestHeader")
  2.     public Map<String, Object> postRequestHeader(HttpServletRequest request,
  3.                                                  @RequestParam String name, @RequestBody Article article) {
  5.         String token = request.getHeader("token");
  6.         log.info("请求token：" + token);
  8.         log.info("名称：" + name);
  10.         log.info("文章名称：" + article.getName());
  11.         log.info("文章描述：" + article.getDescription());
  13.         Map<String, Object> map = new HashMap<>();
  14.         map.put("responseData", "请求成功");
  15.         return map;
  16.     }
复制代码
（3）RestTemplate单元测试

  1.     @Test
  2.     public void testPostHeader() {
  4.         // 请求头
  5.         HttpHeaders httpHeaders = new HttpHeaders();
  6.         httpHeaders.add("token", "123456");
  8.         // 表单数据
  9.         Map<String, Object> formData = new HashMap<>();
  10.         formData.put("name", "解忧杂货店");
  11.         formData.put("description", "这是一本好书");
  13.         // 单独传参
  14.         Map<String, Object> param = new HashMap<>();
  15.         param.put("name", "东野圭吾");
  17.         // 请求调用
  18.         HttpEntity<Map<String, Object>> formEntity = new HttpEntity<>(formData, httpHeaders);
  19.         ResponseEntity<String> responseEntity = restTemplate.postForEntity("http://localhost:8090/postRequestHeader?name={name}", formEntity, String.class, param);
  20.         log.info("响应信息：{}", responseEntity.getBody());
  21.     }
复制代码
7、上传文件

（1）Controller代码

  1.     @PostMapping("/upload")
  2.     public Map<String, Object> upload(@RequestParam String name, MultipartFile uploadFile) throws IOException {
  3.         log.info("名称：" + name);
  5.         uploadFile.transferTo(new File("D:\\temp/" + uploadFile.getOriginalFilename()));
  7.         Map<String, Object> map = new HashMap<>();
  8.         map.put("responseData", "请求成功");
  9.         return map;
  10.     }
复制代码
（2）RestTemplate单元测试

  1.     @Test
  2.     public void testUploadFile() {
  4.         MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();
  5.         param.add("uploadFile", new FileSystemResource(new File("D:\\christmas-tree.svg")));
  6.         param.add("name", "张三");
  8.         // 请求头设置
  9.         HttpHeaders headers = new HttpHeaders();
  10.         headers.setContentType(MediaType.MULTIPART_FORM_DATA);
  12.         // 请求调用
  13.         HttpEntity<MultiValueMap<String, Object>> formEntity = new HttpEntity<>(param, headers);
  14.         ResponseEntity<String> responseEntity = restTemplate.postForEntity("http://localhost:8090/upload", formEntity, String.class);
  15.         log.info("响应信息：{}", responseEntity.getBody());
  17.     }
复制代码
8、文件下载

（1）Controller代码

  1.     @PostMapping("/download")
  2.     public Map<String, Object> download(@RequestParam String fileName,
  3.                                         HttpServletResponse response) {
  4.         log.info("文件名称：" + fileName);
  6.         File file = new File("D:\\temp/" + fileName);
  8.         try(FileInputStream fileInputStream = new FileInputStream(file);
  9.             ServletOutputStream outputStream = response.getOutputStream()) {
  11.             response.setHeader("content-disposition","attachment;fileName=" + URLEncoder.encode(fileName,"UTF-8"));
  13.             FileCopyUtils.copy(fileInputStream, outputStream);
  14.         } catch (Exception e) {
  15.             e.printStackTrace();
  16.         }
  18.         Map<String, Object> map = new HashMap<>();
  19.         map.put("responseData", "请求成功");
  20.         return map;
  21.     }
复制代码
（2）RestTemplate单元测试

  1.     @Test
  2.     public void testDownloadFile() {
  3.         MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();
  4.         param.add("fileName", "christmas-tree.svg");
  6.         // 请求调用
  7.         HttpEntity<MultiValueMap<String, Object>> formEntity = new HttpEntity<>(param);
  8.         ResponseEntity<byte[]> responseEntity = restTemplate.postForEntity("http://localhost:8090/download", formEntity, byte[].class);
  10.         // 获取响应头
  11.         HttpHeaders responseEntityHeaders = responseEntity.getHeaders();
  12.         Set<Map.Entry<String, List<String>>> responseSet = responseEntityHeaders.entrySet();
  13.         for (Map.Entry<String, List<String>> responseValue : responseSet) {
  14.             log.info("响应头：" + responseValue.getKey() + "，响应内容：" + responseValue.getValue());
  15.         }
  17.         try {
  18.             // 文件保存
  19.             byte[] fileData = responseEntity.getBody();
  20.             FileCopyUtils.copy(fileData, new File("D:\\christmas-tree1.svg"));
  21.         } catch (IOException e) {
  22.             e.printStackTrace();
  23.         }
  24.     }
复制代码
三、参考

   Spring之RestTemplate详解

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

用多少眼泪才能让你相信

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表