记一次RestTemplate使用异常问题

最新推荐文章于 2023-09-13 17:23:52 发布

原创最新推荐文章于 2023-09-13 17:23:52 发布 · 2.1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java 专栏收录该内容

8 篇文章

订阅专栏

本文记录了一次使用Java的RestTemplate进行HTTP GET请求时遇到的问题，当调用第三方接口并尝试获取JSON响应时，出现异常。问题出在`encodeQueryParams`方法将参数编码导致错误。解决方案是避免传递String类型URL，而是使用URI对象，以防止不必要的编码问题。

场景描述

系统需要调用第三方的http接口，并获取到返回的json格式结果。

问题

用RestTemplate进行GET形式调用时发现和浏览器直接访问效果不同，可能无法访问接口，或者参数存在问题导致请求返回异常结果。

调用格式如下：

String result = restTemplate.getForObject("http://127.0.0.1:8080/acm?k=%3", String.class);

解决

接口调用出现异常，马上就想到了请求格式发生了变化，通过调试模式下跟踪getForObject方法的执行方式，观察请求url的变化。

调试后，在如下方法中，发现「encodeQueryParams」方法将请求参数k的值变成了「%253」。

	@Override
	public HierarchicalUriComponents encode(String encoding) throws UnsupportedEncodingException {
		if (this.encoded) {
			return this;
		}
		Assert.hasLength(encoding, "Encoding must not be empty");
		String schemeTo = encodeUriComponent(getScheme(), encoding, Type.SCHEME);
		String userInfoTo = encodeUriComponent(this.userInfo, encoding, Type.USER_INFO);
		String hostTo = encodeUriComponent(this.host, encoding, getHostType());
		PathComponent pathTo = this.path.encode(encoding);
        // 这里会将请求参数进行特定编码，然后以这个编码后的url继续请求
		MultiValueMap<String, String> paramsTo = encodeQueryParams(encoding);
		String fragmentTo = encodeUriComponent(getFragment(), encoding, Type.FRAGMENT);
		return new HierarchicalUriComponents(schemeTo, userInfoTo, hostTo, this.port,
				pathTo, paramsTo, fragmentTo, true, false);
	}

RestTemplate中传入的如果是String格式的URL就会调用
URI expanded = getUriTemplateHandler().expand(url, uriVariables);
来对url进行格式化，比如将% => %25。

解决方法

解决也比较简单，不要传入String类型参数，传递URI对象即可，这样就不会有编码问题了。

String result = restTemplate.getForObject(new URI(url), String.class);