API请求编码问题

客户端请求API网关时,需要对参数值进行utf-8的urlEncode,这样能避免特殊参数或者中文出现乱码。 注意:query、header、body位置编码需要在签名计算后,签名时用原始值。

以下代码可参考:https://github.com/aliyun/api-gateway-demo-sign-java

1、header值进行编码

header的编码和value编码不太一样,header的值需要用ISO-9959-1编码。
HttpPost post = new HttpPost(initUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
	//header的传值,value要编码后传,具体实现请看下面
	post.addHeader(e.getKey(), 	MessageDigestUtil.utf8ToIso88591(e.getValue()));
 }
/**     
* UTF-8编码转换为ISO-9959-1     *     
* @param str     
* @return     
*/    
public static String utf8ToIso88591(String str) {        
if (str == null) { 
           return str; 
}        
try {
            return new String(str.getBytes("UTF-8"), "ISO-8859-1");        } 
catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e.getMessage(), e); 
       } 
}

2、query值进行编码

如果query参数值含中文,需要对query的值进行utf-8编码。可参考下面url的构建方式。

private static String initUrl(String host, String path, Map<String, String> querys) throws UnsupportedEncodingException {
    	StringBuilder sbUrl = new StringBuilder();
    	sbUrl.append(host);
    	if (!StringUtils.isBlank(path)) {
    		sbUrl.append(path);
        }
    	if (null != querys) {
    		StringBuilder sbQuery = new StringBuilder();
        	for (Map.Entry<String, String> query : querys.entrySet()) {
        		if (0 < sbQuery.length()) {
        			sbQuery.append("&");
        		}
        		if (StringUtils.isBlank(query.getKey()) && !StringUtils.isBlank(query.getValue())) {
        			sbQuery.append(query.getValue());
                }
        		if (!StringUtils.isBlank(query.getKey())) {
        			sbQuery.append(query.getKey());
        			if (!StringUtils.isBlank(query.getValue())) {
        				sbQuery.append("=");
        				sbQuery.append(URLEncoder.encode(query.getValue(), "UTF-8"));
        			}        			
                }
        	}
        	if (0 < sbQuery.length()) {
        		sbUrl.append("?").append(sbQuery);
        	}
        }
    	
    	return sbUrl.toString();
}

3、body参数进行编码

1)form形式body的编码:

UrlEncodedFormEntity formEntity = buildFormEntity(bodys);
    if (formEntity != null) {
        post.setEntity(formEntity);
    }
 /**
     * 构建FormEntity
     * 
     * @param formParam
     * @return
     * @throws UnsupportedEncodingException
     */
    private static UrlEncodedFormEntity buildFormEntity(Map<String, String> formParam)
            throws UnsupportedEncodingException {
        if (formParam != null) {
            List<NameValuePair> nameValuePairList = new ArrayList<NameValuePair>();

            for (String key : formParam.keySet()) {
                nameValuePairList.add(new BasicNameValuePair(key, formParam.get(key)));
            }
            UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(nameValuePairList, "UTF-8");
            formEntity.setContentType("application/x-www-form-urlencoded; charset=UTF-8");
            return formEntity;
        }

        return null;
    }

2)非form形式的body

String 形式的body:

if (StringUtils.isNotBlank(body)) {
    post.setEntity(new StringEntity(body, "UTF-8"));
}

byte[]形式的body:

if (bodys != null) {
    post.setEntity(new ByteArrayEntity(bodys));
}

4、path参数编码

当API的path中有参数,而且参数含特殊字符。需要先将参数urlencode后加入path中。不然签名会有问题。此时后端收到的也是urlEncode后的值,如果要获取原值,需要自己在后端进行urlDecode。

	@Test
    public void testPath() throws Exception{
        //请求path
        String host=“你的域名”;
        //请求path,先将参数处理后再放入path中。        
        String type=“中文 123”;
        String pathParam= URLEncoder.encode(type,"UTF-8");
        String path = "/"+pathParam;

        Map<String, String> headers = new HashMap<String, String>();
        //(必填)根据期望的Response内容类型设置
        headers.put(HttpHeader.HTTP_HEADER_ACCEPT, "application/json");

        CUSTOM_HEADERS_TO_SIGN_PREFIX.clear();

        Request request = new Request(Method.GET, host, path, AppKey, AppSecret, Constants.DEFAULT_TIMEOUT);
        request.setHeaders(headers);
        request.setSignHeaderPrefixList(CUSTOM_HEADERS_TO_SIGN_PREFIX);

        //调用服务端
        Response response = Client.execute(request);

        System.out.println(JSON.toJSONString(response));
    }

5、参数中包含emoji表情

当参数中包含emoji表情,需要先对参数值进行urlencode后再签名,不然签名不过,因为API网关的系统可能会识别不了该符号,会导致签名失败,所以需要先进行urlencode处理后再签名。

此时后端收到的为urlencode后的字符串,如果要获取原文,后端需要自己做urldecode。