ParamUtil (feilong-core 2.0.3 API create by feilong)

java.lang.Object
- com.feilong.core.net.ParamUtil

```
public final class ParamUtil
extends Object
```
处理参数相关.

Since:

1.0.0

Author:

feilong

See Also:
"org.springframework.web.util.UriComponentsBuilder", "org.apache.http.client.utils.URIBuilder"

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`addParameter(String uriString, String paramName, String paramValue, String charsetType)` 给指定的`uriString`添加指定的参数 `paramName` 和值 `paramValue`.
`static String`	`addParameterArrayValueMap(String uriString, Map<String,String[]> arrayValueMap, String charsetType)` 给指定的 `uriString`添加参数 `arrayValueMap`,如果uri包含指定的参数名字,那么会被新的值替换.
`static String`	`addParameterSingleValueMap(String uriString, Map<String,String> singleValueMap, String charsetType)` 给指定的`uriString`添加指定的参数 `singleValueMap`.
`static <K> String`	`joinValuesOrderByIncludeKeys(Map<K,String> singleValueMap, K... includeKeys)` 在`singleValueMap`中取到指定`includeKeys` key的value,连接起来(不使用任何连接符).
`static String`	`toNaturalOrderingJoinValue(Map<String,String> singleValueMap)` 将 `singleValueMap` 转成`自然排序`, 然后仅将value直接拼接成字符串(不使用 `=` 和`&` 分隔).
`static String`	`toNaturalOrderingKeyJoinValue(Map<String,String> singleValueMap)` 将 `singleValueMap` 转成`自然排序`, 然后将key和value直接拼接成字符串(不使用 `=` 和`&` 分隔).
`static String`	`toNaturalOrderingQueryString(Map<String,String> singleValueMap)` 将 `singleValueMap` 转成`自然排序`的 `queryString` 字符串.
`static String`	`toQueryStringUseArrayValueMap(Map<String,String[]> arrayValueMap)` 只是简单的将map的key value 连接起来,最终格式类似于 url 的queryString.
`static String`	`toQueryStringUseSingleValueMap(Map<String,String> singleValueMap)` 将`singleValueMap`转成 queryString.
`static Map<String,String>`	`toSingleValueMap(String queryString, String charsetType)` 将`a=1&b=2`这样格式的 `queryString`数据转换成map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addParameter
```
public static String addParameter(String uriString,
                  String paramName,
                  String paramValue,
                  String charsetType)
```
    给指定的uriString添加指定的参数 paramName 和值 paramValue.
    说明:
    如果原来的uriString没有指定的参数paramName,那么追加新的参数paramName和值paramValue.
    
    如果原来的uriString有指定的参数paramName,那么会被新的值替换paramValue.
    
    如果原来的uriString有指定的参数paramName,并且是多值类型(参数数组),那么多值参数中第一个会被新的值替换paramValue,其他的被丢弃.
    
    如果原来的uriString有参数,不管是拼接还是替换都会保持参数的原始顺序.
    
    如果uriString带有? 和参数,会先被截取,最后再拼接.
    
    如果uriString不带?,则自动增加?
    示例:
    String uri = "http://www.feilong.com:8888/esprit-frontend/search.htm?keyword=%E6%81%A4&page="; String pageParamName = "label"; String prePageNo = "2-5-8-12"; LOGGER.info(ParamUtil.addParameter(uri, pageParamName, prePageNo, UTF8));
    返回:
    http://www.feilong.com:8888/esprit-frontend/search.htm?keyword=%E6%81%A4&page=&label=2-5-8-12
    Parameters:
    uriString - 如果带有? 和参数,会先被截取,最后再拼接,
    如果不带?,则自动增加?
    paramName - 添加的参数名称
    paramValue - 添加的参数值
    charsetType - 字符编码,建议使用 CharsetType 定义好的常量
    如果是null或者 empty,那么参数部分原样返回,自行处理兼容性问题
    否则会先解码,再加码,因为ie浏览器和chrome浏览器 url中访问路径 ,带有中文情况下不一致
    
    Returns:
    如果 uriString 是null或者empty,返回 StringUtils.EMPTY
    如果 paramName 是null,以 StringUtils.EMPTY替代
    如果 paramValue 是null,以 StringUtils.EMPTY替代
    Since:
    
    1.9.0 change paramValue type from Object to String
    
    See Also:
    addParameterSingleValueMap(String, Map, String)
  - addParameterSingleValueMap
