com.jchanghong.core.net.url.UrlQuery Maven / Gradle / Ivy
The newest version!
package com.jchanghong.core.net.url;
import com.jchanghong.core.collection.CollUtil;
import com.jchanghong.core.collection.IterUtil;
import com.jchanghong.core.convert.Convert;
import com.jchanghong.core.map.MapUtil;
import com.jchanghong.core.map.TableMap;
import com.jchanghong.core.util.StrUtil;
import com.jchanghong.core.util.URLUtil;
import java.nio.charset.Charset;
import java.util.Iterator;
import java.util.Map;
/**
* URL中查询字符串部分的封装，类似于：
*
* key1=v1&key2=&key3=v3
*
*
* @author looly
* @since 5.3.1
*/
public class UrlQuery {
private final TableMap query;
/**
* 构建UrlQuery
*
* @param queryMap 初始化的查询键值对
* @return {@link UrlQuery}
*/
public static UrlQuery of(Map queryMap) {
return new UrlQuery(queryMap);
}
/**
* 构建UrlQuery
*
* @param queryStr 初始化的查询字符串
* @param charset decode用的编码，null表示不做decode
* @return {@link UrlQuery}
*/
public static UrlQuery of(String queryStr, Charset charset) {
final UrlQuery urlQuery = new UrlQuery();
urlQuery.parse(queryStr, charset);
return urlQuery;
}
/**
* 构造
*/
public UrlQuery() {
this(null);
}
/**
* 构造
*
* @param queryMap 初始化的查询键值对
*/
public UrlQuery(Map queryMap) {
if (MapUtil.isNotEmpty(queryMap)) {
query = new TableMap<>(queryMap.size());
addAll(queryMap);
} else {
query = new TableMap<>(MapUtil.DEFAULT_INITIAL_CAPACITY);
}
}
/**
* 增加键值对
*
* @param key 键
* @param value 值，集合和数组转换为逗号分隔形式
* @return this
*/
public UrlQuery add(CharSequence key, Object value) {
this.query.put(key, toStr(value));
return this;
}
/**
* 批量增加键值对
*
* @param queryMap query中的键值对
* @return this
*/
public UrlQuery addAll(Map queryMap) {
if (MapUtil.isNotEmpty(queryMap)) {
queryMap.forEach(this::add);
}
return this;
}
/**
* 解析URL中的查询字符串
*
* @param queryStr 查询字符串，类似于key1=v1&key2=&key3=v3
* @param charset decode编码，null表示不做decode
* @return this
*/
public UrlQuery parse(String queryStr, Charset charset) {
if (StrUtil.isBlank(queryStr)) {
return this;
}
// 去掉Path部分
int pathEndPos = queryStr.indexOf('?');
if (pathEndPos > -1) {
queryStr = StrUtil.subSuf(queryStr, pathEndPos + 1);
if (StrUtil.isBlank(queryStr)) {
return this;
}
}
final int len = queryStr.length();
String name = null;
int pos = 0; // 未处理字符开始位置
int i; // 未处理字符结束位置
char c; // 当前字符
for (i = 0; i < len; i++) {
c = queryStr.charAt(i);
switch (c) {
case '='://键和值的分界符
if (null == name) {
// name可以是""
name = queryStr.substring(pos, i);
// 开始位置从分节符后开始
pos = i + 1;
}
// 当=不作为分界符时，按照普通字符对待
break;
case '&'://键值对之间的分界符
addParam(name, queryStr.substring(pos, i), charset);
name = null;
if (i+4 < len && "amp;".equals(queryStr.substring(i + 1, i + 5))) {
// issue#850@Github，"&"转义为"&"
i+=4;
}
// 开始位置从分节符后开始
pos = i + 1;
break;
}
}
// 处理结尾
addParam(name, queryStr.substring(pos, i), charset);
return this;
}
/**
* 获得查询的Map
*
* @return 查询的Map，只读
*/
public Map getQueryMap() {
return MapUtil.unmodifiable(this.query);
}
/**
* 获取查询值
*
* @param key 键
* @return 值
*/
public CharSequence get(CharSequence key) {
if (MapUtil.isEmpty(this.query)) {
return null;
}
return this.query.get(key);
}
/**
* 构建URL查询字符串，即将key-value键值对转换为key1=v1&key2=&key3=v3形式
*
* @param charset encode编码，null表示不做encode编码
* @return URL查询字符串
*/
public String build(Charset charset) {
if (MapUtil.isEmpty(this.query)) {
return StrUtil.EMPTY;
}
final StringBuilder sb = new StringBuilder();
boolean isFirst = true;
CharSequence key;
CharSequence value;
for (Map.Entry entry : this.query) {
if (isFirst) {
isFirst = false;
} else {
sb.append("&");
}
key = entry.getKey();
if (StrUtil.isNotEmpty(key)) {
sb.append(URLUtil.encodeAll(StrUtil.str(key), charset)).append("=");
value = entry.getValue();
if (StrUtil.isNotEmpty(value)) {
sb.append(URLUtil.encodeAll(StrUtil.str(value), charset));
}
}
}
return sb.toString();
}
@Override
public String toString() {
return build(null);
}
/**
* 对象转换为字符串，用于URL的Query中
*
* @param value 值
* @return 字符串
*/
private static String toStr(Object value) {
String result;
if (value instanceof Iterable) {
result = CollUtil.join((Iterable) value, ",");
} else if (value instanceof Iterator) {
result = IterUtil.join((Iterator) value, ",");
} else {
result = Convert.toStr(value);
}
return result;
}
/**
* 将键值对加入到值为List类型的Map中,，情况如下：
*
* 1、key和value都不为null，类似于 "a=1"或者"=1"，直接put
* 2、key不为null，value为null，类似于 "a="，值传""
* 3、key为null，value不为null，类似于 "1"
* 4、key和value都为null，忽略之，比如&&
*
*
* @param key key，为null则value作为key
* @param value value，为null且key不为null时传入""
* @param charset 编码
*/
private void addParam(String key, String value, Charset charset) {
if (null != key) {
final String actualKey = URLUtil.decode(key, charset);
this.query.put(actualKey, StrUtil.nullToEmpty(URLUtil.decode(value, charset)));
} else if (null != value) {
// name为空，value作为name，value赋值""
this.query.put(URLUtil.decode(value, charset), StrUtil.EMPTY);
}
}
}