RestTemplateUtil

1.添加httpclient依赖作为restTemplate的实现

  1. <dependency>
  2.             <groupId>org.apache.httpcomponents</groupId>
  3.             <artifactId>httpclient</artifactId>
  4.         </dependency>

2.配置

  • 使用clientHttpRequestFactory, 可以设置超时时间, 连接池等等
  • 使用自定义的fastJson转换器
  • 使用自定义拦截器可以在每次发送请求时添加header等信息 ```java package com.bestser.factory.cloud;

import com.alibaba.fastjson.serializer.SerializerFeature; import com.alibaba.fastjson.support.config.FastJsonConfig; import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter; import com.bestser.factory.config.security.oauth2.AuthorizationConstants; import java.nio.charset.StandardCharsets; import java.util.Collections; import java.util.List; import org.apache.commons.lang3.StringUtils; import org.apache.http.client.HttpClient; import org.apache.http.impl.client.HttpClientBuilder; import org.apache.http.impl.conn.PoolingHttpClientConnectionManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.core.StringRedisTemplate; import org.springframework.http.HttpHeaders; import org.springframework.http.MediaType; import org.springframework.http.client.ClientHttpRequestInterceptor; import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.StringHttpMessageConverter; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.web.client.RestTemplate;

/**

  • RestTemplate配置类 *
  • @author gavin
  • @date 2020-07-01
  • 文档: https://docs.spring.io/spring/docs/4.3.9.RELEASE/spring-framework-reference/html/remoting.html#rest-client-access

  • api: https://docs.spring.io/spring-framework/docs/4.3.9.RELEASE/javadoc-api/org/springframework/web/client/RestTemplate.html */ @Configuration public class RestTemplateConfig {

    private static final Logger LOGGER = LoggerFactory.getLogger(RestTemplateConfig.class); private StringRedisTemplate redisTemplate;

    public RestTemplateConfig(StringRedisTemplate redisTemplate) {

    1.  this.redisTemplate = redisTemplate;

    }

    @Bean public RestTemplate restTemplate(ClientHttpRequestInterceptor interceptor) {

    1.  RestTemplate restTemplate = new RestTemplate(clientHttpRequestFactory());
    2.  restTemplate.setInterceptors(Collections.singletonList(interceptor));
    3.  replaceJackson2FastJson(restTemplate);
    4.  return restTemplate;

    }

    @Bean public RestTemplate authorizedRestTemplate(ClientHttpRequestInterceptor interceptor) {

    1.  RestTemplate restTemplate = new RestTemplate(clientHttpRequestFactory());
    2.  restTemplate.setInterceptors(Collections.singletonList(interceptor));
    3.  replaceJackson2FastJson(restTemplate);
    4.  return restTemplate;

    }

    /**

    • 替换默认的jackson转换器为fastJson转换器 */ private void replaceJackson2FastJson(RestTemplate restTemplate) { List> converters = restTemplate.getMessageConverters(); //原有的String是ISO-8859-1编码 替换成 UTF-8编码 converters.removeIf(c -> c instanceof StringHttpMessageConverter); converters.add(new StringHttpMessageConverter(StandardCharsets.UTF_8)); converters.add(0, fastJsonHttpMessageConverter()); }

      /**

    • 配置fastJson转换器 */ @Bean public HttpMessageConverter fastJsonHttpMessageConverter() { FastJsonConfig fastJsonConfig = new FastJsonConfig(); fastJsonConfig.setSerializerFeatures(SerializerFeature.WriteMapNullValue, SerializerFeature.QuoteFieldNames,

      1.      SerializerFeature.WriteNullStringAsEmpty, SerializerFeature.WriteNullListAsEmpty,
      2.      SerializerFeature.DisableCircularReferenceDetect);

      FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter(); fastJsonHttpMessageConverter.setSupportedMediaTypes(Collections.singletonList(MediaType.APPLICATION_JSON_UTF8)); fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig); return fastJsonHttpMessageConverter; }

      /**

    • 配置clientHttpRequestFactory */ @Bean public HttpComponentsClientHttpRequestFactory clientHttpRequestFactory() { try {

      1.  HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
      2.  //设置连接池
      3.  PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
      4.  //最大连接数
      5.  connectionManager.setMaxTotal(20);
      6.  //同路由并发数
      7.  connectionManager.setDefaultMaxPerRoute(10);
      8.  httpClientBuilder.setConnectionManager(connectionManager);
      10.  HttpClient httpClient = httpClientBuilder.build();
      11.  // httpClient连接配置
      12.  HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(
      13.          httpClient);
      14.  //连接超时
      15.  requestFactory.setConnectTimeout(60 * 1000);
      16.  //数据读取超时时间
      17.  requestFactory.setReadTimeout(60 * 1000);
      18.  //连接不够用的等待时间
      19.  requestFactory.setConnectionRequestTimeout(60 * 1000);
      20.  return requestFactory;

      } catch (Exception e) {

      1.  LOGGER.error(String.format("初始化clientHttpRequestFactory失败, 错误信息: %s", e));

      } return null; }

      /**

    • 自定义拦截器携带token和authorization */ @Bean public ClientHttpRequestInterceptor authorizedRequestInterceptor() { return (httpRequest, bytes, clientHttpRequestExecution) -> {
      1.  HttpHeaders headers = httpRequest.getHeaders();
      2.  String token = (String) SecurityContextHolder.getContext().getAuthentication().getCredentials();
      3.  if (!StringUtils.isBlank(token)) {
      4.      headers.add(AuthorizationConstants.TOKEN, token);
      5.  }
      6.  String authorization = redisTemplate.opsForValue()
      7.          .get(AuthorizationConstants.OAUTH2_TOKEN_KEY_PREFIX + token);
      8.  if (!StringUtils.isBlank(authorization)) {
      9.      headers.add(AuthorizationConstants.AUTHORIZATION, authorization);
      10.  }
      11.  return clientHttpRequestExecution.execute(httpRequest, bytes);
      }; } }
  1. 3.工具类, http请求的封装
  2. ```java
  3. package com.bestser.factory.cloud;
  5. import com.alibaba.fastjson.JSONObject;
  6. import org.apache.commons.logging.Log;
  7. import org.apache.commons.logging.LogFactory;
  8. import org.springframework.http.HttpMethod;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.web.client.RestTemplate;
  12. /**
  13.  * 发送http请求工具类
  14.  *
  15.  * @author gavin
  16.  * @date 2020-07-04
  17.  */
  19. @Component
  20. public class RestTemplateUtil {
  22.     private final static Log LOGGER = LogFactory.getLog(RestTemplateUtil.class);
  23.     private final static int SUCCESS_CODE = 200;
  24.     private final static Object EMPTY_REQUEST_BODY = new Object();
  25.     private static RestTemplate rest;
  27.     public RestTemplateUtil(RestTemplate restTemplate) {
  28.         rest = restTemplate;
  29.     }
  31.     @SuppressWarnings("unchecked")
  32.     private static <T> CloudResponse<T> doCall(HttpMethod method, String url, Object requestBody) {
  33.         CloudResponse<T> response = new CloudResponse<>();
  34.         switch (method) {
  35.             case GET:
  36.                 response = rest.getForObject(url, CloudResponse.class);
  37.                 break;
  38.             case POST:
  39.                 response = rest.postForObject(url, requestBody, CloudResponse.class);
  40.                 break;
  41.             case PUT:
  42.                 rest.put(url, requestBody);
  43.                 response.setState(SUCCESS_CODE);
  44.                 break;
  45.             case DELETE:
  46.                 rest.delete(url);
  47.                 response.setState(SUCCESS_CODE);
  48.                 break;
  49.             default:
  50.                 throw new RuntimeException(String.format("未知请求类型: %s", method));
  51.         }
  52.         return response;
  53.     }
  55.     /**
  56.      * 发送http请求
  57.      *
  58.      * @param method 请求方法
  59.      * @param url 请求url
  60.      * @param requestBody 请求体
  61.      * @param <T> 返回值的泛型
  62.      * @return T
  63.      */
  64.     private static <T> T call(HttpMethod method, String url, Object requestBody) {
  65.         CloudResponse<T> response;
  66.         try {
  67.             response = doCall(method, url, requestBody);
  68.             LOGGER.info(String.format("url: %s, requestBody: %s, response: %s", url, JSONObject.toJSON(requestBody),
  69.                     JSONObject.toJSON(response)));
  70.         } catch (Exception e) {
  71.             LOGGER.error(
  72.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  73.                             e.getMessage()));
  74.             throw e;
  75.         }
  77.         if (response.getState() != SUCCESS_CODE) {
  78.             LOGGER.error(
  79.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  80.                             response.getMessage()));
  81.             throw new RuntimeException(
  82.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  83.                             response.getMessage()));
  84.         }
  85.         return response.getData();
  86.     }
  88.     public static <T> T get(String url) {
  89.         return call(HttpMethod.GET, url, EMPTY_REQUEST_BODY);
  90.     }
  92.     public static <T> T post(String url) {
  93.         return call(HttpMethod.POST, url, EMPTY_REQUEST_BODY);
  94.     }
  96.     public static <T> T post(String url, Object requestBody) {
  97.         return call(HttpMethod.POST, url, requestBody);
  98.     }
  100.     public static void put(String url) {
  101.         call(HttpMethod.PUT, url, EMPTY_REQUEST_BODY);
  102.     }
  104.     public static void put(String url, Object requestBody) {
  105.         call(HttpMethod.PUT, url, requestBody);
  106.     }
  108.     public static void delete(String url) {
  109.         call(HttpMethod.DELETE, url, EMPTY_REQUEST_BODY);
  110.     }
  112.     public static void delete(String url, Object requestBody) {
  113.         call(HttpMethod.DELETE, url, requestBody);
  114.     }
  115. }

