关于Springboot中使用RestTemplate 小结

川长思鸟来 2022-12-08 04:40 283阅读 0赞

### 文章目录 ###

*  1. RestTemplate概述
 *  2. RestTemplate配置@Retry
 *  3. RestTemplate配置转换器
 *  4. 问题总结

> Synchronous client to perform HTTP requests, exposing a simple, template method API over underlying HTTP client libraries such as the JDK HttpURLConnection, Apache HttpComponents, and others.  
> The RestTemplate offers templates for common scenarios by HTTP method, in addition to the generalized exchange and execute methods that support of less frequent cases.

# 1. RestTemplate概述 #

最近需要在Springboot项目中添加post功能并且通过api下载文件到本地。在这个过程中，如果直接使用HttpClient可能会有点繁琐，而RestTemplate就很好的解决了这个问题。RestTemplate 采用同步方式执行 HTTP 请求的类，底层使用 JDK 原生 HttpURLConnection API ，或者 HttpComponents等其他 HTTP 客户端请求类库。  
更重要的是，通过它我们可以很容易地发送http请求。  
因为网上很多使用RestTemplate的教程，所以以下小结主要是分享我使用过程中遇到的几个问题以及解决方案。

# 2. RestTemplate配置@Retry #

1.  pom.xml依赖。

<dependency>
    			<groupId>org.apache.httpcomponents</groupId>
    			<artifactId>httpclient</artifactId>
    			<version>4.5.5</version>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.retry</groupId>
    			<artifactId>spring-retry</artifactId>
    			<version>1.2.5.RELEASE</version>
    		</dependency>
    		<dependency>
    			<groupId>org.aspectj</groupId>
    			<artifactId>aspectjweaver</artifactId>
    			<version>1.5.4</version>
    		</dependency>
    		<dependency>
    			<groupId>com.google.code.gson</groupId>
    			<artifactId>gson</artifactId>
    			<version>2.8.5</version>
    		</dependency>

1.  Springboot启动类增加\*\*@EnableRetry\*\*注解。

@SpringBootApplication
    @EnableRetry
    public class TestApplication { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(TestApplication.class, args);
    	}
    
    }

1.  假设这里有两个service，分别是**Test1ServiceImpl**，**Test2ServiceImpl**。

@Service
    public class Test1ServiceImpl implements Test1Service { 
    
        @Autowired
        private Test2Service test2Service;
    
        @Override
        public Boolean getDate() { 
    		SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
    		String url = "http://xxxxxx.com?date="+sdf.format(new Date());
    
            test2Service.dosomething(url);
    
            return Boolean.TRUE;
        }
    
    }

@Service
    public class Test2ServiceImpl implements Test2Service { 
    
        @Autowired
        RestTemplate restTemplate;
    
        @Override
        @Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 5000, multiplier = 1.5, maxDelay = 360000L))
        public Boolean dosomething(String url) { 
            // JsonObject jsonObject = restTemplate.getForObject(url, JsonObject.class);
            String json = restTemplate.getForObject(url + exchange + '.' + pattern, String.class);
    
            System.out.println(json);
            return Boolean.TRUE;
        }
    
        @Recover
        public Boolean failedLog(Exception e) { 
    		System.out.println(e.getMessage());
            return Boolean.FALSE;
        }
    
    }

**注**：通过Test1ServiceImpl注入的Test2Service，来访问api。因为如果访问太过频繁可能会导致响应时间过长而失败，所以这里加入了Retry机制。dosomething()中如果报异常将会重试5次，每次延迟5秒。

# 3. RestTemplate配置转换器 #

1.  新建一个**StringToJsonObjectMessageConverter**并且继承**AbstractHttpMessageConverter**。

public class StringToJsonObjectMessageConverter extends AbstractHttpMessageConverter<JsonObject> { 
    
        public StringToJsonObjectMessageConverter() { 
            super(StandardCharsets.UTF_8, MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML);
        }
    
