余晖落尽暮晚霞,黄昏迟暮远山寻
本站
当前位置:网站首页 > 编程知识 > 正文

微服务中如何使用RestTemplate优雅调用API(详细分析)

xiyangw 2022-11-24 17:10 90 浏览 0 评论

关注我,可以获取最新知识、经典面试题以及微服务技术分享

在微服务中,rest服务互相调用是很普遍的,我们该如何优雅地调用,其实在Spring框架使用RestTemplate类可以优雅地进行rest服务互相调用,它简化了与http服务的通信方式,统一了RESTful的标准,封装了http链接,操作使用简便,还可以自定义RestTemplate所需的模式。其中:

  • RestTemplate默认使用HttpMessageConverter实例将HTTP消息转换成POJO或者从POJO转换成HTTP消息。默认情况下会注册主mime类型的转换器,但也可以通过setMessageConverters注册自定义转换器。
  • RestTemplate使用了默认的DefaultResponseErrorHandler,对40X Bad Request或50X internal异常error等错误信息捕捉。
  • RestTemplate还可以使用拦截器interceptor,进行对请求链接跟踪,以及统一head的设置。

其中,RestTemplate还定义了很多的REST资源交互的方法,其中的大多数都对应于HTTP的方法,如下:

  • delete():在特定的URL上对资源执行HTTP DELETE操作
  • exchange():在URL上执行特定的HTTP方法,返回包含对象的ResponseEntity
  • execute():在URL上执行特定的HTTP方法,返回一个从响应体映射得到的对象
  • getForEntity():发送一个HTTP GET请求,返回的ResponseEntity包含了响应体所映射成的对象
  • getForObject():发送一个HTTP GET请求,返回的请求体将映射为一个对象postForEntity():POST 数据到一个URL,返回包含一个对象的
  • ResponseEntitypostForObject():POST 数据到一个URL,返回根据响应体匹配形成的对象
  • headForHeaders():发送HTTP HEAD请求,返回包含特定资源URL的HTTP头
  • optionsForAllow():发送HTTP OPTIONS请求,返回对特定URL的Allow头信息
  • postForLocation():POST 数据到一个URL,返回新创建资源的URLput()PUT 资源到特定的URL

1.1 默认调用链路

restTemplate进行API调用时,默认调用链:

 ###########1.使用createRequest创建请求########
 resttemplate->execute()->doExecute()
 HttpAccessor->createRequest()
 //获取拦截器Interceptor,InterceptingClientHttpRequestFactory,SimpleClientHttpRequestFactory
 InterceptingHttpAccessor->getRequestFactory() 
 //获取默认的SimpleBufferingClientHttpRequest
 SimpleClientHttpRequestFactory->createRequest()
 #######2.获取响应response进行处理###########
 AbstractClientHttpRequest->execute()->executeInternal()
 AbstractBufferingClientHttpRequest->executeInternal()
 ###########3.异常处理#####################
 resttemplate->handleResponse()
 ##########4.响应消息体封装为java对象#######
 HttpMessageConverterExtractor->extractData()

1.2 restTemplate->doExecute()

在默认调用链中,restTemplate 进行API调用都会调用 doExecute 方法,此方法主要可以进行如下步骤:

1)使用createRequest创建请求,获取响应

2)判断响应是否异常,处理异常

3)将响应消息体封装为java对象

 @Nullable
 protected <T> T doExecute(URI url, @Nullable HttpMethod method, @Nullable RequestCallback requestCallback,
 @Nullable ResponseExtractor<T> responseExtractor) throws RestClientException {
 Assert.notNull(url, "URI is required");
 Assert.notNull(method, "HttpMethod is required");
 ClientHttpResponse response = null;
 try {
 //使用createRequest创建请求
 ClientHttpRequest request = createRequest(url, method);
 if (requestCallback != null) {
 requestCallback.doWithRequest(request);
 }
 //获取响应response进行处理
 response = request.execute();
 //异常处理
 handleResponse(url, method, response);
 //响应消息体封装为java对象
 return (responseExtractor != null ? responseExtractor.extractData(response) : null);
 }catch (IOException ex) {
 String resource = url.toString();
 String query = url.getRawQuery();
 resource = (query != null ? resource.substring(0, resource.indexOf('?')) : resource);
 throw new ResourceAccessException("I/O error on " + method.name() +
 " request for \"" + resource + "\": " + ex.getMessage(), ex);
 }finally {
 if (response != null) {
 response.close();
 }
 }
 }
 