优化版本(添加自定义请求头参数):

  1. package com.bestser.factory.cloud;
  3. import com.alibaba.fastjson.JSONObject;
  4. import org.apache.commons.logging.Log;
  5. import org.apache.commons.logging.LogFactory;
  6. import org.springframework.http.HttpEntity;
  7. import org.springframework.http.HttpHeaders;
  8. import org.springframework.http.HttpMethod;
  9. import org.springframework.http.MediaType;
  10. import org.springframework.stereotype.Component;
  11. import org.springframework.web.client.RestTemplate;
  13. /**
  14.  * 发送http请求工具类
  15.  *
  16.  * @author gavin
  17.  * @date 2020-07-04
  18.  */
  20. @Component
  21. public class RestTemplateUtil {
  23.     private final static Log LOGGER = LogFactory.getLog(RestTemplateUtil.class);
  24.     private final static int SUCCESS_CODE = 200;
  25.     private final static Object EMPTY_REQUEST_BODY = new Object();
  26.     private final static HttpHeaders EMPTY_REQUEST_HEADER = new HttpHeaders();
  27.     private static RestTemplate rest;
  29.     public RestTemplateUtil(RestTemplate restTemplate) {
  30.         rest = restTemplate;
  31.     }
  33.     /**
  34.      * 发送http请求
  35.      *
  36.      * @param method 请求方法
  37.      * @param url 请求url
  38.      * @param requestBody 请求体
  39.      * @param <T> 返回值的泛型
  40.      * @return T
  41.      */
  42.     @SuppressWarnings("unchecked")
  43.     private static <T> T call(String url, HttpMethod method, HttpHeaders requestHeaders, Object requestBody) {
  44.         CloudResponse<T> response;
  45.         requestHeaders.setContentType(MediaType.APPLICATION_JSON);
  46.         HttpEntity<Object> requestEntity = new HttpEntity<>(requestBody, requestHeaders);
  47.         try {
  48.             response = rest.exchange(url, method, requestEntity, CloudResponse.class).getBody();
  49.             LOGGER.info(String.format("url: %s, requestBody: %s, response: %s", url, JSONObject.toJSON(requestBody),
  50.                     JSONObject.toJSON(response)));
  51.         } catch (Exception e) {
  52.             LOGGER.error(
  53.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  54.                             e.getMessage()));
  55.             throw e;
  56.         }
  58.         if (response == null || response.getState() != SUCCESS_CODE) {
  59.             LOGGER.error(
  60.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  61.                             response == null ? "null" : response.getMessage()));
  62.             throw new RuntimeException(
  63.                     String.format("url: %s, requestBody: %s, errorMessage: %s", url, JSONObject.toJSON(requestBody),
  64.                             response == null ? "null" : response.getMessage()));
  65.         }
  66.         return response.getData();
  67.     }
  69.     public static <T> T get(String url) {
  70.         return call(url, HttpMethod.GET, EMPTY_REQUEST_HEADER, EMPTY_REQUEST_BODY);
  71.     }
  73.     public static <T> T get(String url, HttpHeaders httpHeaders) {
  74.         return call(url, HttpMethod.GET, httpHeaders, EMPTY_REQUEST_BODY);
  75.     }
  77.     public static <T> T post(String url) {
  78.         return call(url, HttpMethod.POST, EMPTY_REQUEST_HEADER, EMPTY_REQUEST_BODY);
  79.     }
  81.     public static <T> T post(String url, Object requestBody) {
  82.         return call(url, HttpMethod.POST, EMPTY_REQUEST_HEADER, requestBody);
  83.     }
  85.     public static void put(String url) {
  86.         call(url, HttpMethod.PUT, EMPTY_REQUEST_HEADER, EMPTY_REQUEST_BODY);
  87.     }
  89.     public static void put(String url, Object requestBody) {
  90.         call(url, HttpMethod.PUT, EMPTY_REQUEST_HEADER, requestBody);
  91.     }
  93.     public static void delete(String url) {
  94.         call(url, HttpMethod.DELETE, EMPTY_REQUEST_HEADER, EMPTY_REQUEST_BODY);
  95.     }
  96. }

