devbox
知新_RL
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

【springboot进阶】RestTemplate进阶封装常用请求方式_resttemplate封装

作者：知新_RL | 2024-03-24 14:21:04

赞

踩

resttemplate封装

目录

一、封装思路

二、GET方式

三、POST方式

form-data

x-www-form-urlencoded

json

四、Header处理

五、完整代码

虽然spring已经帮我们简化了http的请求，但是在实际应用中，我们还是需要写很多重复的代码，显得不够优雅，所以我们还需要对RestTemplate再做一层封装，使外层的调用能够更加的规范和简单。

一、封装思路

我们需要构建一个基类，这个基类封装全部底层基础的请求方法，如GET/POST。

  1. /**
  2.  * 封装一些常用的远程调用方法
  3.  *
  4.  */
  5. public class BackendHttpRequest {
  6.  
  7.     //伪代码
  8.     get请求方法
  9.  
  10.     post的json格式请求方法
  11.  
  12.     post的x-www-form-urlencoded格式请求方法
  13.  
  14.     ....
  15.  
  16. }

将需要远程调用的方法封装在一个service服务类，同时继承上面的基类，这个服务类内部即可调用基类的请求方法。

  1. @Service
  2. class AServiceImpl extends BackendHttpRequest implements AService {
  3.     
  4.     //获取天气数据api
  5.     public String getWeatherData(WeatherDataRequestBean params){
  6.         //伪代码
  7.         //调用基类的getData方法，传入请求api接口地址，并带上参数params
  8.         //params内有city城市字段，根据城市名称查询当地天气
  9.         String resBody = this.getData(apiUrl, params);
  10.         return resBody;
  11.     }
  12.     
  13. }

这样，我们就大概构建了一套请求的规范模型，并使用fastjson序列化传入的bean，下面会具体详细说明实战中如何应用。

二、GET方式

以下具体说明如何调用微信的"公众号的全局唯一接口调用凭据"接口，接口文档

  1.     /**
  2.      * get请求
  3.      *
  4.      * @param api 请求url
  5.      * @param reqObj 请求request实体
  6.      * @return
  7.      */
  8.     public String getData(String api, Object reqObj) {
  9.  
  10.         return this.getData(api, reqObj, null);
  11.     }
  12.  
  13.     /**
  14.      * get请求
  15.      *
  16.      * @param api 请求url
  17.      * @param reqObj 请求request实体
  18.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  19.      * @return
  20.      */
  21.     public String getData(String api, Object reqObj, Map<String, String> addHeaders) {
  22.  
  23.         JSONObject params = null;
  24.  
  25.         if (reqObj instanceof JSONObject) {
  26.             params = (JSONObject) reqObj;
  27.         } else {
  28.             params = JSONObject.parseObject(JSON.toJSONString(reqObj));
  29.         }
  30.  
  31.         //将map转换为query参数
  32.         String queryParams = HttpUtil.toParams(params, Charset.forName("UTF-8"));
  33.  
  34.         String requestUrl = api + "?" + queryParams;
  35.  
  36.         HttpEntity<String> entity = this.getMethodHttpEntity(addHeaders);
  37.  
  38.         ResponseEntity<String> responseEntity = restTemplate.exchange(URI.create(requestUrl), HttpMethod.GET, entity, String.class);
  39.  
  40.         return responseEntity.getBody();
  41.     }

同时构建一些公共的方法。 

  1.     /**
  2.      * 获取get方法的HttpEntity
  3.      *
  4.      * @param addHeaders 添加的头部
  5.      * @return
  6.      */
  7.     public HttpEntity<String> getMethodHttpEntity(Map<String, String> addHeaders) {
  8.  
  9.         HttpHeaders headers = this.getJsonDataHttpHeaders();
  10.  
  11.         this.addHeaders(headers, addHeaders);
  12.  
  13.         HttpEntity<String> requestEntity = new HttpEntity<>(null, headers);
  14.         return requestEntity;
  15.     }
  16.  
  17.  
  18.     /**
  19.      * 获取json请求头
  20.      *
  21.      * @return
  22.      */
  23.     public HttpHeaders getJsonDataHttpHeaders() {
  24.         HttpHeaders headers = this.getHttpHeaders(MediaType.APPLICATION_JSON);
  25.  
  26.         return headers;
  27.     }
  28.  
  29.     /**
  30.      * 获取指定mediaType请求头
  31.      *
  32.      * @param mediaType
  33.      * @return
  34.      */
  35.     public HttpHeaders getHttpHeaders(MediaType mediaType) {
  36.         HttpHeaders headers = new HttpHeaders();
  37.         headers.setContentType(mediaType);
  38.  
  39.         return headers;
  40.     }