1.3 InterceptingHttpAccessor->getRequestFactory()

在默认调用链中,InterceptingHttpAccessor的getRequestFactory()方法中,如果没有设置interceptor拦截器,就返回默认的SimpleClientHttpRequestFactory,反之,返回InterceptingClientHttpRequestFactory的requestFactory,可以通过resttemplate.setInterceptors设置自定义拦截器interceptor。

 //Return the request factory that this accessor uses for obtaining client request handles.
 public ClientHttpRequestFactory getRequestFactory() {
 //获取拦截器interceptor(自定义的)
 List<ClientHttpRequestInterceptor> interceptors = getInterceptors();
 if (!CollectionUtils.isEmpty(interceptors)) {
 ClientHttpRequestFactory factory = this.interceptingRequestFactory;
 if (factory == null) {
 factory = new InterceptingClientHttpRequestFactory(super.getRequestFactory(), interceptors);
 this.interceptingRequestFactory = factory;
 }
 return factory;
 }
 else {
 return super.getRequestFactory();
 }
 }
然后再调用`SimpleClientHttpRequestFactory的createRequest`创建连接:
 @Override
 public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException {
 HttpURLConnection connection = openConnection(uri.toURL(), this.proxy);
 prepareConnection(connection, httpMethod.name());
 if (this.bufferRequestBody) {
 return new SimpleBufferingClientHttpRequest(connection, this.outputStreaming);
 }
 else {
 return new SimpleStreamingClientHttpRequest(connection, this.chunkSize, this.outputStreaming);
 }
 }
 

1.4 resttemplate->handleResponse()

在默认调用链中,resttemplate的handleResponse,响应处理,包括异常处理,而且异常处理可以通过调用setErrorHandler方法设置自定义的ErrorHandler,实现对请求响应异常的判别和处理。自定义的ErrorHandler需实现ResponseErrorHandler接口,同时Spring boot也提供了默认实现DefaultResponseErrorHandler,因此也可以通过继承该类来实现自己的ErrorHandler。

DefaultResponseErrorHandler默认对40X Bad Request或50X internal异常error等错误信息捕捉。如果想捕捉服务本身抛出的异常信息,需要通过自行实现RestTemplate的ErrorHandler。

 ResponseErrorHandler errorHandler = getErrorHandler();
 //判断响应是否有异常
 boolean hasError = errorHandler.hasError(response);
 if (logger.isDebugEnabled()) {
 try {
 int code = response.getRawStatusCode();
 HttpStatus status = HttpStatus.resolve(code);
 logger.debug("Response " + (status != null ? status : code));
 }catch (IOException ex) {
 // ignore
 }
 }
 //有异常进行异常处理
 if (hasError) {
 errorHandler.handleError(url, method, response);
 }
 }
 

1.5 HttpMessageConverterExtractor->extractData()

在默认调用链中, HttpMessageConverterExtractor的extractData中进行响应消息体封装为java对象,就需要使用message转换器,可以通过追加的方式增加自定义的messageConverter:先获取现有的messageConverter,再将自定义的messageConverter添加进去。

根据restTemplate的setMessageConverters的源码可得,使用追加的方式可防止原有的messageConverter丢失,源码:

 public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
 //检验
 validateConverters(messageConverters);
 // Take getMessageConverters() List as-is when passed in here
 if (this.messageConverters != messageConverters) {
 //先清除原有的messageConverter
 this.messageConverters.clear();
 //后加载重新定义的messageConverter
 this.messageConverters.addAll(messageConverters);
 }
 }