4.标准返回类

  1. package com.bestser.factory.cloud;
  3. import lombok.Data;
  5. /**
  6.  * @author gavin
  7.  * @date 2020-07-04
  8.  */
  9. @Data
  10. public class CloudResponse<T> {
  12.     private Integer state;
  13.     private String message;
  14.     private T data;
  15. }

CloudUrlBuilder

1.url构建工具类

  1. package com.bestser.factory.cloud;
  3. import java.util.Collections;
  4. import java.util.Map;
  5. import org.springframework.stereotype.Component;
  6. import org.springframework.util.CollectionUtils;
  7. import org.springframework.web.util.UriComponents;
  8. import org.springframework.web.util.UriComponentsBuilder;
  10. /**
  11.  * cloud端url构建器
  12.  *
  13.  * @author gavin
  14.  * @date 2020-07-03
  15.  */
  16. @Component
  17. public class CloudUrlBuilder {
  19.     private static final String HTTP = "http";
  20.     private static final String AUTH_HOST = "localhost:8612";
  21.     private static final String INVENTORY_HOST = "localhost:8610";
  23.     /**
  24.      * 构建url
  25.      *
  26.      * @param host 主机ip:端口
  27.      * @param path 路径
  28.      * @param params 请求参数
  29.      * @param args 路径参数
  30.      * @return url
  31.      */
  32.     private static String buildUrl(String host, CloudResource path, Map<String, Object> params, String... args) {
  33.         UriComponentsBuilder builder = UriComponentsBuilder.newInstance().scheme(HTTP).host(host)
  34.                 .path(path.getPath());
  35.         if (!CollectionUtils.isEmpty(params)) {
  36.             params.forEach(builder::queryParam);
  37.         }
  38.         UriComponents build = builder.build();
  39.         if (args != null && args.length > 0) {
  40.             return build.expand(args).toUriString();
  41.         }
  42.         return build.toUriString();
  43.     }
  45.     public static String buildAuthUrl(CloudResource path, String... args) {
  46.         return buildAuthUrl(path, Collections.emptyMap(), args);
  47.     }
  49.     public static String buildAuthUrl(CloudResource path, Map<String, Object> params) {
  50.         return buildAuthUrl(path, params, null);
  51.     }
  53.     public static String buildAuthUrl(CloudResource path, Map<String, Object> params, String... args) {
  54.         return buildUrl(AUTH_HOST, path, params, args);
  55.     }
  57.     public static String buildInventoryUrl(CloudResource path, String... args) {
  58.         return buildInventoryUrl(path, Collections.emptyMap(), args);
  59.     }
  61.     public static String buildInventoryUrl(CloudResource path, Map<String, Object> params) {
  62.         return buildInventoryUrl(path, params, null);
  63.     }
  65.     public static String buildInventoryUrl(CloudResource path, Map<String, Object> params, String... args) {
  66.         return buildUrl(INVENTORY_HOST, path, params, args);
  67.     }
  68. }

