02 RestTemplate发送客户端请求

电玩女神 2023-07-18 09:54 85阅读 0赞

，RestTemplate涵盖了所有的HTTP动作。除此之外，execute()和exchange()提供了较低层次的通用方法来使用任意
的HTTP方法。

在这里插入图片描述

restTemplate方法整理

  • 请求方式上分为Post和Get方法
  • 请求结果生可以返回Object,ResponseEntity或其他（特殊)
  • execute()和和exchange()都可执行任意方法，分别返回Object和ResponseEntity

1.0 返回结果xxxforentity 和xxxforObject 区别

除了返回类型，getForEntity()方法就是getForObject()方法的镜像。实际上，它们的工作方式大同小异。它们都执行根据URL检索资源的GET请求。它们都将资源根据responseType参数匹配为一定的类型。唯一的区别在于getForObject()只返回所请求类型的对象，
而getForEntity()方法会返回请求的对象以及响应相关的额外信息,如HTTP状态码和响应头。

2 Get请求

2.1 get请求的3种重写

  1. public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
  2.         RequestCallback requestCallback = this.acceptHeaderRequestCallback(responseType);
  3.         ResponseExtractor<ResponseEntity<T>> responseExtractor = this.responseEntityExtractor(responseType);
  4.         return (ResponseEntity)nonNull(this.execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables));
  5.     }
  7.     public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  8.         RequestCallback requestCallback = this.acceptHeaderRequestCallback(responseType);
  9.         ResponseExtractor<ResponseEntity<T>> responseExtractor = this.responseEntityExtractor(responseType);
  10.         return (ResponseEntity)nonNull(this.execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables));
  11.     }
  13.     public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException {
  14.         RequestCallback requestCallback = this.acceptHeaderRequestCallback(responseType);
  15.         ResponseExtractor<ResponseEntity<T>> responseExtractor = this.responseEntityExtractor(responseType);
  16.         return (ResponseEntity)nonNull(this.execute(url, HttpMethod.GET, requestCallback, responseExtractor));
  17.     }

2.2 get模式参数传递方式

方法1：直接在url尾部拼接参数

这里根据controller的设置，如果@PathVariable接收，这直接用占位符

也可以直接拼接url参数url?parm=1value&parm2=value2

  1. String result =restTemplate.getForObject("https://bie.tygeinfor.com/sales/wx/getPayInfo/{parm1value}", String.class);

方式2：将参数放到Map中，只放在第三个参数处。

注：这里本质上还是把参数放在了url的地方，只是使用了map字符串格式化的方法。这种避免了拼接长字符串的烦恼。

URL中的{id}占位符最终将会用方法的id参数来填充。getForObject()方法的最后一个参数是大小可变的参数列表，每个参数都会按出现顺序插入到指定URL的占位符中

  1. @Test
  2.   public void test1(){
  3.     String openId="1";
  4.     RestTemplate restTemplate = new RestTemplate();
  5.     Map<String,String> map = new HashMap<>();
  6.     map.put("openId",openId);
  7.     String result =restTemplate.getForObject("http://localhost:8090/sales/wx/getPayInfo/{openId}", String.class,map);
  8.     System.out.println(result);
  9.   }

2.3 getForEntity对比

之前看到的都是getforObject这里对比一下getForEntity,两者用法是完全一样的。只是getForEntity结果包了一层，把Object对方存放在了ResponseEntity的body中。

1，我们可以通过getBody获取返回结果对象
2， 我们可以通过api获取额外的信息如返回码

总结：getForEntity包含了所有getForObject的功能，并且提供了额外的信息。

  1. @Test
  2.   public void test2(){
  3.     String openId="1";
  4.     RestTemplate restTemplate = new RestTemplate();
  5.     Map<String,String> map = new HashMap<>();
  6.     map.put("openId",openId);
  7.     ResponseEntity<String> result =restTemplate.getForEntity("http://localhost:8090/sales/wx/getPayInfo/{openId}",String.class,map);
  8.     System.out.println(result.getBody());
  9.     System.out.println(result.getStatusCode());
  10.   }

2.4 get的结果接收方式

返回结果的接收方式是通过第二个参数控制的，通过传入返回结果的类名.class就告诉转换器最终将消息转换成对应的对象。

我来简单按照业务场景归类

  • 方式1：字符串类型，这种兼容。比如可以把对象类型，json类型，文本类型全部通过字符串接收过来。然后在通过api进行转换。如果遇到格式转换的问题，都可以尝试。