HttpMessageConverterExtractor的extractData源码:

 MessageBodyClientHttpResponseWrapper responseWrapper = new MessageBodyClientHttpResponseWrapper(response);
 if (!responseWrapper.hasMessageBody() || responseWrapper.hasEmptyMessageBody()) {
 return null;
 }
 //获取到response的ContentType类型
 MediaType contentType = getContentType(responseWrapper);
 try {
 //依次循环messageConverter进行判断是否符合转换条件,进行转换java对象
 for (HttpMessageConverter<?> messageConverter : this.messageConverters) {
 //会根据设置的返回类型responseType和contentType参数进行匹配,选择合适的MessageConverter
 if (messageConverter instanceof GenericHttpMessageConverter) {
 GenericHttpMessageConverter<?> genericMessageConverter =
 (GenericHttpMessageConverter<?>) messageConverter;
 if (genericMessageConverter.canRead(this.responseType, null, contentType)) {
 if (logger.isDebugEnabled()) {
 ResolvableType resolvableType = ResolvableType.forType(this.responseType);
 logger.debug("Reading to [" + resolvableType + "]");
 }
 return (T) genericMessageConverter.read(this.responseType, null, responseWrapper);
 }
 }
 if (this.responseClass != null) {
 if (messageConverter.canRead(this.responseClass, contentType)) {
 if (logger.isDebugEnabled()) {
 String className = this.responseClass.getName();
 logger.debug("Reading to [" + className + "] as \"" + contentType + "\"");
 }
 return (T) messageConverter.read((Class) this.responseClass, responseWrapper);
 }
 }
 }
 }
 .....
 }

1.6 contentType与messageConverter之间的关系

在HttpMessageConverterExtractor的extractData方法中看出,会根据contentType与responseClass选择messageConverter是否可读、消息转换。关系如下:

  • ByteArrayHttpMessageConverter:java对象byte[],contentType为application/octet-stream, */*String
  • HttpMessageConverter: :java对象String,contentType为text/plain, */*
  • ResourceHttpMessageConverter: Resource,contentType为*/*
  • SourceHttpMessageConverter: :java对象Source ,contentType为application/xml, text/xml, application/*+xml
  • AllEncompassingFormHttpMessageConverter::java对象Map<K, List<?>>,contentType为application/x-www-form-urlencoded, multipart/form-data
  • MappingJackson2HttpMessageConverter::java对象Object ,contentType为application/json, application/*+json
  • Jaxb2RootElementHttpMessageConverter::java对象Object ,contentType为 application/xml, text/xml, application/*+xml
  • JavaSerializationConverter::java对象Serializable ,contentType为x-java-serialization;charset=UTF-8
  • FastJsonHttpMessageConverter: :java对象Object ,contentType为 */*

根据上述源码的分析学习,可以轻松,简单地在项目进行对RestTemplate进行优雅地使用,比如增加自定义的异常处理、MessageConverter以及拦截器interceptor。本文使用示例demo,详情请查看接下来的内容。

2.1. 导入依赖:(RestTemplate集成在Web Start中)

 <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web -->
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 <version>2.2.0.RELEASE</version>
 </dependency>
 <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
 <dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <version>1.18.10</version>
 <scope>provided</scope>
 </dependency>

2.2. RestTemplat配置:

  • 使用ClientHttpRequestFactory属性配置RestTemplat参数,比如ConnectTimeout,ReadTimeout;
  • 增加自定义的interceptor拦截器和异常处理;
  • 追加message转换器;
  • 配置自定义的异常处理.
 
 @Configuration
 public class RestTemplateConfig {
 @Value("${resttemplate.connection.timeout}")
 private int restTemplateConnectionTimeout;
 @Value("${resttemplate.read.timeout}")
 private int restTemplateReadTimeout;
 @Bean
 //@LoadBalanced
 public RestTemplate restTemplate( ClientHttpRequestFactory simleClientHttpRequestFactory) {
 RestTemplate restTemplate = new RestTemplate();
 //配置自定义的message转换器
 List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
 messageConverters.add(new CustomMappingJackson2HttpMessageConverter());
 restTemplate.setMessageConverters(messageConverters);
 //配置自定义的interceptor拦截器
 List<ClientHttpRequestInterceptor> interceptors=new ArrayList<ClientHttpRequestInterceptor>();
 interceptors.add(new HeadClientHttpRequestInterceptor());
 interceptors.add(new TrackLogClientHttpRequestInterceptor());
 restTemplate.setInterceptors(interceptors);
 //配置自定义的异常处理
 restTemplate.setErrorHandler(new CustomResponseErrorHandler());
 restTemplate.setRequestFactory(simleClientHttpRequestFactory);
 return restTemplate;
 }
 @Bean
 public ClientHttpRequestFactory simleClientHttpRequestFactory(){
 SimpleClientHttpRequestFactory reqFactory= new SimpleClientHttpRequestFactory();
 reqFactory.setConnectTimeout(restTemplateConnectionTimeout);
 reqFactory.setReadTimeout(restTemplateReadTimeout);
 return reqFactory;
 }
 }