```
public static String addParameterSingleValueMap(String uriString,
                                Map<String,String> singleValueMap,
                                String charsetType)
```
    给指定的uriString添加指定的参数 singleValueMap.
    说明:
    如果原来的uriString没有指定的参数paramName,那么循环arrayValueMap,追加新的参数paramName和值 paramValue.
    
    如果原来的uriString有指定的参数paramName,那么会被新的值替换paramValue.
    
    如果原来的uriString有指定的参数paramName,并且是多值类型(参数数组),那么多值参数中第一个会被新的值替换paramValue,其他的被丢弃.
    
    如果原来的uriString有参数,不管是拼接还是替换都会保持参数的原始顺序.
    
    如果uriString带有? 和参数,会先被截取,最后再拼接.
    
    如果uriString不带?,则自动增加?
    示例1:
    String beforeUrl = "www.baidu.com"; Map<String, String> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("province", "江苏省"); keyAndArrayMap.put("city", "南通市"); LOGGER.info(ParamUtil.addParameterSingleValueMap(beforeUrl, keyAndArrayMap, UTF8));
    返回:
    www.baidu.com?province=%E6%B1%9F%E8%8B%8F%E7%9C%81&city=%E5%8D%97%E9%80%9A%E5%B8%82
    示例2:
    String beforeUrl = "www.baidu.com?a=b"; Map<String, String> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("province", "江苏省"); keyAndArrayMap.put("city", "南通市"); LOGGER.info(ParamUtil.addParameterSingleValueMap(beforeUrl, keyAndArrayMap, UTF8));
    返回:
    www.baidu.com?a=b&province=%E6%B1%9F%E8%8B%8F%E7%9C%81&city=%E5%8D%97%E9%80%9A%E5%B8%82
    Parameters:
    uriString - 如果带有? 和参数,会先被截取,最后再拼接,
    如果不带?,则自动增加?
    singleValueMap - singleValueMap param name 和value 的键值对
    charsetType - 字符编码,建议使用 CharsetType 定义好的常量
    如果是null或者 empty,那么参数部分原样返回,自行处理兼容性问题
    否则会先解码,再加码,因为ie浏览器和chrome浏览器 url中访问路径 ,带有中文情况下不一致
    
    Returns:
    如果 uriString 是null或者empty,返回 StringUtils.EMPTY
    如果 singleValueMap 是null,当作empty map处理
    See Also:
    addParameterArrayValueMap(String, Map, String)
  - addParameterArrayValueMap
```
public static String addParameterArrayValueMap(String uriString,
                               Map<String,String[]> arrayValueMap,
                               String charsetType)
```
    给指定的 uriString添加参数 arrayValueMap,如果uri包含指定的参数名字,那么会被新的值替换.
    说明:
    如果原来的uriString没有指定的参数paramName,那么循环arrayValueMap,追加新的参数paramName和值 paramValue.
    
    如果原来的uriString有指定的参数paramName,那么会被新的值替换paramValue.
    
    如果原来的uriString有指定的参数paramName,并且是多值类型(参数数组),那么多值参数中第一个会被新的值替换paramValue,其他的被丢弃.
    
    如果原来的uriString有参数,不管是拼接还是替换都会保持参数的原始顺序.
    
    如果uriString带有? 和参数,会先被截取,最后再拼接.
    
    如果uriString不带?,则自动增加?
    示例1:
    String beforeUrl = "www.baidu.com"; Map<String, String[]> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("receiver", new String[] { "鑫哥", "feilong" }); keyAndArrayMap.put("province", new String[] { "江苏省" }); keyAndArrayMap.put("city", new String[] { "南通市" }); LOGGER.info(ParamUtil.addParameterArrayValueMap(beforeUrl, keyAndArrayMap, UTF8));
    返回:
    www.baidu.com?receiver=%E9%91%AB%E5%93%A5&receiver=feilong&province=%E6%B1%9F%E8%8B%8F%E7%9C%81&city=%E5%8D%97%E9%80%9A%E5%B8%82
    示例2:
    String beforeUrl = "www.baidu.com?a=b"; Map<String, String[]> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("province", new String[] { "江苏省" }); keyAndArrayMap.put("city", new String[] { "南通市" }); LOGGER.info(ParamUtil.addParameterArrayValueMap(beforeUrl, keyAndArrayMap, UTF8));
    返回:
    www.baidu.com?a=b&province=%E6%B1%9F%E8%8B%8F%E7%9C%81&city=%E5%8D%97%E9%80%9A%E5%B8%82
    Parameters:
    uriString - 如果带有? 和参数,会先被截取,最后再拼接,
    如果不带?,则自动增加?
    arrayValueMap - the name and array value map
    charsetType - 字符编码,建议使用 CharsetType 定义好的常量
    如果是null或者 empty,那么参数部分原样返回,自行处理兼容性问题
    否则会先解码,再加码,因为ie浏览器和chrome浏览器 url中访问路径 ,带有中文情况下不一致
    
    Returns:
    如果 uriString 是null或者empty,返回 StringUtils.EMPTY
    如果 arrayValueMap 是null,当作empty map处理
    如果 charsetType 是null或者empty,那么参数部分原样拼接处理,自行处理兼容性问题
    Since:
    
    1.4.0
    
    See Also:
    addParameterArrayValueMap(String, String, Map, String)
  - toSingleValueMap