GET方式的封装，重载了两个方法，其中一个方法可以传入自定义的头部参数。

对于请求的参数，统一转变成JSON对象，再使用hutool的工具类HttpUtil，将其转变为query参数形式，即key=value&key=value，最后拼接在url上。

最后，我们使用的是restTemplate.exchange方法，而没有使用getForEntity，是因为之前这里有踩过坑。

  1. @Service
  2. public class TokenServiceImpl extends BackendHttpRequest implements TokenService {
  3.  
  4. 	@Override
  5.     public AccessTokenResponse accessToken(AccessTokenRequest accessTokenRequest) {
  6.  
  7.         String apiUrl = "https://api.weixin.qq.com/cgi-bin/token";
  8.  
  9.         String resText = this.getData(apiUrl, accessTokenRequest);
  10.         if (StrUtil.isNotBlank(resText)) {
  11.             AccessTokenResponse response = JSON.parseObject(resText, AccessTokenResponse.class);
  12.             return response;
  13.         }
  14.  
  15.         return null;
  16.     }
  17.  
  18. }

请求实体

  1. @Data
  2. public class AccessTokenRequest {
  3.  
  4.     @JSONField(name = "appid")
  5.     private String appId;
  6.     @JSONField(name = "secret")
  7.     private String appSecret;
  8.     @JSONField(name = "grant_type")
  9.     private String grantType;
  10. }

响应实体

  1. @Data
  2. public class AccessTokenResponse {
  3.  
  4.     @JSONField(name = "errcode")
  5.     private String errcode;
  6.     @JSONField(name = "errmsg")
  7.     private String errmsg;
  8.  
  9.     @JSONField(name = "access_token")
  10.     private String accessToken;
  11.     @JSONField(name = "expires_in")
  12.     private Integer expiresIn;
  13. }

三、POST方式

主要对form-data、x-www-form-urlencoded、json等格式分别进行处理。

form-data

  1.     /**
  2.      * form-data的post请求
  3.      *
  4.      * @param requestUrl 请求url
  5.      * @param reqObj 请求request实体
  6.      * @return
  7.      */
  8.     public String postFormData(String requestUrl, Object reqObj) {
  9.  
  10.         return this.postFormData(requestUrl, reqObj, null);
  11.     }
  12.  
  13.     /**
  14.      * form-data的post请求
  15.      *
  16.      * @param requestUrl 请求url
  17.      * @param reqObj 请求request实体
  18.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  19.      * @return
  20.      */
  21.     public String postFormData(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  22.  
  23.         HttpEntity<MultiValueMap<String, Object>> entity = this.getFormRequestHttpEntity(reqObj, MediaType.MULTIPART_FORM_DATA_VALUE, addHeaders);
  24.  
  25.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  26.  
  27.         return resText;
  28.     }

请求体需要使用MultiValueMap进行封装，构建公共方法将请求bean转换为MultiValueMap。 

  1.     /**
  2.      * 请求request实体转form-data的map
  3.      *
  4.      * @param reqObj 请求request实体
  5.      * @return
  6.      */
  7.     public MultiValueMap<String, Object> requestBeanToFormParams(Object reqObj) {
  8.  
  9.         Map<String, Object> params = JSONObject.parseObject(JSON.toJSONString(reqObj), HashMap.class);
  10.  
  11.         MultiValueMap<String, Object> multiValueMap = new LinkedMultiValueMap<>();
  12.         for (String key : params.keySet()) {
  13.             multiValueMap.add(key, params.get(key));
  14.         }
  15.  
  16.         return multiValueMap;
  17.     }

x-www-form-urlencoded

  1.     /**
  2.      * x-www-form-urlencoded的post请求
  3.      *
  4.      * @param requestUrl 请求url
  5.      * @param reqObj 请求request实体
  6.      * @return
  7.      */
  8.     public String postFormUrlencoded(String requestUrl, Object reqObj) {
  9.  
  10.         return this.postFormUrlencoded(requestUrl, reqObj, null);
  11.     }
  12.  
  13.     /**
  14.      * x-www-form-urlencoded的post请求
  15.      *
  16.      * @param requestUrl 请求url
  17.      * @param reqObj 请求request实体
  18.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  19.      * @return
  20.      */
  21.     public String postFormUrlencoded(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  22.  
  23.         HttpEntity<MultiValueMap<String, Object>> entity = this.getFormRequestHttpEntity(reqObj, MediaType.APPLICATION_FORM_URLENCODED_VALUE, addHeaders);
  24.  
  25.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  26.  
  27.         return resText;
  28.     }

