![72bc7f856f990cc8a74f63ccaba541f1.png](https://i-blog.csdnimg.cn/blog_migrate/1defaaefb6ef905015eab8bc3330dee9.jpeg)
RestTemplate是Spring提供的用于访问Rest服务的客户端,RestTemplate提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。
我之前的HTTP开发是用apache的HttpClient开发,代码复杂,还得操心资源回收等。代码很复杂,冗余代码多,稍微截个图,这是我封装好的一个post请求工具:
![0b85c83014b78ea58d930e56d7c1c0fd.png](https://i-blog.csdnimg.cn/blog_migrate/81043581e6e99ee74fbcdd0f03b59476.jpeg)
本教程将带领大家实现Spring生态内RestTemplate的Get请求和Post请求还有exchange指定请求类型的实践和RestTemplate核心方法源码的分析,看完你就会用优雅的方式来发HTTP请求。
1.简述RestTemplate
是Spring用于同步client端的核心类,简化了与http服务的通信,并满足RestFul原则,程序代码可以给它提供URL,并提取结果。默认情况下,RestTemplate默认依赖jdk的HTTP连接工具。当然你也可以 通过setRequestFactory属性切换到不同的HTTP源,比如Apache HttpComponents、Netty和OkHttp。
RestTemplate能大幅简化了提交表单数据的难度,并且附带了自动转换JSON数据的功能,但只有理解了HttpEntity的组成结构(header与body),且理解了与uriVariables之间的差异,才能真正掌握其用法。这一点在Post请求更加突出,下面会介绍到。
该类的入口主要是根据HTTP的六个方法制定:
![adad6f1d280c8557782b8e532518576d.png](https://i-blog.csdnimg.cn/blog_migrate/373328e1af431971a935084ec45f117f.png)
此外,exchange和excute可以通用上述方法。
在内部,RestTemplate默认使用HttpMessageConverter实例将HTTP消息转换成POJO或者从POJO转换成HTTP消息。默认情况下会注册主mime类型的转换器,但也可以通过setMessageConverters注册其他的转换器。
其实这点在使用的时候是察觉不到的,很多方法有一个responseType 参数,它让你传入一个响应体所映射成的对象,然后底层用HttpMessageConverter将其做映射
HttpMessageConverterExtractor
HttpMessageConverter.java源码:
public
在内部,RestTemplate默认使用SimpleClientHttpRequestFactory和DefaultResponseErrorHandler来分别处理HTTP的创建和错误,但也可以通过setRequestFactory和setErrorHandler来覆盖。
2.get请求实践
2.1.getForObject()方法
public
getForObject()其实比getForEntity()多包含了将HTTP转成POJO的功能,但是getForObject没有处理response的能力。因为它拿到手的就是成型的pojo。省略了很多response的信息。
2.1.1 POJO:
public
示例:2.1.2 不带参的get请求
/**
控制台打印:
INFO
示例:2.1.3 带参数的get请求1
Notice
明眼人一眼能看出是用了占位符{1}。
示例:2.1.4 带参数的get请求2
Map
明眼人一看就是利用map装载参数,不过它默认解析的是PathVariable的url形式。
2.2 getForEntity()方法
public
与getForObject()方法不同的是返回的是ResponseEntity对象,如果需要转换成pojo,还需要json工具类的引入,这个按个人喜好用。不会解析json的可以百度FastJson或者Jackson等工具类。然后我们就研究一下ResponseEntity下面有啥方法。
ResponseEntity、HttpStatus、BodyBuilder结构
ResponseEntity.java
public
HttpStatus.java
public
BodyBuilder.java
public
可以看出来,ResponseEntity包含了HttpStatus和BodyBuilder的这些信息,这更方便我们处理response原生的东西。
示例:
@Test
statusCode
当然,还有getHeaders()等方法没有举例。
3. post请求实践
同样的,post请求也有postForObject和postForEntity。
public
示例
我用一个验证邮箱的接口来测试。
@Test
执行结果:
{
![0a3a3910bd6c2c5cf8e2aa38e42ef9f3.png](https://i-blog.csdnimg.cn/blog_migrate/7fc4f9029bc234d9f5b56b4880e200ce.jpeg)
代码中,MultiValueMap是Map的一个子类,它的一个key可以存储多个value,简单的看下这个接口:
public
为什么用MultiValueMap?因为HttpEntity接受的request类型是它。
public
为什么用HttpEntity是因为restTemplate.postForEntity方法虽然表面上接收的request是@Nullable Object request类型,但是你追踪下去会发现,这个request是用HttpEntity来解析。核心代码如下:
if
我曾尝试用map来传递参数,编译不会报错,但是执行不了,是无效的url request请求(400 ERROR)。其实这样的请求方式已经满足post请求了,cookie也是属于header的一部分。可以按需求设置请求头和请求体。其它方法与之类似。
4.使用exchange指定调用方式
exchange()方法跟上面的getForObject()、getForEntity()、postForObject()、postForEntity()等方法不同之处在于它可以指定请求的HTTP类型。
![d0bc5b32ea0739de98fdebed17ee07ce.png](https://i-blog.csdnimg.cn/blog_migrate/bcbc71f1208e0a6dd180a298260f122f.jpeg)
但是你会发现exchange的方法中似乎都有@Nullable HttpEntity requestEntity这个参数,这就意味着我们至少要用HttpEntity来传递这个请求体,之前说过源码所以建议就使用HttpEntity提高性能。
示例
@Test
这次可以看到,我使用了JSONObject对象传入和返回。
当然,HttpMethod方法还有很多,用法类似。
5.excute()指定调用方式
excute()的用法与exchange()大同小异了,它同样可以指定不同的HttpMethod,不同的是它返回的对象是响应体所映射成的对象,而不是ResponseEntity。
需要强调的是,execute()方法是以上所有方法的底层调用。随便看一个:
@Override