源码中的方法

  1. 源码中的方法
  2. ### getForObject()方法只返回结果
  3.     getForEntity方法返回ResponseEntity封装后的结果，可以从ResponseEntity中获得status，headers，body
  4. ================================================================================================================================================================
  5. <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException
  6. <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException
  7. <T> T getForObject(URI url, Class<T> responseType) throws RestClientException
  9. <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException
  10. <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException
  11. <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException
  12. ===============================================================================================================================================================
  14. 发送HTTP HEAD请求，返回包含特定资源URL的HTTP头 ，类似于GET, 但是不返回body信息，用于检查对象是否存在，以及得到对象的元数据
  15. ===============================================================================================================================================================
  16. HttpHeaders headForHeaders(String url, Object... uriVariables) throws RestClientException
  17. HttpHeaders headForHeaders(String url, Map<String, ?> uriVariables) throws RestClientException
  18. HttpHeaders headForHeaders(URI url) throws RestClientException 
  19. ===============================================================================================================================================================
  21. POST 数据到一个URL，返回新创建资源的URL
  22. ===============================================================================================================================================================
  24. URI postForLocation(String url, @Nullable Object request, Object... uriVariables) throws RestClientException
  25. URI postForLocation(String url, @Nullable Object request, Map<String, ?> uriVariables) throws RestClientException
  26. URI postForLocation(URI url, @Nullable Object request) throws RestClientException throws RestClientException
  27. ===============================================================================================================================================================
  30. ===============================================================================================================================================================
  31. <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException
  32. <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException
  33. <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException
  35. <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException
  36. <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException
  37. <T> ResponseEntity<T> postForEntity(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException
  38. ===============================================================================================================================================================
  40. put用于修改某个内容，若不存在则添加
  41. ===============================================================================================================================================================
  42. void put(String url, @Nullable Object request, Object... uriVariables) throws RestClientException
  43. void put(String url, @Nullable Object request, Map<String, ?> uriVariables) throws RestClientException
  44. void put(URI url, @Nullable Object request) throws RestClientException
  46. 删除某个内容
  47. void delete(String url, Object... uriVariables) throws RestClientException
  48. void delete(String url, Map<String, ?> uriVariables) throws RestClientException
  49. void delete(URI url) throws RestClientException
  50. ===============================================================================================================================================================
  52. ###发送HTTP OPTIONS请求，返回对特定URL的Allow头信息，询问可以执行哪些方法
  53. Set<HttpMethod> optionsForAllow(String url, Object... uriVariables) throws RestClientException
  54. Set<HttpMethod> optionsForAllow(String url, Map<String, ?> uriVariables) throws RestClientException
  55. Set<HttpMethod> optionsForAllow(URI url) throws RestClientException
  56. ===============================================================================================================================================================
  58. ###在URL上执行特定的HTTP方法，返回包含对象的ResponseEntity，这个对象是从响应体中映射得到的
  59.     允许调用者指定HTTP请求的方法，可以在请求中增加body以及头信息，其内容通过参数‘HttpEntity<?>requestEntity'描述
  60. <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) throws RestClientException
  61. 两个重载方法同上
  62. ===============================================================================================================================================================
  64. ###在URL上执行特定的HTTP方法，返回一个从响应体映射得到的对象
  65. public <T> T execute(String url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor, Object... uriVariables) throws RestClientException
  66. 两个重载方法同上，此方法为根方法，上述方法最终执行此方法

SpringBoot注入自定义的RestTemplate

简单配置RestTemplate

  1. private ClientHttpRequestFactory getClientHttpRequestFactory() {
  2.     int timeout = 5000;
  3.     RequestConfig config = RequestConfig.custom()
  4.       .setConnectTimeout(timeout)
  5.       .setConnectionRequestTimeout(timeout)
  6.       .setSocketTimeout(timeout)
  7.       .build();
  8.     CloseableHttpClient client = HttpClientBuilder
  9.       .create()
  10.       .setDefaultRequestConfig(config)
  11.       .build();
  12.     return new HttpComponentsClientHttpRequestFactory(client);
  13. }
  15. @Bean
  16. public RestTemplate restTemplate(){
  17.     RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
  18.     return restTemplate;
  19. }