方式跟form-data相同，只是header的content-type不相同。

  1.     /**
  2.      * 获取x-www-form-urlencoded请求头
  3.      *
  4.      * @return
  5.      */
  6.     public HttpHeaders getFormUrlencodedHttpHeaders() {
  7.         HttpHeaders headers = this.getHttpHeaders(MediaType.APPLICATION_FORM_URLENCODED);
  8.  
  9.         return headers;
  10.     }
  11.  
  12.     /**
  13.      * 获取form-data请求头
  14.      *
  15.      * @return
  16.      */
  17.     public HttpHeaders getFormDataHttpHeaders() {
  18.         HttpHeaders headers = this.getHttpHeaders(MediaType.MULTIPART_FORM_DATA);
  19.  
  20.         return headers;
  21.     }

json

  1.     /**
  2.      * json的post请求
  3.      *
  4.      * @param requestUrl 请求url
  5.      * @param reqObj 请求request实体
  6.      * @return
  7.      */
  8.     public String postJsonData(String requestUrl, Object reqObj) {
  9.  
  10.         return this.postJsonData(requestUrl, reqObj, null);
  11.     }
  12.  
  13.     /**
  14.      * json的post请求
  15.      *
  16.      * @param requestUrl 请求url
  17.      * @param reqObj 请求request实体
  18.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  19.      * @return
  20.      */
  21.     public String postJsonData(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  22.  
  23.         HttpEntity<String> entity = this.getJsonRequestHttpEntity(reqObj, addHeaders);
  24.  
  25.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  26.  
  27.         return resText;
  28.     }

json格式的请求只需要将请求体转化为json字符串即可。

  1.     /**
  2.      * 获取json请求的HttpEntity
  3.      *
  4.      * @param obj 请求request实体
  5.      * @param addHeaders 添加的头部
  6.      * @return
  7.      */
  8.     public HttpEntity<String> getJsonRequestHttpEntity(Object obj, Map<String, String> addHeaders) {
  9.  
  10.         HttpHeaders headers = this.getJsonDataHttpHeaders();
  11.  
  12.         this.addHeaders(headers, addHeaders);
  13.  
  14.         JSONObject params = null;
  15.  
  16.         if (obj instanceof JSONObject) {
  17.             params = (JSONObject) obj;
  18.         } else {
  19.             params = JSONObject.parseObject(JSON.toJSONString(obj));
  20.         }
  21.  
  22.         HttpEntity<String> entity = new HttpEntity<>(params.toString(), headers);
  23.  
  24.         return entity;
  25.     }

四、Header处理

在请求头的处理中，可以针对jwt进行处理。

  1.     /**
  2.      * 添加自定义的头部
  3.      *
  4.      * @param headers
  5.      * @param addHeaders
  6.      */
  7.     public void addHeaders(HttpHeaders headers, Map<String, String> addHeaders) {
  8.  
  9.         if (addHeaders != null) {
  10.  
  11.             for (String key : addHeaders.keySet()) {
  12.  
  13.                 if ("Bearer-Auth".equals(key)) {//jwt授权
  14.                     headers.setBearerAuth(addHeaders.get(key));
  15.                     continue;
  16.                 }
  17.  
  18.                 headers.set(key, addHeaders.get(key));
  19.             }
  20.  
  21.         }
  22.     }

我们还可以做一些公共的加密鉴权的方法在这里，这样就不需要每个请求方法都写一遍加密方式。