```
public static Map<String,String> toSingleValueMap(String queryString,
                                  String charsetType)
```
    将a=1&b=2这样格式的 queryString数据转换成map.
    说明:
    如果参数里面有相同名字的参数,那么转换的时候取第一个值
    
    内部使用 LinkedHashMap,map顺序依照 queryString 分隔的顺序
    示例:
    String queryString = "sec_id=MD5&format=xml&sign=cc945983476d615ca66cee41a883f6c1&v=2.0&req_data=%3Cauth_and_execute_req%3E%3Crequest_token%3E201511191eb5762bd0150ab33ed73976f7639893%3C%2Frequest_token%3E%3C%2Fauth_and_execute_req%3E&service=alipay.wap.auth.authAndExecute&partner=2088011438559510"; LOGGER.info(JsonUtil.format(ParamUtil.toSingleValueMap(queryString, UTF8)));
    返回:
    { "sec_id": "MD5", "format": "xml", "sign": "cc945983476d615ca66cee41a883f6c1", "v": "2.0", "req_data":"%3Cauth_and_execute_req%3E%3Crequest_token%3E201511191eb5762bd0150ab33ed73976f7639893%3C%2Frequest_token%3E%3C%2Fauth_and_execute_req%3E", "service": "alipay.wap.auth.authAndExecute", "partner": "2088011438559510" }
    Parameters:
    queryString - the query string
    charsetType - 字符编码,建议使用 CharsetType 定义好的常量
    如果是null或者 empty,那么参数部分原样返回,自行处理兼容性问题
    否则会先解码,再加码,因为ie浏览器和chrome浏览器 url中访问路径 ,带有中文情况下不一致
    
    Returns:
    如果 queryString 是null或者empty,返回 Collections.emptyMap()
    Since:
    
    1.4.0
    
    See Also:
    toSafeArrayValueMap(String, String)
  - toNaturalOrderingKeyJoinValue
```
public static String toNaturalOrderingKeyJoinValue(Map<String,String> singleValueMap)
```
    将 singleValueMap 转成自然排序, 然后将key和value直接拼接成字符串(不使用 = 和& 分隔).
    已知,适用于网易易盾验证码
    
    示例:
    Map<String, String> map = newHashMap(); map.put("service", "create_salesorder"); map.put("_input_charset", "gbk"); map.put("totalActual", "210.00"); map.put("address", "江苏南通市通州区888组888号"); LOGGER.debug(ParamUtil.toNaturalOrderingKeyJoinValue(map));
    返回:
    _input_charsetgbkaddress江苏南通市通州区888组888号servicecreate_salesordertotalActual210.00
    规则:
    首先将singleValueMap 使用 SortUtil.sortMapByKeyAsc(Map) 进行排序,
    
    然后将map的key和value 直接连接
    说明:
    常用于和第三方对接数据(比如网易易盾验证码,生成 待签名的字符串)
    
    该方法不会执行encode操作,使用原生值进行拼接
    
    对于 null key或者null value的处理:
    
    如果 singleValueMap 中,
    如果有 key 是null,那么会使用 StringUtils.EMPTY 进行拼接;
    如果有 value 是 null,那么会使用 StringUtils.EMPTY 进行拼接
    
    示例:
    
    Map<String, String> map = newHashMap(); map.put("totalActual", null); map.put(null, "create_salesorder"); map.put("province", "江苏省"); LOGGER.debug(ParamUtil.toNaturalOrderingKeyJoinValue(map));
    返回:
    create_salesorderprovince江苏省totalActual
    Parameters:
    singleValueMap - 用于拼接签名的参数
    
    Returns:
    如果 singleValueMap 是null或者empty,返回 StringUtils.EMPTY
    否则将singleValueMap排序之后,循环直接拼接key和value
    Since:
    
    1.10.6
  - toNaturalOrderingJoinValue