完整配置

  1. public class HttpClientUtils {
  3.     public static CloseableHttpClient acceptsUntrustedCertsHttpClient() throws KeyStoreException, NoSuchAlgorithmException, KeyManagementException {
  4.         HttpClientBuilder b = HttpClientBuilder.create();
  6.         // 设置允许所有证书的信任策略
  7.         SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() {
  8.             @Override
  9.             public boolean isTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {
  10.                 return true;
  11.             }
  12.         }).build();
  13.         b.setSSLContext(sslContext);
  15.         // 也不要检查主机名，如果不想削弱，请使用SSLConnectionSocketFactory.getDefaultHostnameVerifier（）
  16.         HostnameVerifier hostnameVerifier = NoopHostnameVerifier.INSTANCE;
  18.         //需要创建SSL套接字工厂，以使用我们削弱的“信任策略”；并创建一个注册表来注册它
  19.         SSLConnectionSocketFactory sslSocketFactory = new SSLConnectionSocketFactory(sslContext, hostnameVerifier);
  20.         Registry<ConnectionSocketFactory> socketFactoryRegistry = RegistryBuilder.<ConnectionSocketFactory>create()
  21.                 .register("http", PlainConnectionSocketFactory.getSocketFactory())
  22.                 .register("https", sslSocketFactory)
  23.                 .build();
  25.         // 用注册表创建了链接管理器，允许多线程使用
  26.         PoolingHttpClientConnectionManager connMgr = new PoolingHttpClientConnectionManager( socketFactoryRegistry);
  27.         connMgr.setMaxTotal(200);// 连接池最大连接数
  28.         connMgr.setDefaultMaxPerRoute(100);//每个IP+port，允许的最大连接数
  29.         b.setConnectionManager( connMgr);
  31.         RequestConfig config = RequestConfig.custom()
  32.                                 .setConnectionRequestTimeout(5000)
  33.                                 .setConnectTimeout(5000)
  34.                                 .setSocketTimeout(5000)//读取超时 当返回response太长时，readtimeout
  35.                                 .build();
  37.         b.setDefaultRequestConfig(config);
  38.         b.evictIdleConnections(60,TimeUnit.SECONDS);定期回收空闲链接
  39.         b.evictExpiredConnections();定期回收过期链接
  40.         b.setConnectionReuseStrategy(NoConnectionReuseStrategy.INSTANCE);// 链接重试策略，是否能keepAlive
  41.         b.setRetryHandler(new DefaultHttpRequestRetryHandler(0,false));// 重试策略，默认3此，false为禁用
  43.         CloseableHttpClient client = b.build();
  44.         return client;
  45.     }
  46. }
/**
 * 拦截所有的restTemplate请求：
 */
public class RestClientInterceptor implements ClientHttpRequestInterceptor {
    private static final String HEAD_TOKEN="Token";
    private static final String HEAD_TRACE_ID="trace_id";
    private static final String HEAD_SPAN_ID="span_id";
    private SecurityAuthenticator identityAuthenticator = AuthenticatorFactory.getAuthenticator();
    private static final Logger logger = LoggerFactory.getLogger(RestClientInterceptor.class);
    @Override
    public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        RequestHolder.setRequest(httpRequest);
        HttpHeaders httpHeaders = httpRequest.getHeaders();
        //没有Token，增加Token参数
        if(!httpHeaders.containsKey(HEAD_TOKEN)){
            httpHeaders.add(HEAD_TOKEN, identityAuthenticator.getIdentityToken(null));
        }
        //如果没有设置contentType，则设置默认为application/json，也可添加Accept为application/json
        MediaType contentType  = httpHeaders.getContentType();
        if(contentType == null){
            httpHeaders.setContentType(MediaType.APPLICATION_JSON);
        }

        // 以下为链路追踪设置
        TraceContext tc = TraceLocalUtil.getTraceContext();
        if(tc==null){
            //记录是否为当前调用链的发起方
            RequestHolder.setStartFlag(true);
            TraceRecordGenerator.traceStart();
        }
        URI uri = httpRequest.getURI();
        HttpMethod httpMethod = httpRequest.getMethod();

        TraceRecordGenerator.clientSend("call->" + httpMethod.name() + ":" + uri.toString());
        tc = TraceLocalUtil.getTraceContext();
        if (tc != null) {
            httpHeaders.set(HEAD_TRACE_ID, tc.getTraceId());
            httpHeaders.set(HEAD_SPAN_ID,tc.getSpanId());
        }
        final ClientHttpResponse response;
        try {
            response =  execution.execute(httpRequest, body);
        }catch (Exception e){
            TraceRecordGenerator.clientReceiveFailed(e.getMessage(), ServicePropertyUtil.getErrorcodeProfix()+DefaultErrorCode.ERROR.getCode());
            Boolean startFlag = RequestHolder.getStartFlag();
            if(startFlag != null && startFlag){
                TraceRecordGenerator.traceEnd();
            }
            RequestHolder.clear();
            throw e;
        }
        return response;
    }
}

public class CustomMappingJackson2HttpMessageConverter extends MappingJackson2HttpMessageConverter {

    public CustomMappingJackson2HttpMessageConverter() {
        List<MediaType> mediaTypes = new ArrayList<>();
        mediaTypes.add(MediaType.ALL);
        setSupportedMediaTypes(mediaTypes);
    }
}

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate httpsRestTemplate(ClientHttpRequestFactory httpsFactory) {
        RestTemplate restTemplate = new RestTemplate(httpsFactory);
        // 添加自定义的转换器,也可重新设置StringHttpMessageConverter字符集为UTF-8，解决中文乱码问题（默认使用的字符集是ISO-8859-1，先移除再添加）
        restTemplate.getMessageConverters().add(new CustomMappingJackson2HttpMessageConverter());
        restTemplate.setErrorHandler(new ErrorResponseHandler());//自定义的错误处理，继承DefaultResponseErrorHandler
        List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
        interceptors.add(new RestClientInterceptor());//自定义拦截器，继承于ClientHttpRequestInterceptor
        restTemplate.setInterceptors(interceptors);
        return restTemplate;
    }
    @Bean(name = "httpsFactory")
    public HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory() throws Exception {
        CloseableHttpClient httpClient = HttpClientUtils.acceptsUntrustedCertsHttpClient();
        HttpComponentsClientHttpRequestFactory httpsFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
        return httpsFactory;
    }
}