五、完整代码

  1. public class BackendHttpRequest {
  2.  
  3.     @Resource
  4.     RestTemplate restTemplate;
  5.  
  6.     /**
  7.      * get请求
  8.      *
  9.      * @param api 请求url
  10.      * @param reqObj 请求request实体
  11.      * @return
  12.      */
  13.     public String getData(String api, Object reqObj) {
  14.  
  15.         return this.getData(api, reqObj, null);
  16.     }
  17.  
  18.     /**
  19.      * get请求
  20.      *
  21.      * @param api 请求url
  22.      * @param reqObj 请求request实体
  23.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  24.      * @return
  25.      */
  26.     public String getData(String api, Object reqObj, Map<String, String> addHeaders) {
  27.  
  28.         JSONObject params = null;
  29.  
  30.         if (reqObj instanceof JSONObject) {
  31.             params = (JSONObject) reqObj;
  32.         } else {
  33.             params = JSONObject.parseObject(JSON.toJSONString(reqObj));
  34.         }
  35.  
  36.         //将map转换为query参数
  37.         String queryParams = HttpUtil.toParams(params, Charset.forName("UTF-8"));
  38.  
  39.         String requestUrl = api + "?" + queryParams;
  40.  
  41.         HttpEntity<String> entity = this.getMethodHttpEntity(addHeaders);
  42.  
  43.         ResponseEntity<String> responseEntity = restTemplate.exchange(URI.create(requestUrl), HttpMethod.GET, entity, String.class);
  44.  
  45.         return responseEntity.getBody();
  46.     }
  47.  
  48.     /**
  49.      * form-data的post请求
  50.      *
  51.      * @param requestUrl 请求url
  52.      * @param reqObj 请求request实体
  53.      * @return
  54.      */
  55.     public String postFormData(String requestUrl, Object reqObj) {
  56.  
  57.         return this.postFormData(requestUrl, reqObj, null);
  58.     }
  59.  
  60.     /**
  61.      * form-data的post请求
  62.      *
  63.      * @param requestUrl 请求url
  64.      * @param reqObj 请求request实体
  65.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  66.      * @return
  67.      */
  68.     public String postFormData(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  69.  
  70.         HttpEntity<MultiValueMap<String, Object>> entity = this.getFormRequestHttpEntity(reqObj, MediaType.MULTIPART_FORM_DATA_VALUE, addHeaders);
  71.  
  72.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  73.  
  74.         return resText;
  75.     }
  76.  
  77.     /**
  78.      * x-www-form-urlencoded的post请求
  79.      *
  80.      * @param requestUrl 请求url
  81.      * @param reqObj 请求request实体
  82.      * @return
  83.      */
  84.     public String postFormUrlencoded(String requestUrl, Object reqObj) {
  85.  
  86.         return this.postFormUrlencoded(requestUrl, reqObj, null);
  87.     }
  88.  
  89.     /**
  90.      * x-www-form-urlencoded的post请求
  91.      *
  92.      * @param requestUrl 请求url
  93.      * @param reqObj 请求request实体
  94.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  95.      * @return
  96.      */
  97.     public String postFormUrlencoded(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  98.  
  99.         HttpEntity<MultiValueMap<String, Object>> entity = this.getFormRequestHttpEntity(reqObj, MediaType.APPLICATION_FORM_URLENCODED_VALUE, addHeaders);
  100.  
  101.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  102.  
  103.         return resText;
  104.     }
  105.  
  106.     /**
  107.      * json的post请求
  108.      *
  109.      * @param requestUrl 请求url
  110.      * @param reqObj 请求request实体
  111.      * @return
  112.      */
  113.     public String postJsonData(String requestUrl, Object reqObj) {
  114.  
  115.         return this.postJsonData(requestUrl, reqObj, null);
  116.     }
  117.  
  118.     /**
  119.      * json的post请求
  120.      *
  121.      * @param requestUrl 请求url
  122.      * @param reqObj 请求request实体
  123.      * @param addHeaders 添加的头部 如需要使用jwt,key名称需设为"Bearer-Auth"
  124.      * @return
  125.      */
  126.     public String postJsonData(String requestUrl, Object reqObj, Map<String, String> addHeaders) {
  127.  
  128.         HttpEntity<String> entity = this.getJsonRequestHttpEntity(reqObj, addHeaders);
  129.  
  130.         String resText = restTemplate.postForObject(requestUrl, entity, String.class);
  131.  
  132.         return resText;
  133.     }
  134.  
  135.     /**
  136.      * 请求request实体转form-data的map
  137.      *
  138.      * @param reqObj 请求request实体
  139.      * @return
  140.      */
  141.     public MultiValueMap<String, Object> requestBeanToFormParams(Object reqObj) {
  142.  
  143.         Map<String, Object> params = JSONObject.parseObject(JSON.toJSONString(reqObj), HashMap.class);
  144.  
  145.         MultiValueMap<String, Object> multiValueMap = new LinkedMultiValueMap<>();
  146.         for (String key : params.keySet()) {
  147.             multiValueMap.add(key, params.get(key));
  148.         }
  149.  
  150.         return multiValueMap;
  151.     }
  152.  
  153.     /**
  154.      * 获取get方法的HttpEntity
  155.      *
  156.      * @param addHeaders 添加的头部
  157.      * @return
  158.      */
  159.     public HttpEntity<String> getMethodHttpEntity(Map<String, String> addHeaders) {
  160.  
  161.         HttpHeaders headers = this.getJsonDataHttpHeaders();
  162.  
  163.         this.addHeaders(headers, addHeaders);
  164.  
  165.         HttpEntity<String> requestEntity = new HttpEntity<>(null, headers);
  166.         return requestEntity;
  167.     }
  168.  
  169.     /**
  170.      * 获取form请求的HttpEntity
  171.      *
  172.      * @param reqObj 请求request实体
  173.      * @param contentType form请求类型
  174.      * @param addHeaders 添加的头部
  175.      * @return
  176.      */
  177.     public HttpEntity<MultiValueMap<String, Object>> getFormRequestHttpEntity(Object reqObj, String contentType, Map<String, String> addHeaders) {
  178.  
  179.         HttpHeaders headers = null;
  180.         if (MediaType.APPLICATION_FORM_URLENCODED_VALUE.equals(contentType)) {
  181.             headers = this.getFormUrlencodedHttpHeaders();
  182.         } else if (MediaType.MULTIPART_FORM_DATA_VALUE.equals(contentType)) {
  183.             headers = this.getFormDataHttpHeaders();
  184.         }
  185.  
  186.         this.addHeaders(headers, addHeaders);
  187.  
  188.         MultiValueMap<String, Object> multiValueMap = this.requestBeanToFormParams(reqObj);
  189.  
  190.         HttpEntity<MultiValueMap<String, Object>> entity = new HttpEntity<>(multiValueMap, headers);
  191.  
  192.         return entity;
  193.     }
  194.  
  195.     /**
  196.      * 获取json请求的HttpEntity
  197.      *
  198.      * @param obj 请求request实体
  199.      * @param addHeaders 添加的头部
  200.      * @return
  201.      */
  202.     public HttpEntity<String> getJsonRequestHttpEntity(Object obj, Map<String, String> addHeaders) {
  203.  
  204.         HttpHeaders headers = this.getJsonDataHttpHeaders();
  205.  
  206.         this.addHeaders(headers, addHeaders);
  207.  
  208.         JSONObject params = null;
  209.  
  210.         if (obj instanceof JSONObject) {
  211.             params = (JSONObject) obj;
  212.         } else {
  213.             params = JSONObject.parseObject(JSON.toJSONString(obj));
  214.         }
  215.  
  216.         HttpEntity<String> entity = new HttpEntity<>(params.toString(), headers);
  217.  
  218.         return entity;
  219.     }
  220.  
  221.     /**
  222.      * 获取x-www-form-urlencoded请求头
  223.      *
  224.      * @return
  225.      */
  226.     public HttpHeaders getFormUrlencodedHttpHeaders() {
  227.         HttpHeaders headers = this.getHttpHeaders(MediaType.APPLICATION_FORM_URLENCODED);
  228.  
  229.         return headers;
  230.     }
  231.  
  232.     /**
  233.      * 获取form-data请求头
  234.      *
  235.      * @return
  236.      */
  237.     public HttpHeaders getFormDataHttpHeaders() {
  238.         HttpHeaders headers = this.getHttpHeaders(MediaType.MULTIPART_FORM_DATA);
  239.  
  240.         return headers;
  241.     }
  242.  
  243.     /**
  244.      * 获取json请求头
  245.      *
  246.      * @return
  247.      */
  248.     public HttpHeaders getJsonDataHttpHeaders() {
  249.         HttpHeaders headers = this.getHttpHeaders(MediaType.APPLICATION_JSON);
  250.  
  251.         return headers;
  252.     }
  253.  
  254.     /**
  255.      * 获取指定mediaType请求头
  256.      *
  257.      * @param mediaType
  258.      * @return
  259.      */
  260.     public HttpHeaders getHttpHeaders(MediaType mediaType) {
  261.         HttpHeaders headers = new HttpHeaders();
  262.         headers.setContentType(mediaType);
  263.  
  264.         return headers;
  265.     }
  266.  
  267.     /**
  268.      * 添加自定义的头部
  269.      *
  270.      * @param headers
  271.      * @param addHeaders
  272.      */
  273.     public void addHeaders(HttpHeaders headers, Map<String, String> addHeaders) {
  274.  
  275.         if (addHeaders != null) {
  276.  
  277.             for (String key : addHeaders.keySet()) {
  278.  
  279.                 if ("Bearer-Auth".equals(key)) {//jwt授权
  280.                     headers.setBearerAuth(addHeaders.get(key));
  281.                     continue;
  282.                 }
  283.  
  284.                 headers.set(key, addHeaders.get(key));
  285.             }
  286.  
  287.         }
  288.     }
  289.  
  290. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/知新_RL/article/detail/302897
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号