cn.hutool.core.map.MapUtil Maven / Gradle / Ivy
Show all versions of hutool-all Show documentation
package cn.hutool.core.map;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.exceptions.UtilException;
import cn.hutool.core.lang.*;
import cn.hutool.core.stream.CollectorUtil;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.JdkUtil;
import cn.hutool.core.util.ReflectUtil;
import cn.hutool.core.util.StrUtil;
import java.util.*;
import java.util.Map.Entry;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.BiFunction;
import java.util.function.Function;
/**
* Map相关工具类
*
* @author Looly
* @since 3.1.1
*/
public class MapUtil {
/**
* 默认初始大小
*/
public static final int DEFAULT_INITIAL_CAPACITY = 16;
/**
* 默认增长因子，当Map的size达到 容量*增长因子时，开始扩充Map
*/
public static final float DEFAULT_LOAD_FACTOR = 0.75f;
/**
* Map是否为空
*
* @param map 集合
* @return 是否为空
*/
public static boolean isEmpty(Map map) {
return null == map || map.isEmpty();
}
/**
* Map是否为非空
*
* @param map 集合
* @return 是否为非空
*/
public static boolean isNotEmpty(Map map) {
return null != map && false == map.isEmpty();
}
/**
* 如果提供的集合为{@code null}，返回一个不可变的默认空集合，否则返回原集合
* 空集合使用{@link Collections#emptyMap()}
*
* @param 键类型
* @param 值类型
* @param set 提供的集合，可能为null
* @return 原集合，若为null返回空集合
* @since 4.6.3
*/
public static Map emptyIfNull(Map set) {
return (null == set) ? Collections.emptyMap() : set;
}
/**
* 如果给定Map为空，返回默认Map
*
* @param 集合类型
* @param 键类型
* @param 值类型
* @param map Map
* @param defaultMap 默认Map
* @return 非空（empty）的原Map或默认Map
* @since 4.6.9
*/
public static , K, V> T defaultIfEmpty(T map, T defaultMap) {
return isEmpty(map) ? defaultMap : map;
}
// ----------------------------------------------------------------------------------------------- new HashMap
/**
* 新建一个HashMap
*
* @param Key类型
* @param Value类型
* @return HashMap对象
*/
public static HashMap newHashMap() {
return new HashMap<>();
}
/**
* 新建一个HashMap
*
* @param Key类型
* @param Value类型
* @param size 初始大小，由于默认负载因子0.75，传入的size会实际初始大小为size / 0.75 + 1
* @param isLinked Map的Key是否有序，有序返回 {@link LinkedHashMap}，否则返回 {@link HashMap}
* @return HashMap对象
* @since 3.0.4
*/
public static HashMap newHashMap(int size, boolean isLinked) {
final int initialCapacity = (int) (size / DEFAULT_LOAD_FACTOR) + 1;
return isLinked ? new LinkedHashMap<>(initialCapacity) : new HashMap<>(initialCapacity);
}
/**
* 新建一个HashMap
*
* @param Key类型
* @param Value类型
* @param size 初始大小，由于默认负载因子0.75，传入的size会实际初始大小为size / 0.75 + 1
* @return HashMap对象
*/
public static HashMap newHashMap(int size) {
return newHashMap(size, false);
}
/**
* 新建一个HashMap
*
* @param Key类型
* @param Value类型
* @param isLinked Map的Key是否有序，有序返回 {@link LinkedHashMap}，否则返回 {@link HashMap}
* @return HashMap对象
*/
public static HashMap newHashMap(boolean isLinked) {
return newHashMap(DEFAULT_INITIAL_CAPACITY, isLinked);
}
/**
* 新建TreeMap，Key有序的Map
*
* @param key的类型
* @param value的类型
* @param comparator Key比较器
* @return TreeMap
* @since 3.2.3
*/
public static TreeMap newTreeMap(Comparator comparator) {
return new TreeMap<>(comparator);
}
/**
* 新建TreeMap，Key有序的Map
*
* @param key的类型
* @param value的类型
* @param map Map
* @param comparator Key比较器
* @return TreeMap
* @since 3.2.3
*/
public static TreeMap newTreeMap(Map map, Comparator comparator) {
final TreeMap treeMap = new TreeMap<>(comparator);
if (false == isEmpty(map)) {
treeMap.putAll(map);
}
return treeMap;
}
/**
* 创建键不重复Map
*
* @param key的类型
* @param value的类型
* @param size 初始容量
* @return {@link IdentityHashMap}
* @since 4.5.7
*/
public static Map newIdentityMap(int size) {
return new IdentityHashMap<>(size);
}
/**
* 新建一个初始容量为{@link MapUtil#DEFAULT_INITIAL_CAPACITY} 的ConcurrentHashMap
*
* @param key的类型
* @param value的类型
* @return ConcurrentHashMap
*/
public static ConcurrentHashMap newConcurrentHashMap() {
return new ConcurrentHashMap<>(DEFAULT_INITIAL_CAPACITY);
}
/**
* 新建一个ConcurrentHashMap
*
* @param size 初始容量，当传入的容量小于等于0时，容量为{@link MapUtil#DEFAULT_INITIAL_CAPACITY}
* @param key的类型
* @param value的类型
* @return ConcurrentHashMap
*/
public static ConcurrentHashMap newConcurrentHashMap(int size) {
final int initCapacity = size <= 0 ? DEFAULT_INITIAL_CAPACITY : size;
return new ConcurrentHashMap<>(initCapacity);
}
/**
* 传入一个Map将其转化为ConcurrentHashMap类型
*
* @param map map
* @param key的类型
* @param value的类型
* @return ConcurrentHashMap
*/
public static ConcurrentHashMap newConcurrentHashMap(Map map) {
if (isEmpty(map)) {
return new ConcurrentHashMap<>(DEFAULT_INITIAL_CAPACITY);
}
return new ConcurrentHashMap<>(map);
}
/**
* 创建Map
* 传入抽象Map{@link AbstractMap}和{@link Map}类将默认创建{@link HashMap}
*
* @param map键类型
* @param map值类型
* @param mapType map类型
* @return {@link Map}实例
*/
@SuppressWarnings("unchecked")
public static Map createMap(Class mapType) {
if (null == mapType || mapType.isAssignableFrom(AbstractMap.class)) {
return new HashMap<>();
} else {
try {
return (Map) ReflectUtil.newInstance(mapType);
} catch (UtilException e) {
// 不支持的map类型，返回默认的HashMap
return new HashMap<>();
}
}
}
// ----------------------------------------------------------------------------------------------- value of
/**
* 将单一键值对转换为Map
*
* @param 键类型
* @param 值类型
* @param key 键
* @param value 值
* @return {@link HashMap}
*/
public static HashMap of(K key, V value) {
return of(key, value, false);
}
/**
* 将单一键值对转换为Map
*
* @param 键类型
* @param 值类型
* @param key 键
* @param value 值
* @param isOrder 是否有序
* @return {@link HashMap}
*/
public static HashMap of(K key, V value, boolean isOrder) {
final HashMap map = newHashMap(isOrder);
map.put(key, value);
return map;
}
/**
* 根据给定的Pair数组创建Map对象
*
* @param 键类型
* @param 值类型
* @param pairs 键值对
* @return Map
* @since 5.4.1
* @deprecated 方法容易歧义，请使用 {@code #ofEntries(Entry[])}
*/
@SafeVarargs
@Deprecated
public static Map of(Pair... pairs) {
final Map map = new HashMap<>();
for (Pair pair : pairs) {
map.put(pair.getKey(), pair.getValue());
}
return map;
}
/**
* 根据给定的Pair数组创建Map对象
*
* @param 键类型
* @param 值类型
* @param entries 键值对
* @return Map
* @see #entry(Object, Object)
* @since 5.8.0
*/
@SafeVarargs
public static Map ofEntries(Map.Entry... entries) {
final Map map = new HashMap<>();
for (Map.Entry pair : entries) {
map.put(pair.getKey(), pair.getValue());
}
return map;
}
/**
* 将数组转换为Map（HashMap），支持数组元素类型为：
*
*
* Map.Entry
* 长度大于1的数组（取前两个值），如果不满足跳过此元素
* Iterable 长度也必须大于1（取前两个值），如果不满足跳过此元素
* Iterator 长度也必须大于1（取前两个值），如果不满足跳过此元素
*
*
*
* Map<Object, Object> colorMap = MapUtil.of(new String[][] {
* { "RED", "#FF0000" },
* { "GREEN", "#00FF00" },
* { "BLUE", "#0000FF" }
* });
*
*
* 参考：commons-lang
*
* @param array 数组。元素类型为Map.Entry、数组、Iterable、Iterator
* @return {@link HashMap}
* @since 3.0.8
*/
@SuppressWarnings("rawtypes")
public static HashMap of(Object[] array) {
if (array == null) {
return null;
}
final HashMap map = new HashMap<>((int) (array.length * 1.5));
for (int i = 0; i < array.length; i++) {
final Object object = array[i];
if (object instanceof Map.Entry) {
Map.Entry entry = (Map.Entry) object;
map.put(entry.getKey(), entry.getValue());
} else if (object instanceof Object[]) {
final Object[] entry = (Object[]) object;
if (entry.length > 1) {
map.put(entry[0], entry[1]);
}
} else if (object instanceof Iterable) {
final Iterator iter = ((Iterable) object).iterator();
if (iter.hasNext()) {
final Object key = iter.next();
if (iter.hasNext()) {
final Object value = iter.next();
map.put(key, value);
}
}
} else if (object instanceof Iterator) {
final Iterator iter = ((Iterator) object);
if (iter.hasNext()) {
final Object key = iter.next();
if (iter.hasNext()) {
final Object value = iter.next();
map.put(key, value);
}
}
} else {
throw new IllegalArgumentException(StrUtil.format("Array element {}, '{}', is not type of Map.Entry or Array or Iterable or Iterator", i, object));
}
}
return map;
}
/**
* 行转列，合并相同的键，值合并为列表
* 将Map列表中相同key的值组成列表做为Map的value
* 是{@link #toMapList(Map)}的逆方法
* 比如传入数据：
*
*
* [
* {a: 1, b: 1, c: 1}
* {a: 2, b: 2}
* {a: 3, b: 3}
* {a: 4}
* ]
*
*
* 结果是：
*
*
* {
* a: [1,2,3,4]
* b: [1,2,3,]
* c: [1]
* }
*
*
* @param 键类型
* @param 值类型
* @param mapList Map列表
* @return Map
*/
public static Map> toListMap(Iterable> mapList) {
final HashMap> resultMap = new HashMap<>();
if (CollUtil.isEmpty(mapList)) {
return resultMap;
}
Set> entrySet;
for (Map map : mapList) {
entrySet = map.entrySet();
K key;
List valueList;
for (Entry entry : entrySet) {
key = entry.getKey();
valueList = resultMap.get(key);
if (null == valueList) {
valueList = CollUtil.newArrayList(entry.getValue());
resultMap.put(key, valueList);
} else {
valueList.add(entry.getValue());
}
}
}
return resultMap;
}
/**
* 列转行。将Map中值列表分别按照其位置与key组成新的map。
* 是{@link #toListMap(Iterable)}的逆方法
* 比如传入数据：
*
*
* {
* a: [1,2,3,4]
* b: [1,2,3,]
* c: [1]
* }
*
*
* 结果是：
*
*
* [
* {a: 1, b: 1, c: 1}
* {a: 2, b: 2}
* {a: 3, b: 3}
* {a: 4}
* ]
*
*
* @param 键类型
* @param 值类型
* @param listMap 列表Map
* @return Map列表
*/
public static List> toMapList(Map> listMap) {
final List> resultList = new ArrayList<>();
if (isEmpty(listMap)) {
return resultList;
}
boolean isEnd;// 是否结束。标准是元素列表已耗尽
int index = 0;// 值索引
Map map;
do {
isEnd = true;
map = new HashMap<>();
List vList;
int vListSize;
for (Entry> entry : listMap.entrySet()) {
vList = CollUtil.newArrayList(entry.getValue());
vListSize = vList.size();
if (index < vListSize) {
map.put(entry.getKey(), vList.get(index));
if (index != vListSize - 1) {
// 当值列表中还有更多值（非最后一个），继续循环
isEnd = false;
}
}
}
if (false == map.isEmpty()) {
resultList.add(map);
}
index++;
} while (false == isEnd);
return resultList;
}
/**
* 根据给定的entry列表，根据entry的key进行分组;
*
* @param 键类型
* @param 值类型
* @param entries entry列表
* @return entries
*/
public static Map> grouping(Iterable> entries) {
final Map> map = new HashMap<>();
if (CollUtil.isEmpty(entries)) {
return map;
}
for (final Map.Entry pair : entries) {
final List values = map.computeIfAbsent(pair.getKey(), k -> new ArrayList<>());
values.add(pair.getValue());
}
return map;
}
/**
* 将已知Map转换为key为驼峰风格的Map
* 如果KEY为非String类型，保留原值
*
* @param key的类型
* @param value的类型
* @param map 原Map
* @return 驼峰风格Map
* @since 3.3.1
*/
public static Map toCamelCaseMap(Map map) {
return (map instanceof LinkedHashMap) ? new CamelCaseLinkedMap<>(map) : new CamelCaseMap<>(map);
}
/**
* 将键值对转换为二维数组，第一维是key，第二维是value
*
* @param map map
* @return 数组
* @since 4.1.9
*/
public static Object[][] toObjectArray(Map map) {
if (map == null) {
return null;
}
final Object[][] result = new Object[map.size()][2];
if (map.isEmpty()) {
return result;
}
int index = 0;
for (Entry entry : map.entrySet()) {
result[index][0] = entry.getKey();
result[index][1] = entry.getValue();
index++;
}
return result;
}
// ----------------------------------------------------------------------------------------------- join
/**
* 将map转成字符串
*
* @param 键类型
* @param 值类型
* @param map Map
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @param otherParams 其它附加参数字符串（例如密钥）
* @return 连接字符串
* @since 3.1.1
*/
public static String join(Map map, String separator, String keyValueSeparator, String... otherParams) {
return join(map, separator, keyValueSeparator, false, otherParams);
}
/**
* 根据参数排序后拼接为字符串，常用于签名
*
* @param params 参数
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @param isIgnoreNull 是否忽略null的键和值
* @param otherParams 其它附加参数字符串（例如密钥）
* @return 签名字符串
* @since 5.0.4
*/
public static String sortJoin(Map params, String separator, String keyValueSeparator, boolean isIgnoreNull,
String... otherParams) {
return join(sort(params), separator, keyValueSeparator, isIgnoreNull, otherParams);
}
/**
* 将map转成字符串，忽略null的键和值
*
* @param 键类型
* @param 值类型
* @param map Map
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @param otherParams 其它附加参数字符串（例如密钥）
* @return 连接后的字符串
* @since 3.1.1
*/
public static String joinIgnoreNull(Map map, String separator, String keyValueSeparator, String... otherParams) {
return join(map, separator, keyValueSeparator, true, otherParams);
}
/**
* 将map转成字符串
*
* @param 键类型
* @param 值类型
* @param map Map，为空返回otherParams拼接
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @param isIgnoreNull 是否忽略null的键和值
* @param otherParams 其它附加参数字符串（例如密钥）
* @return 连接后的字符串，map和otherParams为空返回""
* @since 3.1.1
*/
public static String join(Map map, String separator, String keyValueSeparator, boolean isIgnoreNull, String... otherParams) {
final StringBuilder strBuilder = StrUtil.builder();
boolean isFirst = true;
if (isNotEmpty(map)) {
for (Entry entry : map.entrySet()) {
if (false == isIgnoreNull || entry.getKey() != null && entry.getValue() != null) {
if (isFirst) {
isFirst = false;
} else {
strBuilder.append(separator);
}
strBuilder.append(Convert.toStr(entry.getKey())).append(keyValueSeparator).append(Convert.toStr(entry.getValue()));
}
}
}
// 补充其它字符串到末尾，默认无分隔符
if (ArrayUtil.isNotEmpty(otherParams)) {
for (String otherParam : otherParams) {
strBuilder.append(otherParam);
}
}
return strBuilder.toString();
}
// ----------------------------------------------------------------------------------------------- filter
/**
* 编辑Map
* 编辑过程通过传入的Editor实现来返回需要的元素内容，这个Editor实现可以实现以下功能：
*
*
* 1、过滤出需要的对象，如果返回{@code null}表示这个元素对象抛弃
* 2、修改元素对象，返回集合中为修改后的对象
*
*
* @param Key类型
* @param Value类型
* @param map Map
* @param editor 编辑器接口
* @return 编辑后的Map
*/
@SuppressWarnings("unchecked")
public static Map edit(Map map, Editor> editor) {
if (null == map || null == editor) {
return map;
}
Map map2 = ReflectUtil.newInstanceIfPossible(map.getClass());
if (null == map2) {
map2 = new HashMap<>(map.size(), 1f);
}
if (isEmpty(map)) {
return map2;
}
// issue#3162@Github，在构造中put值，会导致新建map带有值内容，此处清空
if (false == map2.isEmpty()) {
map2.clear();
}
Entry modified;
for (Entry entry : map.entrySet()) {
modified = editor.edit(entry);
if (null != modified) {
map2.put(modified.getKey(), modified.getValue());
}
}
return map2;
}
/**
* 过滤
* 过滤过程通过传入的Editor实现来返回需要的元素内容，这个Filter实现可以实现以下功能：
*
*
* 1、过滤出需要的对象，如果返回null表示这个元素对象抛弃
*
*
* @param Key类型
* @param Value类型
* @param map Map
* @param filter 过滤器接口，{@code null}返回原Map
* @return 过滤后的Map
* @since 3.1.0
*/
public static Map filter(Map map, Filter> filter) {
if (null == map || null == filter) {
return map;
}
return edit(map, t -> filter.accept(t) ? t : null);
}
/**
* 通过biFunction自定义一个规则，此规则将原Map中的元素转换成新的元素，生成新的Map返回
* 变更过程通过传入的 {@link BiFunction} 实现来返回一个值可以为不同类型的 {@link Map}
*
* @param map 原有的map
* @param biFunction {@code lambda}，参数包含{@code key},{@code value}，返回值会作为新的{@code value}
* @param {@code key}的类型
* @param {@code value}的类型
* @param 新的，修改后的{@code value}的类型
* @return 值可以为不同类型的 {@link Map}
* @since 5.8.0
*/
public static Map map(Map map, BiFunction biFunction) {
if (null == map || null == biFunction) {
return MapUtil.newHashMap();
}
return map.entrySet().stream().collect(CollectorUtil.toMap(Map.Entry::getKey, m -> biFunction.apply(m.getKey(), m.getValue()), (l, r) -> l));
}
/**
* 过滤Map保留指定键值对，如果键不存在跳过
*
* @param Key类型
* @param Value类型
* @param map 原始Map
* @param keys 键列表，{@code null}返回原Map
* @return Map 结果，结果的Map类型与原Map保持一致
* @since 4.0.10
*/
@SuppressWarnings("unchecked")
public static Map filter(Map map, K... keys) {
if (null == map || null == keys) {
return map;
}
Map map2 = ReflectUtil.newInstanceIfPossible(map.getClass());
if (null == map2) {
map2 = new HashMap<>(map.size(), 1f);
}
if (isEmpty(map)) {
return map2;
}
// issue#3162@Github，在构造中put值，会导致新建map带有值内容，此处清空
if (false == map2.isEmpty()) {
map2.clear();
}
for (K key : keys) {
if (map.containsKey(key)) {
map2.put(key, map.get(key));
}
}
return map2;
}
/**
* Map的键和值互换
* 互换键值对不检查值是否有重复，如果有则后加入的元素替换先加入的元素
* 值的顺序在HashMap中不确定，所以谁覆盖谁也不确定，在有序的Map中按照先后顺序覆盖，保留最后的值
*
* @param 键和值类型
* @param map Map对象，键值类型必须一致
* @return 互换后的Map
* @see #inverse(Map)
* @since 3.2.2
*/
public static Map reverse(Map map) {
return edit(map, t -> new Entry() {
@Override
public T getKey() {
return t.getValue();
}
@Override
public T getValue() {
return t.getKey();
}
@Override
public T setValue(T value) {
throw new UnsupportedOperationException("Unsupported setValue method !");
}
});
}
/**
* Map的键和值互换
* 互换键值对不检查值是否有重复，如果有则后加入的元素替换先加入的元素
* 值的顺序在HashMap中不确定，所以谁覆盖谁也不确定，在有序的Map中按照先后顺序覆盖，保留最后的值
*
* @param 键和值类型
* @param 键和值类型
* @param map Map对象
* @return 互换后的Map
* @since 5.2.6
*/
public static Map inverse(Map map) {
final Map result = createMap(map.getClass());
map.forEach((key, value) -> result.put(value, key));
return result;
}
/**
* 排序已有Map，Key有序的Map，使用默认Key排序方式（字母顺序）
*
* @param key的类型
* @param value的类型
* @param map Map
* @return TreeMap
* @see #newTreeMap(Map, Comparator)
* @since 4.0.1
*/
public static TreeMap sort(Map map) {
return sort(map, null);
}
/**
* 排序已有Map，Key有序的Map
*
* @param key的类型
* @param value的类型
* @param map Map，为null返回null
* @param comparator Key比较器
* @return TreeMap，map为null返回null
* @see #newTreeMap(Map, Comparator)
* @since 4.0.1
*/
public static TreeMap sort(Map map, Comparator comparator) {
if (null == map) {
return null;
}
if (map instanceof TreeMap) {
// 已经是可排序Map，此时只有比较器一致才返回原map
TreeMap result = (TreeMap) map;
if (null == comparator || comparator.equals(result.comparator())) {
return result;
}
}
return newTreeMap(map, comparator);
}
/**
* 按照值排序，可选是否倒序
*
* @param map 需要对值排序的map
* @param 键类型
* @param 值类型
* @param isDesc 是否倒序
* @return 排序后新的Map
* @since 5.5.8
*/
public static > Map sortByValue(Map map, boolean isDesc) {
Map result = new LinkedHashMap<>();
Comparator> entryComparator = Entry.comparingByValue();
if (isDesc) {
entryComparator = entryComparator.reversed();
}
map.entrySet().stream().sorted(entryComparator).forEachOrdered(e -> result.put(e.getKey(), e.getValue()));
return result;
}
/**
* 创建代理Map
* {@link MapProxy}对Map做一次包装，提供各种getXXX方法
*
* @param map 被代理的Map
* @return {@link MapProxy}
* @since 3.2.0
*/
public static MapProxy createProxy(Map map) {
return MapProxy.create(map);
}
/**
* 创建Map包装类MapWrapper
* {@link MapWrapper}对Map做一次包装
*
* @param key的类型
* @param value的类型
* @param map 被代理的Map
* @return {@link MapWrapper}
* @since 4.5.4
*/
public static MapWrapper wrap(Map map) {
return new MapWrapper<>(map);
}
/**
* 将对应Map转换为不可修改的Map
*
* @param map Map
* @param 键类型
* @param 值类型
* @return 不修改Map
* @since 5.2.6
*/
public static Map unmodifiable(Map map) {
return Collections.unmodifiableMap(map);
}
// ----------------------------------------------------------------------------------------------- builder
/**
* 创建链接调用map
*
* @param Key类型
* @param Value类型
* @return map创建类
*/
public static MapBuilder builder() {
return builder(new HashMap<>());
}
/**
* 创建链接调用map
*
* @param Key类型
* @param Value类型
* @param map 实际使用的map
* @return map创建类
*/
public static MapBuilder builder(Map map) {
return new MapBuilder<>(map);
}
/**
* 创建链接调用map
*
* @param Key类型
* @param Value类型
* @param k key
* @param v value
* @return map创建类
*/
public static MapBuilder builder(K k, V v) {
return (builder(new HashMap())).put(k, v);
}
/**
* 获取Map的部分key生成新的Map
*
* @param Key类型
* @param Value类型
* @param map Map
* @param keys 键列表
* @return 新Map，只包含指定的key
* @since 4.0.6
*/
@SuppressWarnings("unchecked")
public static Map getAny(Map map, final K... keys) {
return filter(map, entry -> ArrayUtil.contains(keys, entry.getKey()));
}
/**
* 去掉Map中指定key的键值对，修改原Map
*
* @param Key类型
* @param Value类型
* @param map Map
* @param keys 键列表
* @return 修改后的key
* @since 5.0.5
*/
@SuppressWarnings("unchecked")
public static Map removeAny(Map map, final K... keys) {
for (K key : keys) {
map.remove(key);
}
return map;
}
/**
* 获取Map指定key的值，并转换为字符串
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static String getStr(Map map, Object key) {
return get(map, key, String.class);
}
/**
* 获取Map指定key的值，并转换为字符串
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static String getStr(Map map, Object key, String defaultValue) {
return get(map, key, String.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Integer
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Integer getInt(Map map, Object key) {
return get(map, key, Integer.class);
}
/**
* 获取Map指定key的值，并转换为Integer
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Integer getInt(Map map, Object key, Integer defaultValue) {
return get(map, key, Integer.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Double
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Double getDouble(Map map, Object key) {
return get(map, key, Double.class);
}
/**
* 获取Map指定key的值，并转换为Double
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Double getDouble(Map map, Object key, Double defaultValue) {
return get(map, key, Double.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Float
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Float getFloat(Map map, Object key) {
return get(map, key, Float.class);
}
/**
* 获取Map指定key的值，并转换为Float
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Float getFloat(Map map, Object key, Float defaultValue) {
return get(map, key, Float.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Short
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Short getShort(Map map, Object key) {
return get(map, key, Short.class);
}
/**
* 获取Map指定key的值，并转换为Short
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Short getShort(Map map, Object key, Short defaultValue) {
return get(map, key, Short.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Bool
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Boolean getBool(Map map, Object key) {
return get(map, key, Boolean.class);
}
/**
* 获取Map指定key的值，并转换为Bool
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Boolean getBool(Map map, Object key, Boolean defaultValue) {
return get(map, key, Boolean.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Character
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Character getChar(Map map, Object key) {
return get(map, key, Character.class);
}
/**
* 获取Map指定key的值，并转换为Character
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Character getChar(Map map, Object key, Character defaultValue) {
return get(map, key, Character.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为Long
*
* @param map Map
* @param key 键
* @return 值
* @since 4.0.6
*/
public static Long getLong(Map map, Object key) {
return get(map, key, Long.class);
}
/**
* 获取Map指定key的值，并转换为Long
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static Long getLong(Map map, Object key, Long defaultValue) {
return get(map, key, Long.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为{@link Date}
*
* @param map Map
* @param key 键
* @return 值
* @since 4.1.2
*/
public static Date getDate(Map map, Object key) {
return get(map, key, Date.class);
}
/**
* 获取Map指定key的值，并转换为{@link Date}
*
* @param map Map
* @param key 键
* @param defaultValue 默认值
* @return 值
* @since 4.1.2
*/
public static Date getDate(Map map, Object key, Date defaultValue) {
return get(map, key, Date.class, defaultValue);
}
/**
* 获取Map指定key的值，并转换为指定类型
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @return 值
* @since 4.0.6
*/
public static T get(Map map, Object key, Class type) {
return get(map, key, type, null);
}
/**
* 获取Map指定key的值，并转换为指定类型
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static T get(Map map, Object key, Class type, T defaultValue) {
return null == map ? defaultValue : Convert.convert(type, map.get(key), defaultValue);
}
/**
* 获取Map指定key的值，并转换为指定类型，此方法在转换失败后不抛异常，返回null。
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @param defaultValue 默认值
* @return 值
* @since 5.5.3
*/
public static T getQuietly(Map map, Object key, Class type, T defaultValue) {
return null == map ? defaultValue : Convert.convertQuietly(type, map.get(key), defaultValue);
}
/**
* 获取Map指定key的值，并转换为指定类型
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @return 值
* @since 4.5.12
*/
public static T get(Map map, Object key, TypeReference type) {
return get(map, key, type, null);
}
/**
* 获取Map指定key的值，并转换为指定类型
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @param defaultValue 默认值
* @return 值
* @since 5.3.11
*/
public static T get(Map map, Object key, TypeReference type, T defaultValue) {
return null == map ? defaultValue : Convert.convert(type, map.get(key), defaultValue);
}
/**
* 获取Map指定key的值，并转换为指定类型，转换失败后返回null，不抛异常
*
* @param 目标值类型
* @param map Map
* @param key 键
* @param type 值类型
* @param defaultValue 默认值
* @return 值
* @since 5.5.3
*/
public static T getQuietly(Map map, Object key, TypeReference type, T defaultValue) {
return null == map ? defaultValue : Convert.convertQuietly(type, map.get(key), defaultValue);
}
/**
* 重命名键
* 实现方式为移除然后重新put，当旧的key不存在直接返回
* 当新的key存在，抛出{@link IllegalArgumentException} 异常
*
* @param key的类型
* @param value的类型
* @param map Map
* @param oldKey 原键
* @param newKey 新键
* @return map
* @throws IllegalArgumentException 新key存在抛出此异常
* @since 4.5.16
*/
public static Map renameKey(Map map, K oldKey, K newKey) {
if (isNotEmpty(map) && map.containsKey(oldKey)) {
if (map.containsKey(newKey)) {
throw new IllegalArgumentException(StrUtil.format("The key '{}' exist !", newKey));
}
map.put(newKey, map.remove(oldKey));
}
return map;
}
/**
* 去除Map中值为{@code null}的键值对
* 注意：此方法在传入的Map上直接修改。
*
* @param key的类型
* @param value的类型
* @param map Map
* @return map
* @since 4.6.5
*/
public static Map removeNullValue(Map map) {
if (isEmpty(map)) {
return map;
}
final Iterator> iter = map.entrySet().iterator();
Entry entry;
while (iter.hasNext()) {
entry = iter.next();
if (null == entry.getValue()) {
iter.remove();
}
}
return map;
}
/**
* 返回一个空Map
*
* @param