```
public static String toNaturalOrderingJoinValue(Map<String,String> singleValueMap)
```
    将 singleValueMap 转成自然排序, 然后仅将value直接拼接成字符串(不使用 = 和& 分隔).
    已知,适用于银联大华捷通
    
    示例:
    Map<String, String> map = newHashMap(); map.put("service", "create_salesorder"); map.put("_input_charset", "gbk"); map.put("totalActual", "210.00"); map.put("address", "江苏南通市通州区888组888号"); LOGGER.debug(ParamUtil.toNaturalOrderingJoinValue(map));
    返回:
    gbk江苏南通市通州区888组888号create_salesorder210.00
    规则:
    首先将singleValueMap 使用 SortUtil.sortMapByKeyAsc(Map) 进行排序,
    
    然后将map的value 直接连接
    说明:
    常用于和第三方对接数据(比如银联大华捷通,生成 待签名的字符串)
    
    该方法不会执行encode操作,使用原生值进行拼接
    
    对于 null key或者null value的处理:
    
    如果 singleValueMap 中,
    如果有 value 是 null,那么会使用 StringUtils.EMPTY 进行拼接
    
    示例:
    
    Map<String, String> map = newHashMap(); map.put("totalActual", null); map.put("province", "江苏省"); LOGGER.debug(ParamUtil.toNaturalOrderingKeyJoinValue(map));
    返回:
    江苏省
    Parameters:
    singleValueMap - 用于拼接签名的参数
    
    Returns:
    如果 singleValueMap 是null或者empty,返回 StringUtils.EMPTY
    否则将singleValueMap排序之后,循环直接拼接value
    Since:
    
    2.0.1
  - toNaturalOrderingQueryString
```
public static String toNaturalOrderingQueryString(Map<String,String> singleValueMap)
```
    将 singleValueMap 转成自然排序的 queryString 字符串.
    示例:
    Map<String, String> map = newHashMap(); map.put("service", "create_salesorder"); map.put("_input_charset", "gbk"); map.put("totalActual", "210.00"); map.put("address", "江苏南通市通州区888组888号"); LOGGER.debug(ParamUtil.toNaturalOrderingQueryString(map));
    返回:
    _input_charset=gbk&address=江苏南通市通州区888组888号&service=create_salesorder&totalActual=210.00
    规则:
    首先将singleValueMap 使用 SortUtil.sortMapByKeyAsc(Map) 进行排序,
    
    然后将map的key和value 使用= 符号连接,不同的entry之间再使用& 符号进行连接,最终格式类似于 url 的queryString
    说明:
    常用于和第三方对接数据(比如支付宝,生成 待签名的字符串)
    
    该方法不会执行encode操作,使用原生值进行拼接
    
    对于 null key或者null value的处理:
    
    如果 singleValueMap 中,
    如果有 key 是null,那么会使用 StringUtils.EMPTY 进行拼接;
    如果有 value 是 null,那么会使用 StringUtils.EMPTY 进行拼接
    
    示例:
    
    Map<String, String> map = newHashMap(); map.put("totalActual", null); map.put(null, "create_salesorder"); map.put("province", "江苏省"); LOGGER.debug(ParamUtil.toNaturalOrderingQueryString(map));
    返回:
    =create_salesorder&province=江苏省&totalActual=
    Parameters:
    singleValueMap - 用于拼接签名的参数
    
    Returns:
    如果 singleValueMap 是null或者empty,返回 StringUtils.EMPTY
    否则将singleValueMap排序之后,调用 toQueryStringUseSingleValueMap(Map)
    Since:
    
    1.4.0
  - toQueryStringUseSingleValueMap
```
public static String toQueryStringUseSingleValueMap(Map<String,String> singleValueMap)
```
    将singleValueMap转成 queryString.
    说明:
    只是简单的将map的key value 按照 singleValueMap的顺序连接起来,最终格式类似于 url 的queryString,
    比如,参数名字param Name=name,param Value=zhangfei,那么返回值是 name=zhangfei
    
    如果singleValueMap有key 是null,将使用 StringUtils.EMPTY 进行拼接
    
    如果singleValueMap有value 是null,将使用 StringUtils.EMPTY 进行拼接
    示例1:
    Map<String, String> singleValueMap = new LinkedHashMap<>(); singleValueMap.put("province", "江苏省"); singleValueMap.put("city", "南通市"); LOGGER.info(ParamUtil.joinSingleValueMap(singleValueMap));
    返回:
    province=江苏省&city=南通市
    示例2:
    Map<String, String> map = new LinkedHashMap<>(); map.put(null, null); map.put("a", ""); map.put("b", null); map.put("c", "jim"); LOGGER.info(ParamUtil.toQueryStringUseSingleValueMap(map));
    返回:
    =&a=&b=&c=jim
    Parameters:
    singleValueMap - the params map
    
    Returns:
    如果singleValueMap是 null或者empty,返回 StringUtils.EMPTY
    否则将 singleValueMap 转成 MapUtil.toArrayValueMap(Map),再调用 toQueryStringUseArrayValueMap(Map)
    Since:
    
    1.5.5
    
    See Also:
    MapUtil.toArrayValueMap(Map), toQueryStringUseArrayValueMap(Map), build-convert-map-to-query-string
  - toQueryStringUseArrayValueMap