2.url资源路径的定义

  1. package com.bestser.factory.cloud;
  3. /**
  4.  * cloud端资源路径
  5.  *
  6.  * @author gavin
  7.  * @date 2020-07-01
  8.  */
  9. public enum CloudResource {
  11.     /**
  12.      * oauth2令牌
  13.      */
  14.     OAUTH2_TOKEN("oauth2令牌", "/oauth/token"),
  16.     /**
  17.      * 客户端权限
  18.      */
  19.     CLIENT_PRIVILEGE("客户端权限", "/auth/{serviceNames}"),
  21.     /**
  22.      * 配件
  23.      */
  24.     PART("配件", "/product/part"),
  25.     PART_VALUE("配件值", "/product/part/{propertyValueId}"),
  26.     PART_LIST("配件列表", "/product/part/list");
  29.     private final String caption;
  30.     private final String path;
  32.     CloudResource(String caption, String path) {
  33.         this.caption = caption;
  34.         this.path = path;
  35.     }
  37.     public String caption() {
  38.         return this.caption;
  39.     }
  41.     public String getPath() {
  42.         return path;
  43.     }
  44. }

使用示例

调用方

  1. @RestController
  2. @ResponseResult
  3. @RequestMapping("/api/setting/part")
  4. public class PartSettingController {
  6.     @Autowired
  7.     private DesignPartService designPartService;
  9.     @GetMapping("/list")
  10.     public List<ProductPropertyVO> listParts() {
  11.         return RestTemplateUtil.get(CloudUrlBuilder.buildInventoryUrl(CloudResource.PART_LIST));
  12.     }
  14.     @PostMapping
  15.     public void createParts(@RequestBody ProductPropertyVO vo) {
  16.         if (StringUtils.isBlank(vo.getPropertyValue())) {
  17.             throw new RestMessageException(ResponseStateEnum.PARAM_ERROR, "配件名称不能为空");
  18.         }
  19.         RestTemplateUtil.post(CloudUrlBuilder.buildInventoryUrl(CloudResource.PART), vo);
  20.     }
  22.     @PutMapping
  23.     @Transactional(rollbackFor = Exception.class)
  24.     public void updatePart(@RequestBody ProductPropertyVO vo) {
  25.         if (StringUtils.isBlank(vo.getPropertyValue()) || StringUtils.isBlank(vo.getNewPropertyValue())) {
  26.             throw new RestMessageException(ResponseStateEnum.PARAM_ERROR, "配件名称不能为空");
  27.         }
  28.         // 修改 design_part 表的配件名称
  29.         designPartService.updatePartName(vo.getPropertyValue(), vo.getNewPropertyValue());
  30.         RestTemplateUtil.put(CloudUrlBuilder.buildInventoryUrl(CloudResource.PART), vo);
  31.     }
  33.     @DeleteMapping
  34.     @Transactional(rollbackFor = Exception.class)
  35.     public void deletePart(@RequestBody ProductPropertyVO vo) {
  36.         if (designPartService.isPartUsed(vo.getPropertyValue())) {
  37.             throw new RestMessageException(ResponseStateEnum.PARAM_ERROR, "配件已被使用, 不能删除");
  38.         }
  39.         RestTemplateUtil.delete(CloudUrlBuilder
  40.                 .buildInventoryUrl(CloudResource.PART_VALUE, String.valueOf(vo.getPropertyValueId())));
  41.         RestTemplateUtil.delete(CloudUrlBuilder
  42.                 .buildInventoryUrl(CloudResource.PART_VALUE, String.valueOf(vo.getPropertyValueId())));
  43.     }
  44. }