        @Override
        protected boolean supports(Class<?> aClass) { 
            return JsonObject.class == aClass;
        }
    
        @Override
        protected JsonObject readInternal(Class<? extends JsonObject> aClass, HttpInputMessage httpInputMessage) throws IOException, HttpMessageNotReadableException { 
            String temp = StreamUtils.copyToString(httpInputMessage.getBody(), Charset.forName("UTF-8"));
            return new Gson().fromJson(temp, JsonObject.class);
        }
    
        @Override
        protected void writeInternal(JsonObject jsonObject, HttpOutputMessage httpOutputMessage) throws IOException, HttpMessageNotWritableException { 
            httpOutputMessage.getBody().write(jsonObject.getAsByte());
        }
    
    }

**注**：这里的Json包使用的是Gson。

1.  新建一个RestTemplateConfig。

@Configuration
    public class RestTemplateConfig { 
    
        @Bean
        public RestTemplate restTemplate() { 
            HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
            httpRequestFactory.setConnectionRequestTimeout(30 * 1000);
            httpRequestFactory.setConnectTimeout(30 * 3000);
            httpRequestFactory.setReadTimeout(30 * 3000);
            RestTemplate restTemplate = new RestTemplate(httpRequestFactory);
            restTemplate.getMessageConverters().set(1, new StringToJsonObjectMessageConverter());
            restTemplate.getMessageConverters().add(new StringHttpMessageConverter(StandardCharsets.UTF_8));
            return restTemplate;
        }
    
    }

**注**：其中引入了第1步的StringToJsonObjectMessageConverter。

1.  回到Test2ServiceImpl，我们注意到这里面已经有一行代码是用到了Converter的。

@Override
        @Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 5000, multiplier = 1.5, maxDelay = 360000L))
        public Boolean dosomething(String url) { 
            JsonObject jsonObject = restTemplate.getForObject(url, JsonObject.class);
            System.out.println(jsonObject);
            return Boolean.TRUE;
        }

# 4. 问题总结 #

1.  如果遇到：ClassNotFoundException: org.aspectj.lang.annotation.Pointcut… ，查看**pom.xml**是否引入了**org.aspectj**。
2.  值得注意的是，Retry用到了aspect增强，而方法内部调用会使aspect增强失效，所以\*\*@Retryable的方法不能在本类被调用\*\*，这就是为什么我分开两个@Service。如果Retry不生效，确保@EnableRetry注解是否加上了。更多原因可以参考：[Springboot重试机制][Springboot]
3.  如果遇到：…ExhaustedRetryException: Cannot locate recovery method ，要检查\*\*@Retryable注解的方法可能会产生的异常类型和方法返回值类型要与@Recover的重试方法一致\*\*。比如：Test2ServiceImpl的dosomething返回Boolean并且捕获的是Exception.class，那么failedLog()的参数也必须是Exception并且返回Boolean。
4.  如果遇到：…Could not extract response: no suitable HttpMessageConverter found for response type \[class com.google.gson.JsonObject\] and content type \[text/html\] ，是因为我们的StringToJsonObjectMessageConverter没有注册处理text/html这类型内容的功能。注意到下面的这个构造方法中的**MediaType.TEXT\_HTML**，加上了这个就能解决这个问题了。同样的，编码格式也是在这设置，如：**StandardCharsets.UTF\_8**。

public StringToJsonObjectMessageConverter() { 
            super(StandardCharsets.UTF_8, MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML);
        }

**附**：

1.  如果需要参考更详细的RestTemplate教程可以参考：[掌握 Spring 之 RestTemplate][Spring _ RestTemplate]
2.  关于配置Converter也可以参考：[自定义HttpMessageConverter][HttpMessageConverter]

[Springboot]: https://my.oschina.net/wangjunBlog/blog/1889015
[Spring _ RestTemplate]: https://juejin.im/post/6844903842065154061
[HttpMessageConverter]: https://www.cnblogs.com/houzheng/p/11944488.html