您的位置:

RestTemplate设置Header说明

一、RestTemplate设置编码

在实际开发中,尤其是在处理中文数据时,我们需要在设置Header的同时设置编码格式,以保证请求和响应的数据能够正确传输和解析。可以使用RestTemplate的构造函数提供的方法设置编码格式。

RestTemplate restTemplate = new RestTemplate(new StringHttpMessageConverter(Charset.forName("UTF-8")));

这样设置后,不管是请求还是响应的数据,都将使用UTF-8编码进行转换处理。如果需要其他编码格式,只需要替换“UTF-8”即可。

二、RestTemplate设置代理

在部分应用场景下,我们需要使用代理进行请求和响应的转发,可以通过调用RestTemplate的setRequestFactory方法,来设置使用代理。

SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
Proxy proxy = new Proxy(Type.HTTP, new InetSocketAddress("代理地址", 端口号));
requestFactory.setProxy(proxy);
RestTemplate restTemplate = new RestTemplate(requestFactory);

以上代码中,“代理地址”和“端口号”需要替换为实际使用的值。这样设置后,RestTemplate会使用指定的代理进行请求和响应的转发。

三、RestTemplate设置Content-Type

在实际开发中,我们需要在请求中设置Content-Type来指定请求体的类型,以便于服务器进行解析和处理。可以通过在HttpHeaders中添加Content-Type来设置。

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity requestEntity = new HttpEntity
   (requestJson, headers);
ResponseEntity
     responseEntity = restTemplate.exchange(url, HttpMethod.POST, requestEntity, String.class);

    
   
  

以上代码通过设置HttpHeaders的Content-Type为APPLICATION_JSON,来指定请求体的类型为JSON格式。

四、RestTemplate官网

RestTemplate是Spring框架提供的一个HTTP客户端工具,具有简单方便、易于使用的优点。在RestTemplate的官网上,提供了详细的API文档和代码示例,方便开发者学习和使用。

RestTemplate官网链接:https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/client/RestTemplate.html

五、RestTemplate怎么读

RestTemplate中的“Template”代表模板,RestTemplate可以说是SpringMVC中的Rest部分的"模板",提供了更方便、更高效的HTTP调用接口。

六、RestTemplate详解

RestTemplate提供了诸如postForObject、getForEntity等方法,以便于我们能够像调用本地方法一样,使用RestTemplate来实现HTTP请求。例如:

//使用Map封装参数
Map queryParams = new HashMap<>();
queryParams.put("id", 1);
//调用RestTemplate的getForObject方法,实现GET请求
response = restTemplate.getForObject(url, String.class, queryParams);

  

RestTemplate还支持反序列化,将HTTP响应的JSON/XML数据,转化成Java对象。可以使用Jackson、Gson等第三方库进行数据反序列化,也可以使用RestTemplate自带的反序列化器,可以注解方式进行配置。

七、RestTemplate高并发

在高并发场景中,如果使用RestTemplate来请求远程接口,可能会导致请求响应时间过长的问题。可以通过以下几种方法解决:

1、在RestTemplate中使用连接池,提升连接复用的性能和效率。

PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
connectionManager.setMaxTotal(200);
connectionManager.setDefaultMaxPerRoute(20);
RestTemplate restTemplate = new RestTemplate(new HttpComponentsClientHttpRequestFactory(HttpClients.custom().setConnectionManager(connectionManager).build()));

2、使用缓存机制,需先根据业务自行选择。

//HttpClient对象,维护连接池
CloseableHttpClient httpClient = HttpClientBuilder.create().setMaxConnTotal(200).setMaxConnPerRoute(20).build();
HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
requestFactory.setConnectTimeout(timeout);
requestFactory.setReadTimeout(timeout);
RestTemplate restTemplate = new RestTemplate(requestFactory);

//缓存管理对象
HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();
requestFactory.setHttpClient(httpClient);
requestFactory.setConnectTimeout(timeout);
requestFactory.setReadTimeout(timeout);
SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
factory.setBufferRequestBody(false);
factory.setTaskExecutor(new SimpleAsyncTaskExecutor());
BufferingClientHttpRequestFactory bufferingClientHttpRequestFactory = new BufferingClientHttpRequestFactory(factory);
RestTemplate restTemplate = new RestTemplate(bufferingClientHttpRequestFactory);
RestOperations restOperations = restTemplate;
CachingRestOperations cachingRestOperations = new CachingRestTemplate(restOperations);

3、Request和Response数据压缩,可压缩以下编码类型gzip、deflat等,建议结合实际数据进行选择;

/**
 * RestTemplate配置
 */
@Configuration
public class RestTemplateConfig {