2.3. 组件(自定义异常处理、interceptor拦截器、message转化器)

自定义interceptor拦截器,实现ClientHttpRequestInterceptor接口

  • 自定义TrackLogClientHttpRequestInterceptor,记录resttemplate的request和response信息,可进行追踪分析;
  • 自定义HeadClientHttpRequestInterceptor,设置请求头的参数。API发送各种请求,很多请求都需要用到相似或者相同的Http Header。如果在每次请求之前都把Header填入HttpEntity/RequestEntity,这样的代码会显得十分冗余,可以在拦截器统一设置。

TrackLogClientHttpRequestInterceptor:

 /**
 * @Auther: ccww
 * @Date: 2019/10/25 22:48,记录resttemplate访问信息
 * @Description: 记录resttemplate访问信息
 */
 @Slf4j
 public class TrackLogClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
 public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
 trackRequest(request,body);
 ClientHttpResponse httpResponse = execution.execute(request, body);
 trackResponse(httpResponse);
 return httpResponse;
 }
 private void trackResponse(ClientHttpResponse httpResponse)throws IOException {
 log.info("============================response begin==========================================");
 log.info("Status code : {}", httpResponse.getStatusCode());
 log.info("Status text : {}", httpResponse.getStatusText());
 log.info("Headers : {}", httpResponse.getHeaders());
 log.info("=======================response end=================================================");
 }
 private void trackRequest(HttpRequest request, byte[] body)throws UnsupportedEncodingException {
 log.info("======= request begin ========");
 log.info("uri : {}", request.getURI());
 log.info("method : {}", request.getMethod());
 log.info("headers : {}", request.getHeaders());
 log.info("request body : {}", new String(body, "UTF-8"));
 log.info("======= request end ========");
 }
 }

HeadClientHttpRequestInterceptor:

 @Slf4j
 public class HeadClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
 public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
 log.info("#####head handle########");
 HttpHeaders headers = httpRequest.getHeaders();
 headers.add("Accept", "application/json");
 headers.add("Accept-Encoding", "gzip");
 headers.add("Content-Encoding", "UTF-8");
 headers.add("Content-Type", "application/json; charset=UTF-8");
 ClientHttpResponse response = clientHttpRequestExecution.execute(httpRequest, bytes);
 HttpHeaders headersResponse = response.getHeaders();
 headersResponse.add("Accept", "application/json");
 return response;
 }
 }
<br>

自定义异常处理,可继承DefaultResponseErrorHandler或者实现ResponseErrorHandler接口:

  • 实现自定义ErrorHandler的思路是根据响应消息体进行相应的异常处理策略,对于其他异常情况由父类DefaultResponseErrorHandler来进行处理。
  • 自定义CustomResponseErrorHandler进行30x异常处理

CustomResponseErrorHandler:

 /**
 * @Auther: Ccww
 * @Date: 2019/10/28 17:00
 * @Description: 30X的异常处理
 */
 @Slf4j
 public class CustomResponseErrorHandler extends DefaultResponseErrorHandler {
 @Override
 public boolean hasError(ClientHttpResponse response) throws IOException {
 HttpStatus statusCode = response.getStatusCode();
 if(statusCode.is3xxRedirection()){
 return true;
 }
 return super.hasError(response);
 }
 @Override
 public void handleError(ClientHttpResponse response) throws IOException {
 HttpStatus statusCode = response.getStatusCode();
 if(statusCode.is3xxRedirection()){
 log.info("########30X错误,需要重定向!##########");
 return;
 }
 super.handleError(response);
 }
 }