被调用方

  1.  @ApiOperation("获取配件列表")
  2.     @GetMapping("/part/list")
  3.     public List<PropertyValueVO> listParts() {
  4.         return productService.listPropertiesByName("配件名称");
  5.     }
  7.     @ApiOperation("新增配件, 参数中propertyValue必填")
  8.     @PostMapping("/part")
  9.     public void createParts(@RequestBody ProductPropertyParam param) {
  10.         if (StringUtils.isBlank(param.getPropertyValue())) {
  11.             throw new ServiceException("配件名称不能为空");
  12.         }
  13.         productService.createPart(param.getPropertyValue());
  14.     }
  16.     @ApiOperation("修改配件名称, 参数中propertyValueId和propertyValue必填")
  17.     @PutMapping("/part")
  18.     public void updatePart(@RequestBody ProductPropertyParam param) {
  19.         if (StringUtils.isBlank(param.getPropertyValue())) {
  20.             throw new ServiceException("配件名称不能为空");
  21.         }
  22.         productService.updateProductPropertyValue(param.getPropertyValueId(), param.getNewPropertyValue());
  23.     }
  25.     @ApiOperation("删除配件, 参数中propertyValueId必填")
  26.     @DeleteMapping("/part/{propertyValueId}")
  27.     public void deletePart(@PathVariable("propertyValueId") Integer propertyValueId) {
  28.         productService.deleteProductPropertyValue(propertyValueId);
  29.     }