    @Autowired
    private RestTemplateBuilder restTemplateBuilder;

    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder.build();
    }

    @Bean
    public ClientHttpRequestFactory clientHttpRequestFactory() {
        //连接池配置
        PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
        connectionManager.setMaxTotal(200);
        connectionManager.setDefaultMaxPerRoute(20);

        //请求配置
        RequestConfig requestConfig = RequestConfig.custom().setConnectionRequestTimeout(5000).setConnectTimeout(5000).setSocketTimeout(5000).build();

        //将连接池和请求配置组合为结果
        CloseableHttpClient httpClient = HttpClients.custom().setConnectionManager(connectionManager).setDefaultRequestConfig(requestConfig).build();

        //设置压缩方式
        httpClient.addInterceptorFirst(new HttpRequestInterceptor() {
            @Override
            public void process(HttpRequest request, HttpContext context) throws HttpException, IOException {
                if (request instanceof HttpEntityEnclosingRequest) {
                    HttpEntity entity = ((HttpEntityEnclosingRequest) request).getEntity();
                    Header ceheader = entity.getContentEncoding();
                    if (ceheader != null) {
                        for (HeaderElement codec : ceheader.getElements()) {
                            if (codec.getName().equalsIgnoreCase("gzip")) {
                                ((HttpEntityEnclosingRequest) request).setEntity(new GzipCompressingEntity(entity));
                                return;
                            }
                            if (codec.getName().equalsIgnoreCase("deflate")) {
                                ((HttpEntityEnclosingRequest) request).setEntity(new DeflateCompressingEntity(entity));
                                return;
                            }
                        }
                    }
                }
            }
        });

        //设置压缩方式
        httpClient.addInterceptorFirst(new HttpResponseInterceptor() {
            @Override
            public void process(HttpResponse response, HttpContext context) throws HttpException, IOException {
                HttpEntity entity = response.getEntity();
                if (entity != null) {
                    Header ceheader = entity.getContentEncoding();
                    if (ceheader != null) {
                        HeaderElement[] codecs = ceheader.getElements();
                        for (int i = 0; i < codecs.length; i++) {
                            if (codecs[i].getName().equalsIgnoreCase("gzip")) {
                                response.setEntity(new GzipDecompressingEntity(entity));
                                return;
                            }
                            if (codecs[i].getName().equalsIgnoreCase("deflate")) {
                                response.setEntity(new DeflateDecompressingEntity(entity));
                                return;
                            }
                        }
                    }
                }
            }
        });
        return new HttpComponentsClientHttpRequestFactory(httpClient);
    }
}

八、RestTemplate远程调用选取

在实际开发中,我们需要根据不同的业务场景,选择不同的远程调用方式,以满足业务需求。常用的远程调用方式有以下几种:

1、同步调用:使用RestTemplate的execute、postForEntity、exchange等同步方法实现,能够较为方便地获取到返回结果和处理异常。

//同步调用
public ResponseEntity invokeSync(String url, HttpMethod method, HttpHeaders headers, Object requestBody) throws Exception {
    HttpEntity
    requestEntity = new HttpEntity<>(requestBody, headers);
    ResponseEntity
     responseEntity = restTemplate.exchange(url, method, requestEntity, String.class);
    if (responseEntity.getStatusCode() != HttpStatus.OK) {
        throw new Exception("");
    }
    return responseEntity;
}



     

2、异步调用:使用RestTemplate配合AsyncRestTemplate实现,能够使用回调方法处理返回结果和异常情况,相对于同步调用,能够提高并发能力。

//异步调用
public ListenableFuture
       > invokeAsync(String url, HttpMethod method, HttpHeaders headers, Object requestBody) {
    HttpEntity
         requestEntity = new HttpEntity<>(requestBody, headers);
    ListenableFuture
         
          > future = asyncRestTemplate.exchange(url, method, requestEntity, String.class);
    future.addCallback(new ListenableFutureCallback
           
            
             >() { @Override public void onSuccess(ResponseEntity
             
              result) { //处理返回结果 } @Override public void onFailure(Throwable ex) { //处理异常情况 } }); return future; } 
              

3、消息转换器:使用RestTemplate的消息转换器实现,能够将HTTP请求/响应数据转换成对象,方便业务处理。

//消息转换器
public Person invokeWithConverter(String url, HttpMethod method, HttpHeaders headers, Person person) {
    HttpEntity requestEntity = new HttpEntity
                (person, headers);
    ResponseEntity
                  responseEntity = restTemplate.exchange(url, method, requestEntity, Person.class);
    if (responseEntity.getStatusCode() != HttpStatus.OK) {
        return null;
    }
    return responseEntity.getBody();
}

                 
                
               

以上代码示例,展示了RestTemplate设置Header的相关知识点。在实际开发中,我们需要根据具体需要,结合官方文档和API文档,选择合适的方法和调用方式,以提高开发效率和应用性能。

文章目录
顶部