自定义message转化器

 /**
 * @Auther: Ccww
 * @Date: 2019/10/29 21:15
 * @Description: 将Content-Type:"text/html"转换为Map类型格式
 */
 public class CustomMappingJackson2HttpMessageConverter extends MappingJackson2HttpMessageConverter {
 public CustomMappingJackson2HttpMessageConverter() {
 List<MediaType> mediaTypes = new ArrayList<MediaType>();
 mediaTypes.add(MediaType.TEXT_PLAIN);
 mediaTypes.add(MediaType.TEXT_HTML); //加入text/html类型的支持
 setSupportedMediaTypes(mediaTypes);// tag6
 }

`}

相关推荐

高效删除文件名中的指定内容,祛除烦恼

如何快速批量删除文件名中的指定字符?在电脑整理文件时,我们常常需要进行批量重命名操作。如果文件名中含有不必要或重复的字符,这将影响文件的识别和查找。因此,删除这些文字或字符是非常必要且有效的。本文将分...

你的手机是不是经常提示存储空间不足?Python帮你清理重复文件

  最近我的手机经常提示存储空间不足,主要是微信和QQ群里接收的文件太多了,平时也没怎么整理。我把这些文件从手机里拷出来,打算整理一下,把该删的文件都删掉,把要备份的文件分门别类存到电脑或网盘上。我突...

从零开始打造云端AI管理调度平台(四)如何设计主页_1

最近闲来无事,想着把自己工作正在做的一个项目做一个简单的分享与实战教程,该项目不困难但是由于涉及要素过多所以比较复杂。所以这里分享出来也是为了帮助新手小白能在实战当中快速了解python知识。主要内容...

「万能Python」-17-标准库OS_python2.7标准库

Python的库是指预先编写好的代码集合,可以用来处理特定的任务或实现特定的功能。Python的标准库提供了许多常用的标准库,无需安装引入使用。Python3的标准库提供了许多常用的功能,包括...

十多行代码生成原帖和临写对照图_几十行代码可以申请软著吗

介绍这个小工具把原帖和临写分解成多列对照的形式。输入原帖图片,和输入临写图片,生成对照图片。使用说明运行compare.py文件,输入参数为:原帖图片文件名,临写图片文件名,列数。python3co...

Python合集之目录操作(四)_python之文件操作大全

1.删除目录删除目录可以通过os模块提供的rmdir()函数实现。通过rmdir()函数删除目录时,只有当要删除的目录为空时才起作用。os.rmdir(path)path为要删除的目录,可以使用绝对路...

excel办公自动化,自动合并excel表格

平时时收到不同人反馈的excel表格,需要将其合并在一个excel中,每个excel打开复制粘贴会很慢,如下脚本可一键合并所有的exceldefauto_merge():try:print('...

批量打开一个文件夹下面所有的excel表格

如果现在有一个文件夹,名称叫做“练习表格”,路径名是'C:\Users\123\Desktop\练习表格',现在的要求是打开这个文件下面所有的excel表格,后缀名字为“xlsx”,我...

500行代码,教你用python写个微信飞机大战

这几天在重温微信小游戏的飞机大战,玩着玩着就在思考人生了,这飞机大战怎么就可以做的那么好,操作简单,简单上手。帮助蹲厕族、YP族、饭圈女孩在无聊之余可以有一样东西让他们振作起来!让他们的左手/右手...

python 日志写入_python日志文件写入

1.第一步,新建日志文件路径,如下图:2.日志模块封装,代码如下:importlogging,oslogs_path=os.path.join(os.path.dirname(__file...

Python os.path模块使用指南:轻松处理文件路径

前言在Python编程中,文件和目录的操作是非常重要的一部分。为了方便用户进行文件和目录的操作,Python标准库提供了os模块。其中,os.path子模块提供了一些处理文件路径的函数和方法。本文主要...

Python中获取当前路径之pathilb和os的区别

20230114星期六:1,直接在py脚本中,执行,没有区别;2,打包成exe文件以后,在本机执行,有区别,这时,不能使用os.path.dirname(__file__),只能使用pathlib.P...

Python(办公自动化编程系列)学习笔记1

1、获得当前程序工作目录importos#os.getcwd()函数可以取得当前工作路径的字符串print(os.getcwd())运行结果2、获得程序文件夹相对路径#相对路径都用/表示#../...

文件路径名Pathnames的操作_路径和文件名是什么意思

1.现象问题使用路径名来获取文件名,目录名,绝对路径等等2.原因分析无3.问题解决使用os.path模块中的函数来操作路径名importos.path#查看标准化的绝对路径print...

关于《Python入门:os常用函数》中复制文件(夹)函数从简到繁

基本考虑练习os模块及file读写操作:将给定的源路径的文件(夹)复制到目标路径简单实现#文件到文件的复制path_src='E:\src.txt'path_tar='D...

取消回复欢迎 发表评论: