面试题-Springboot-RestTemplate详解
RestTemplate
是Spring
提供的用于访问Rest服务的客户端,RestTemplate
提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。
我之前的HTTP开发是用apache的HttpClient开发,代码复杂,还得操心资源回收等。
本教程将带领大家实现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的六个方法制定:
HTTP method | RestTemplate methods |
---|---|
DELETE | delete |
GET | getForObject |
getForEntity | |
HEAD | headForHeaders |
OPTIONS | optionsForAllow |
POST | postForLocation |
postForObject | |
PUT | put |
any | exchange |
execute |
此外,exchange和excute可以通用上述方法。
在内部,RestTemplate
默认使用HttpMessageConverter
实例将HTTP
消息转换成POJO
或者从POJO
转换成HTTP
消息。默认情况下会注册主mime类型的转换器,但也可以通过setMessageConverters
注册其他的转换器。(其实这点在使用的时候是察觉不到的,很多方法有一个responseType 参数,它让你传入一个响应体所映射成的对象,然后底层用HttpMessageConverter将其做映射)
HttpMessageConverter.java
源码:
在内部,RestTemplate
默认使用SimpleClientHttpRequestFactory
和DefaultResponseErrorHandler
来分别处理HTTP
的创建和错误,但也可以通过setRequestFactory
和setErrorHandler
来覆盖。
2. get请求实践
2.1. getForObject()方法
getForObject()
其实比getForEntity()
多包含了将HTTP转成POJO的功能,但是getForObject
没有处理response
的能力。因为它拿到手的就是成型的pojo
。省略了很多response
的信息。
2.1.1 POJO:
示例:2.1.2 不带参的get请求
控制台打印:
示例:2.1.3 带参数的get请求1
明眼人一眼能看出是用了占位符{1}
。
示例:2.1.4 带参数的get请求2
明眼人一看就是利用map装载参数,不过它默认解析的是PathVariable
的url形式。
2.2 getForEntity()方法
与getForObject()方法不同的是返回的是ResponseEntity
对象,如果需要转换成pojo,还需要json工具类的引入,这个按个人喜好用。不会解析json的可以百度FastJson
或者Jackson
等工具类。然后我们就研究一下ResponseEntity
下面有啥方法。
ResponseEntity、HttpStatus、BodyBuilder结构
ResponseEntity.java
HttpStatus.java
BodyBuilder.java
可以看出来,ResponseEntity包含了HttpStatus和BodyBuilder的这些信息,这更方便我们处理response原生的东西。
示例:
当然,还有getHeaders()
等方法没有举例。
3. post请求实践
同样的,post请求也有
postForObject
和postForEntity
。
示例
我用一个验证邮箱的接口来测试。
执行结果:
代码中,MultiValueMap
是Map
的一个子类,它的一个key
可以存储多个value
,简单的看下这个接口:
为什么用MultiValueMap
?因为HttpEntity
接受的request类型是它。
为什么用HttpEntity
是因为restTemplate.postForEntity
方法虽然表面上接收的request是@Nullable Object request
类型,但是你追踪下去会发现,这个request
是用HttpEntity
来解析。核心代码如下:
我曾尝试用map来传递参数,编译不会报错,但是执行不了,是无效的url request请求(400 ERROR)。其实这样的请求方式已经满足post请求了,cookie也是属于header的一部分。可以按需求设置请求头和请求体。其它方法与之类似。
4. 使用exchange指定调用方式
exchange()方法跟上面的getForObject()、getForEntity()、postForObject()、postForEntity()等方法不同之处在于它可以指定请求的HTTP类型。
但是你会发现exchange的方法中似乎都有@Nullable HttpEntity<?> requestEntity
这个参数,这就意味着我们至少要用HttpEntity来传递这个请求体,之前说过源码所以建议就使用HttpEntity提高性能。
示例
这次可以看到,我使用了JSONObject
对象传入和返回。
当然,HttpMethod方法还有很多,用法类似。
5. excute()指定调用方式
excute()
的用法与exchange()
大同小异了,它同样可以指定不同的HttpMethod
,不同的是它返回的对象是响应体所映射成的对象<T>
,而不是ResponseEntity<T>
。
需要强调的是,execute()
方法是以上所有方法的底层调用。随便看一个:
评论区