项目中使用了RestTemplate来对第三方接口进行请求。

使用get方式请求查询接口时,需要将参数拼接到url中,不支持使用JavaBean传参,编写代码不友好。

一般需要这么写:

如果不使用占位符的写法,服务端将收不到参数。

服务端接口定义如下,请求结果是参数解析失败,返回400错误码

这个时候就想,能不能直接传map,或者一个JavaBean来实现传参数呢?

于是查看源码,发现RestTemplate有扩展点可以进行扩展,下面就开始扩展之路了。

RestTemplate有一个接口,专门处理请求url的,

public interface UriTemplateHandler {  //这个方法就是我们传入的参数map  URI expand(String uriTemplate, Map<String, ?> uriVariables);  URI expand(String uriTemplate, Object... uriVariables);  }

于是自定义一个UriTemplateHandler,来对请求url进行处理。

代码如下:

public class GetUriTemplateHandler implements UriTemplateHandler {  private UriTemplateHandler uriTemplateHandler = new DefaultUriBuilderFactory();  @Override  public URI expand(String uriTemplate, Map<String, ?> uriVariables) {  //利用UriComponentsBuilder将请求参数追加到url,GetParamMultiValueMap是自定义的一个map  uriTemplate = UriComponentsBuilder  .fromHttpUrl(uriTemplate)  .queryParams(new GetParamMultiValueMap(uriVariables)).toUriString();  log.info("处理之后的url ==> {}", uriTemplate);  return uriTemplateHandler.expand(uriTemplate, uriVariables);  }  @Override  public URI expand(String uriTemplate, Object... uriVariables) {  return uriTemplateHandler.expand(uriTemplate, uriVariables);  }  }

GetParamMultiValueMap实现如下:

public class GetParamMultiValueMap<K,V> implements MultiValueMap<K, V> {  private final Map<K, List<V>> map;  public GetParamMultiValueMap(Map<K, V> paramMap) {  Assert.notNull(paramMap, "'map' must not be null");  //将请求参数转换成MultiValueMap  this.map = new HashMap<>();  paramMap.forEach((k, v) -> {  if (v instanceof List) {  map.put(k, (List<V>) v);  } else {  map.put(k, Lists.newArrayList(v));  }  });  }  }

GetUriTemplateHandler实现好之后,只需要在RestTemplate实例化之后将默认的UriTemplateHandler替换就可以使用自己实现的功能了

@Configuration  public class RestTemplateConfig {  @ConditionalOnClass(value = RestTemplate.class)  @Bean  public RestTemplate restTemplate() {  RestTemplate restTemplate = new RestTemplate();  //默认使用的jdk的http请求组件 替换成okhttp3  restTemplate.setRequestFactory(new OkHttp3ClientHttpRequestFactory());  //使用自定义的uri处理器,实现参数追加到url的功能  restTemplate.setUriTemplateHandler(new GetUriTemplateHandler());  return restTemplate;  }  }

下面再看测试结果:

收到了服务端的正确返回。

现在还是传递的map,能不能直接传一个JavaBean呢?

答案是可以的,通过对RestTemplate进行包装,

借助apache-commont包将JavaBean转换成map

注入到Spring容器

@Bean  public RestTemplateWrapper restTemplateWrapper(RestTemplate restTemplate) {  return new RestTemplateWrapper(restTemplate);  }

测试使用bean可以使用可以成功传递参数。

成功接收服务的响应

ok receive message ===> test

上面内容就是基于RestTemplate对Get请求参数扩展的处理了,如果有更多的实践方案欢迎一起探讨。