Restemplate详解

1Restemplate简介:

1.1RestTemplate是Spring提供的用于访问Rest服务的客户端,RestTemplate类的设计原则与许多其他Spring *模板类(例如JdbcTemplate、JmsTemplate)相同,

2RestTemplate包含以下几个部分:

2.1HttpMessageConverter 对象转换器

RestTemplate默认使用HttpMessageConverter实例将HTTP消息转换成POJO或者从POJO转换成HTTP消息。默认情况下会注册主mime类型的转换器,但也可以通过setMessageConverters注册其他的转换器

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

RestTemplate restTemplate = new RestTemplate();

        //获取RestTemplate默认配置好的所有转换器

        List> messageConverters = restTemplate.getMessageConverters();

        //默认的MappingJackson2HttpMessageConverter在第7个 先把它移除掉

        messageConverters.remove(6);

        //添加上GSON的转换器

        messageConverters.add(6, new GsonHttpMessageConverter());

2.2ClientHttpRequestFactory 默认是JDK的HttpURLConnection

RestTemplate默认依赖JDK提供http连接的能力(HttpURLConnection),如果有需要的话也可以通过setRequestFactory方法替换为例如

Apache HttpComponents、Netty或OkHttp等其它HTTP library

设置底层连接方式

例如:使用一个HttpClient作为底层实现

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

//生成一个设置了连接超时时间、请求超时时间、异常最大重试次数的httpClient

      RequestConfig config =

RequestConfig.custom().setConnectionRequestTimeout(10000).setConnectTimeout(10000).setSocketTimeout(30000).build();

      HttpClientBuilder builder =

HttpClientBuilder.create().setDefaultRequestConfig(config).setRetryHandler(new

DefaultHttpRequestRetryHandler(5, false));

        HttpClient httpClient = builder.build();

        //使用httpClient创建一个ClientHttpRequestFactory的实现

        ClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);

         //ClientHttpRequestFactory作为参数构造一个使用作为底层的RestTemplate

        RestTemplate restTemplate = new RestTemplate(requestFactory);

2.3ResponseErrorHandler 异常处理

2.4ClientHttpRequestInterceptor 请求拦截器

设置拦截器(ClientHttpRequestInterceptor)

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

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

public class TokenInterceptor implements ClientHttpRequestInterceptor{

    @Override

  public ClientHttpResponse intercept(HttpRequest request, byte[] body,

ClientHttpRequestExecution execution) throws IOException{

        //请求地址

        String checkTokenUrl = request.getURI().getPath();

        //token有效时间

        int ttTime = (int) (System.currentTimeMillis() / 1000 + 1800);

        //请求方法名 POST、GET等

        String methodName = request.getMethod().name();

        //请求内容

        String requestBody = new String(body);

        //生成令牌 此处调用一个自己写的方法,有兴趣的朋友可以自行google如何使用ak/sk生成token,此方法跟本教程无关,就不贴出来了

        String token = TokenHelper.generateToken(checkTokenUrl, ttTime, methodName, requestBody);

        //将令牌放入请求header中

        request.getHeaders().add("X-Auth-Token",token);

        return execution.execute(request, body);

    }

}

你可能感兴趣的:(Restemplate详解)