比如上面案例中返回结果都是json类型，我都用字符串接收后。在通过JSONObject的api进行处理，其实是一种很方便的做法。

  • 方式2: 通过JavaBean接收
    这种方式请确保返回类型是符合格式的，并做好异常的处理

    UserInfo result = null;
    result = restTemplate.getForObject(url, UserInfo.class, params);

如果遇到格式转换找不到的问题请参考这个博客，因为返回结果会寻找合适的转换器，如果找不到就会报错。

https://blog.csdn.net/kinginblue/article/details/52706155

3 Post请求

3.1post请求的三种重写方法，和get基本类似

postForLocation，postForEntity,postForObject。三者类似所以只提供一种。

  1. @Nullable
  2.     public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
  3.         RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
  4.         HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters(), this.logger);
  5.         return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, (Object[])uriVariables);
  6.     }
  8.     @Nullable
  9.     public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  10.         RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
  11.         HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters(), this.logger);
  12.         return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, (Map)uriVariables);
  13.     }
  15.     @Nullable
  16.     public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {
  17.         RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
  18.         HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters());
  19.         return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor);
  20.     }

3.2 Post发送参数的方式

首先post不能再url中存放参数，这个是常识。但代码上可以采取上面的第二种方式，即用Map存放key-value
post请求时存放参数的方法如下

方式1：发送表单请求

  1. RestTemplate restTemplate = new RestTemplate();
  3.     HttpHeaders headers = new HttpHeaders();
  4.     headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
  5.     MultiValueMap<String, String> map= new LinkedMultiValueMap<>();
  6.     map.add("brokerId","1");
  8.     HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);
  9.     String result =restTemplate.postForObject("http://localhost:8090/sales/wx/getUserFellows",request,String.class);
  10.     System.out.println(result);

方式2：发送json格式请求

这个是拼接一个json字符串，然后放入请求体中。

HttpEntity就是拼接了请求内容和请求头的参数

  1. String url = "https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token="+accessToken ;
  2.         // 参数：{"expire_seconds": 604800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}
  3.         Map<String,String> strMap = new HashMap<String,String>();
  4.         strMap.put("scene_str",sceneStr);
  5.         Map<String,Map<String,String>> mapMap = new HashMap<String,Map<String,String>>();
  6.         mapMap.put("scene", strMap);
  7.         JSONObject paramsMap = new JSONObject();
  8.         paramsMap.put("expire_seconds", expireSeconds);
  9.         paramsMap.put("action_name", QR_STR_SCENE);
  10.         paramsMap.put("action_info", mapMap);
  11.         HttpHeaders httpHeaders = new HttpHeaders();
  12.         httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);
  13.         HttpEntity requestEntity = new HttpEntity(paramsMap.toJSONString(),httpHeaders);
  14.         String result = null;
  15.         try {
  16.             result = restTemplate.postForObject(url,requestEntity,String.class);
  17.             logger.info("调用生成微信临时二维码URL接口返回结果:" + result);
  18.         } catch (Exception e) {
  19.             logger.error("调用生成微信临时二维码URL接口异常",e);
  20.         }

3.3 接收参数

和get请求相同不在重述

exchange()和excute()

exchange()方法跟上面的getForObject()、getForEntity()、postForObject()、postForEntity()等方法不同之处在于它可以指定请求的HTTP类型。

这两个用法完全一致，只是一个返回Object,一个返回ResponseEntity

这个示例也是发送json请求但采用了另外一种方式。

  1. @Test
  2.     public void rtExchangeTest() throws JSONException {
  3.         RestTemplate restTemplate = new RestTemplate();
  4.         String url = "http://xxx.top/notice/list";
  5.         HttpHeaders headers = new HttpHeaders();
  6.         headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
  7.         JSONObject jsonObj = new JSONObject();
  8.         jsonObj.put("start",1);
  9.         jsonObj.put("page",5);
  11.         HttpEntity<String> entity = new HttpEntity<>(jsonObj.toString(), headers);
  12.         ResponseEntity<JSONObject> exchange = restTemplate.exchange(url, 
  13.                                           HttpMethod.GET, entity, JSONObject.class);
  14.         System.out.println(exchange.getBody());
  15.     }

参考

  • https://www.jianshu.com/p/27a82c494413
  • 《springboot实战》

发表评论

表情：
评论列表 （有 0 条评论，85人围观）

还没有评论，来说两句吧...

相关阅读