```
public static String toQueryStringUseArrayValueMap(Map<String,String[]> arrayValueMap)
```
    只是简单的将map的key value 连接起来,最终格式类似于 url 的queryString.
    注意:
    该方法不会执行encode操作,使用原生值进行拼接
    
    按照传入的map key顺序进行排序,不会自行自动排序转换;如有有业务需求,先行排序完传入进来
    
    如果arrayValueMap有key 是null,将使用 StringUtils.EMPTY 进行拼接
    
    如果arrayValueMap有value的元素是null,将使用 StringUtils.EMPTY 进行拼接
    示例1:
    Map<String, String[]> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("province", new String[] { "江苏省", "浙江省" }); keyAndArrayMap.put("city", new String[] { "南通市" }); LOGGER.info(ParamUtil.joinArrayValueMap(keyAndArrayMap));
    返回:
    province=江苏省&province=浙江省&city=南通市
    示例2:
    Map<String, String[]> keyAndArrayMap = new LinkedHashMap<>(); keyAndArrayMap.put("province", new String[] { "江苏省", null }); keyAndArrayMap.put("city", new String[] { "南通市" }); LOGGER.info(ParamUtil.joinArrayValueMap(keyAndArrayMap));
    返回:
    province=江苏省&province=&city=南通市
    Parameters:
    arrayValueMap - the array value map
    
    Returns:
    如果 arrayValueMap 是 null或者Empty,返回 StringUtils.EMPTY
    否则循环 arrayValueMap 拼接成QueryString
    Since:
    
    1.5.5
    
    See Also:
    build-convert-map-to-query-string
  - joinValuesOrderByIncludeKeys
```
@SafeVarargs
public static <K> String joinValuesOrderByIncludeKeys(Map<K,String> singleValueMap,
                                                  K... includeKeys)
```
    在singleValueMap中取到指定includeKeys key的value,连接起来(不使用任何连接符).
    说明:
    拼接的顺序按照 includeKeys 的顺序,目前适用于个别银行(比如汇付天下)需要将值拼接起来加密
    
    如果singleValueMap中的value是null,那么会以StringUtils.EMPTY替代,进行拼接
    示例:
    场景: 拼接map中 key是 "service"以及 "paymentType"的 value
    
    Map<String, String> map = newHashMap(); map.put("service", "create_salesorder"); map.put("paymentType", "unionpay_mobile"); ParamUtil.joinValuesOrderByIncludeKeys(map, "service", "paymentType") = create_salesorderunionpay_mobile
    Type Parameters:
    K - the key type
    Parameters:
    singleValueMap - the map
    includeKeys - 包含的key
    
    Returns:
    如果 singleValueMap 是null,抛出 NullPointerException
    如果 includeKeys 是null或者empty,返回 StringUtils.EMPTY
    否则循环 includeKeys,依次从 singleValueMap中取到值,连接起来;
    Since:
    
    1.5.5
    
    See Also:
    StringUtils.defaultString(String)

Class ParamUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addParameter

说明:

示例:

addParameterSingleValueMap

说明:

示例1:

示例2:

addParameterArrayValueMap

说明:

示例1:

示例2:

toSingleValueMap

说明:

示例:

toNaturalOrderingKeyJoinValue

示例:

规则:

说明:

对于 null key或者null value的处理:

示例:

toNaturalOrderingJoinValue

示例:

规则:

说明:

对于 null key或者null value的处理:

示例:

toNaturalOrderingQueryString

示例:

规则:

说明:

对于 null key或者null value的处理:

示例:

toQueryStringUseSingleValueMap

说明:

示例1:

示例2:

toQueryStringUseArrayValueMap

注意:

示例1:

示例2:

joinValuesOrderByIncludeKeys

说明:

示例: