如何使用Spring RestTemplate访问restful服务

2023-09-06 16:38:05 295

一.什么是RestTemplate

Spring'scentralclassforsynchronousclient-sideHTTPaccess.
ItsimplifiescommunicationwithHTTPservers,andenforcesRESTfulprinciples.
IthandlesHTTPconnections,leavingapplicationcodetoprovideURLs(withpossibletemplatevariables)andextractresults.

上面这段是RestTemplate类中的简单介绍，RestTemplate是Spring3.0后开始提供的用于访问Rest服务的轻量级客户端，相较于传统的HttpURLConnection、ApacheHttpClient、OkHttp等框架，RestTemplate大大简化了发起HTTP请求以及处理响应的过程。本文关注RestTemplate是如何使用的，暂不涉及内部的实现原理。

二.一个简单的例子。

定义一个简单的restful接口

@RestController
publicclassTestController
{
@RequestMapping(value="testPost",method=RequestMethod.POST)
publicResponseBeantestPost(@RequestBodyRequestBeanrequestBean)
{
ResponseBeanresponseBean=newResponseBean();
responseBean.setRetCode("0000");
responseBean.setRetMsg("succ");

returnresponseBean;
}
}

使用RestTemplate访问该服务

//请求地址
Stringurl="http://localhost:8080/testPost";
//入参
RequestBeanrequestBean=newRequestBean();
requestBean.setTest1("1");
requestBean.setTest2("2");
requestBean.setTest3("3");

RestTemplaterestTemplate=newRestTemplate();
ResponseBeanresponseBean=restTemplate.postForObject(url,requestBean,ResponseBean.class);

从这个例子可以看出，使用restTemplate访问restful接口非常的简单粗暴无脑。(url,requestMap,ResponseBean.class)这三个参数分别代表请求地址、请求参数、HTTP响应转换被转换成的对象类型。

RestTemplate方法的名称遵循命名约定，第一部分指出正在调用什么HTTP方法，第二部分指示返回的内容。本例中调用了restTemplate.postForObject方法，post指调用了HTTP的post方法，Object指将HTTP响应转换为您选择的对象类型。还有其他很多类似的方法，有兴趣的同学可以参考官方api。

三.手动指定转换器(HttpMessageConverter)

我们知道，调用reseful接口传递的数据内容是json格式的字符串，返回的响应也是json格式的字符串。然而restTemplate.postForObject方法的请求参数RequestBean和返回参数ResponseBean却都是java类。是RestTemplate通过HttpMessageConverter自动帮我们做了转换的操作。

默认情况下RestTemplate自动帮我们注册了一组HttpMessageConverter用来处理一些不同的contentType的请求。
如StringHttpMessageConverter来处理text/plain;MappingJackson2HttpMessageConverter来处理application/json;MappingJackson2XmlHttpMessageConverter来处理application/xml。
你可以在org.springframework.http.converter包下找到所有spring帮我们实现好的转换器。
如果现有的转换器不能满足你的需求，你还可以实现org.springframework.http.converter.HttpMessageConverter接口自己写一个。详情参考官方api。

选好了HttpMessageConverter后怎么把它注册到我们的RestTemplate中呢。

RestTemplaterestTemplate=newRestTemplate();
//获取RestTemplate默认配置好的所有转换器
List>messageConverters=restTemplate.getMessageConverters();
//默认的MappingJackson2HttpMessageConverter在第7个先把它移除掉
messageConverters.remove(6);
//添加上GSON的转换器
messageConverters.add(6,newGsonHttpMessageConverter());

这个简单的例子展示了如何使用GsonHttpMessageConverter替换掉默认用来处理application/json的MappingJackson2HttpMessageConverter。

四.设置底层连接方式

要创建一个RestTemplate的实例，您可以像上述例子中简单地调用默认的无参数构造函数。这将使用java.net包中的标准Java类作为底层实现来创建HTTP请求。

但很多时候我们需要像传统的HttpClient那样设置HTTP请求的一些属性。RestTemplate使用了一种很偷懒的方式实现了这个需求，那就是直接使用一个HttpClient作为底层实现......

//生成一个设置了连接超时时间、请求超时时间、异常最大重试次数的httpClient
RequestConfigconfig=RequestConfig.custom().setConnectionRequestTimeout(10000).setConnectTimeout(10000).setSocketTimeout(30000).build();
HttpClientBuilderbuilder=HttpClientBuilder.create().setDefaultRequestConfig(config).setRetryHandler(newDefaultHttpRequestRetryHandler(5,false));
HttpClienthttpClient=builder.build();
//使用httpClient创建一个ClientHttpRequestFactory的实现
ClientHttpRequestFactoryrequestFactory=newHttpComponentsClientHttpRequestFactory(httpClient);
//ClientHttpRequestFactory作为参数构造一个使用作为底层的RestTemplate
RestTemplaterestTemplate=newRestTemplate(requestFactory);

五.设置拦截器(ClientHttpRequestInterceptor)

有时候我们需要对请求做一些通用的拦截设置，这就可以使用拦截器进行处理。拦截器需要我们实现org.springframework.http.client.ClientHttpRequestInterceptor接口自己写。

举个简单的例子，写一个在header中根据请求内容和地址添加令牌的拦截器。

publicclassTokenInterceptorimplementsClientHttpRequestInterceptor
{
@Override
publicClientHttpResponseintercept(HttpRequestrequest,byte[]body,ClientHttpRequestExecutionexecution)throwsIOException
{
//请求地址
StringcheckTokenUrl=request.getURI().getPath();
//token有效时间
intttTime=(int)(System.currentTimeMillis()/1000+1800);
//请求方法名POST、GET等
StringmethodName=request.getMethod().name();
//请求内容
StringrequestBody=newString(body);
//生成令牌此处调用一个自己写的方法，有兴趣的朋友可以自行google如何使用ak/sk生成token，此方法跟本教程无关，就不贴出来了
Stringtoken=TokenHelper.generateToken(checkTokenUrl,ttTime,methodName,requestBody);
//将令牌放入请求header中
request.getHeaders().add("X-Auth-Token",token);

returnexecution.execute(request,body);
}
}

创建RestTemplate实例的时候可以这样向其中添加拦截器

RestTemplaterestTemplate=newRestTemplate();
//向restTemplate中添加自定义的拦截器
restTemplate.getInterceptors().add(newTokenInterceptor());

六.总结

通过本章的讲解，想必读者初步的了解了如何使用RestTemplate方便快捷的访问restful接口。其实RestTemplate的功能非常强大，作者也仅仅学了点皮毛。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

如何使用Spring RestTemplate访问restful服务

热门推荐

随机推荐