Class MapUtil

java.lang.Object
com.sure.tool.collection.MapUtil

public class MapUtil extends Object
Map 工具类,参考 Hutool 的 MapUtil 设计。

English: Map construction and lookup helpers with typed getters and null-safe operations.

Since:
0.1.0
Author:
suretool
  • Method Details

    • isEmpty

      public static boolean isEmpty(Map<?,?> map)
      Map 是否为空。
      Parameters:
      map - Map
      Returns:
      是否为空
    • isNotEmpty

      public static boolean isNotEmpty(Map<?,?> map)
      Map 是否非空。
      Parameters:
      map - Map
      Returns:
      是否非空
    • newHashMap

      public static <K,V> HashMap<K,V> newHashMap()
      创建 HashMap。
      Type Parameters:
      K - key 类型
      V - value 类型
      Returns:
      HashMap
    • newHashMap

      public static <K,V> HashMap<K,V> newHashMap(int size)
      创建带初始容量的 HashMap。
      Type Parameters:
      K - key 类型
      V - value 类型
      Parameters:
      size - 初始容量
      Returns:
      HashMap
    • newLinkedHashMap

      public static <K,V> LinkedHashMap<K,V> newLinkedHashMap()
      创建 LinkedHashMap。
      Type Parameters:
      K - key 类型
      V - value 类型
      Returns:
      LinkedHashMap
    • newTreeMap

      public static <K,V> TreeMap<K,V> newTreeMap()
      创建 TreeMap。
      Type Parameters:
      K - key 类型
      V - value 类型
      Returns:
      TreeMap
    • newConcurrentHashMap

      public static <K,V> ConcurrentHashMap<K,V> newConcurrentHashMap()
      创建 ConcurrentHashMap。
      Type Parameters:
      K - key 类型
      V - value 类型
      Returns:
      ConcurrentHashMap
    • of

      public static <K,V> Map<K,V> of(Object... pairs)
      从成对参数构建 Map,如 of("a", 1, "b", 2)。
      Type Parameters:
      K - key 类型
      V - value 类型
      Parameters:
      pairs - key/value 成对参数
      Returns:
      HashMap
    • get

      public static <K,V> V get(Map<K,V> map, K key, V defaultValue)
      获取值,key 不存在时返回默认值。
      Type Parameters:
      K - key 类型
      V - value 类型
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      值或默认值
    • getStr

      public static String getStr(Map<?,?> map, Object key, String defaultValue)
      获取 String 值。
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      String 值或默认值
    • getStr

      public static String getStr(Map<?,?> map, Object key)
      获取 String 值(不存在时返回 null)。
      Parameters:
      map - Map
      key - key
      Returns:
      String 值或 null
    • getInt

      public static int getInt(Map<?,?> map, Object key, int defaultValue)
      获取 int 值。
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      int 值或默认值
    • getInt

      public static int getInt(Map<?,?> map, Object key)
      获取 int 值(缺失返回 0)。
      Parameters:
      map - Map
      key - key
      Returns:
      int 值或 0
    • getLong

      public static long getLong(Map<?,?> map, Object key, long defaultValue)
      获取 long 值。
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      long 值或默认值
    • getLong

      public static long getLong(Map<?,?> map, Object key)
      获取 long 值(缺失返回 0)。
      Parameters:
      map - Map
      key - key
      Returns:
      long 值或 0
    • getDouble

      public static double getDouble(Map<?,?> map, Object key, double defaultValue)
      获取 double 值。
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      double 值或默认值
    • getDouble

      public static double getDouble(Map<?,?> map, Object key)
      获取 double 值(缺失返回 0)。
      Parameters:
      map - Map
      key - key
      Returns:
      double 值或 0
    • getBool

      public static boolean getBool(Map<?,?> map, Object key, boolean defaultValue)
      获取 boolean 值。
      Parameters:
      map - Map
      key - key
      defaultValue - 默认值
      Returns:
      boolean 值或默认值
    • getBool

      public static boolean getBool(Map<?,?> map, Object key)
      获取 boolean 值(缺失返回 false)。
      Parameters:
      map - Map
      key - key
      Returns:
      boolean 值或 false
    • containsKey

      public static boolean containsKey(Map<?,?> map, Object key)
      Map 是否包含 key。
      Parameters:
      map - Map
      key - key
      Returns:
      是否包含
    • emptyIfNull

      public static <K,V> Map<K,V> emptyIfNull(Map<K,V> map)
      空 Map 返回空 Map。
      Type Parameters:
      K - key 类型
      V - value 类型
      Parameters:
      map - Map
      Returns:
      非空返回原 Map,否则返回空 Map
    • reverse

      public static <K,V> Map<V,K> reverse(Map<K,V> map)
      key/value 反转(值相同会互相覆盖)。
      Type Parameters:
      K - key 类型
      V - value 类型
      Parameters:
      map - 原 Map
      Returns:
      反转后的 LinkedHashMap
    • join

      public static String join(Map<?,?> map, CharSequence delimiter, CharSequence keyValueSeparator)
      拼接 Map 为字符串,如 a=1,b=2。
      Parameters:
      map - Map
      delimiter - 条目分隔符
      keyValueSeparator - key/value 分隔符
      Returns:
      拼接结果
    • sortByValue

      public static <K, V extends Comparable<? super V>> Map<K,V> sortByValue(Map<K,V> map, boolean isAscending)
      按值排序(值需可比),返回有序 LinkedHashMap。
      Type Parameters:
      K - 键类型
      V - 值类型(Comparable)
      Parameters:
      map - 原 Map
      isAscending - 是否升序
      Returns:
      排序后的新 Map
    • getBigDecimal

      public static BigDecimal getBigDecimal(Map<?,?> map, Object key)
      取 BigDecimal。
      Parameters:
      map - Map
      key - 键
      Returns:
      BigDecimal 值;缺失返回 null
    • getBigDecimal

      public static BigDecimal getBigDecimal(Map<?,?> map, Object key, BigDecimal defaultValue)
      取 BigDecimal(带默认值)。
      Parameters:
      map - Map
      key - 键
      defaultValue - 默认值
      Returns:
      BigDecimal 值
    • toProperties

      public static Properties toProperties(Map<?,?> map)
      Map 转 Properties(值经 String.valueOf 转换)。
      Parameters:
      map - Map
      Returns:
      Properties
    • sort

      public static <K extends Comparable<? super K>, V> Map<K,V> sort(Map<K,V> map, boolean isAscending)
      按 key 排序(key 需可比),返回 LinkedHashMap。
      Type Parameters:
      K - 键类型(Comparable)
      V - 值类型
      Parameters:
      map - 原 Map
      isAscending - 是否升序
      Returns:
      排序后新 Map
    • sortByKey

      public static <K extends Comparable<? super K>, V> Map<K,V> sortByKey(Map<K,V> map)
      按键升序排序 Map(便捷版,委托 sort(Map, boolean))。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map - 原 Map
      Returns:
      排序后新 Map
    • filter

      public static <K,V> Map<K,V> filter(Map<K,V> map, Predicate<Map.Entry<K,V>> predicate)
      按条件过滤 Map(不修改原 Map)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map - 原 Map
      predicate - 过滤条件
      Returns:
      过滤后新 Map
    • getDate

      public static Date getDate(Map<?,?> map, Object key)
      取 Date(支持时间戳与常见日期格式)。
      Parameters:
      map - Map
      key - 键
      Returns:
      Date 值;缺失或不可解析返回 null
    • getFloat

      public static float getFloat(Map<?,?> map, Object key, float defaultValue)
      取 float(含默认值)。
      Parameters:
      map - Map
      key - 键
      defaultValue - 默认值
      Returns:
      float
    • getChar

      public static char getChar(Map<?,?> map, Object key, char defaultValue)
      取 char(含默认值)。
      Parameters:
      map - Map
      key - 键
      defaultValue - 默认值
      Returns:
      char
    • getByte

      public static byte getByte(Map<?,?> map, Object key, byte defaultValue)
      取 byte(含默认值)。
      Parameters:
      map - Map
      key - 键
      defaultValue - 默认值
      Returns:
      byte
    • getShort

      public static short getShort(Map<?,?> map, Object key, short defaultValue)
      取 short(含默认值)。
      Parameters:
      map - Map
      key - 键
      defaultValue - 默认值
      Returns:
      short
    • builder

      public static <K,V> MapUtil.MapBuilder<K,V> builder()
      创建 Map 链式构建器(默认 LinkedHashMap 保持插入顺序)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Returns:
      MapBuilder
    • inverse

      public static <K,V> Map<V,K> inverse(Map<K,V> map)
      键值互换(适用于 BiMap 场景;重复值后者覆盖前者)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map - 原 Map
      Returns:
      互换后的新 Map
    • merge

      public static <K,V> Map<K,V> merge(Map<K,V> map1, Map<K,V> map2)
      合并两个 Map(后者覆盖前者同名键)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map1 - Map 一
      map2 - Map 二
      Returns:
      合并后的 Map(LinkedHashMap)
    • sortByValueDesc

      public static <K, V extends Comparable<? super V>> Map<K,V> sortByValueDesc(Map<K,V> map)
      按值降序排序(返回 LinkedHashMap 保持顺序)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map - 原 Map
      Returns:
      排序后的 Map
    • values

      public static <K,V> Collection<V> values(Map<K,V> map)
      获取 Map 的值集合(null 视为空集合)。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      map - 原 Map
      Returns:
      值集合;map 为 null 返回空集合
      Since:
      1.0.1
    • getBigInteger

      public static <K> BigInteger getBigInteger(Map<K,?> map, K key)
      从 Map 中取 BigInteger 类型的值。
      Type Parameters:
      K - 键类型
      Parameters:
      map - Map
      key - 键
      Returns:
      值;不存在或转换失败返回 null
      Since:
      1.0.1
    • getEnum

      public static <K, E extends Enum<E>> E getEnum(Map<K,?> map, K key, Class<E> type)
      从 Map 中取指定枚举类型的值。
      Type Parameters:
      K - 键类型
      E - 枚举类型
      Parameters:
      map - Map
      key - 键
      type - 枚举类型
      Returns:
      枚举值;不存在或转换失败返回 null
      Since:
      1.0.1
    • getLocalDate

      public static <K> LocalDate getLocalDate(Map<K,?> map, K key)
      从 Map 中取 LocalDate 类型的值。
      Type Parameters:
      K - 键类型
      Parameters:
      map - Map
      key - 键
      Returns:
      日期值;不存在或转换失败返回 null
      Since:
      1.0.1
    • getLocalDateTime

      public static <K> LocalDateTime getLocalDateTime(Map<K,?> map, K key)
      从 Map 中取 LocalDateTime 类型的值。
      Type Parameters:
      K - 键类型
      Parameters:
      map - Map
      key - 键
      Returns:
      日期时间值;不存在或转换失败返回 null
      Since:
      1.0.1
    • toMap

      public static <T,K,V> Map<K,V> toMap(Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper)
      可迭代对象转 Map(Guava uniqueIndex 语义):重复键抛 IllegalArgumentException。
      Type Parameters:
      T - 元素类型
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 数据源(null 返回空 Map)
      keyMapper - 键映射(null 时抛 NullPointerException)
      valueMapper - 值映射(null 时抛 NullPointerException)
      Returns:
      转换结果(LinkedHashMap 保序)
      Since:
      1.16.0
    • toMap

      public static <T,K,V> Map<K,V> toMap(Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper, BinaryOperator<V> merge)
      可迭代对象转 Map(带冲突合并策略):重复键按 merge 合并。
      Type Parameters:
      T - 元素类型
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 数据源(null 返回空 Map)
      keyMapper - 键映射(null 时抛 NullPointerException)
      valueMapper - 值映射(null 时抛 NullPointerException)
      merge - 冲突合并函数(null 时重复键取后者)
      Returns:
      转换结果(LinkedHashMap 保序)
      Since:
      1.16.0
    • difference

      public static <K,V> Difference<K,V> difference(Map<K,V> left, Map<K,V> right)
      两个 Map 的差异分析:只在左 / 只在右 / 共有但值不同。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      left - 左 Map(null 按空处理)
      right - 右 Map(null 按空处理)
      Returns:
      差异结果 Difference
      Since:
      1.16.0
    • mergeAll

      public static <K,V> Map<K,V> mergeAll(Map<K,V> target, Map<K,V> source, BinaryOperator<V> merge)
      合并源 Map 到目标 Map(带冲突合并策略);源与目标为同一对象时安全。
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      target - 目标 Map(null 时不操作,返回 null)
      source - 源 Map(null 时不操作)
      merge - 冲突合并函数(null 时目标值覆盖源值)
      Returns:
      操作后的目标 Map
      Since:
      1.16.0
    • transformValues

      public static <K,V,R> Map<K,R> transformValues(Map<K,V> map, Function<V,R> mapper)
      值变换(对齐 Guava Maps.transformValues)。

      保留键集合,仅变换值;返回新 HashMap(可变)。

      Type Parameters:
      K - 键类型
      V - 原值类型
      R - 新值类型
      Parameters:
      map - 原映射,可为 null
      mapper - 值变换函数
      Returns:
      变换后的 Map;null 输入返回空 Map
      Since:
      1.19.0
    • transformEntries

      public static <K,V,R> Map<K,R> transformEntries(Map<K,V> map, BiFunction<K,V,R> mapper)
      键值联合变换(对齐 Guava Maps.transformEntries)。
      Type Parameters:
      K - 键类型
      V - 原值类型
      R - 新值类型
      Parameters:
      map - 原映射,可为 null
      mapper - 键值变换函数((K, V) -> R)
      Returns:
      变换后的 Map;null 输入返回空 Map
      Since:
      1.19.0
    • uniqueIndex

      public static <K,V> Map<K,V> uniqueIndex(Iterable<V> values, Function<V,K> keyMapper)
      唯一索引(对齐 Guava Maps.uniqueIndex)。

      将可迭代对象按键提取器建立映射;出现重复键抛 IllegalArgumentException。 原顺序保留(LinkedHashMap)。

      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      values - 待索引对象,可为 null
      keyMapper - 键提取器
      Returns:
      唯一索引 Map;null 输入返回空 Map
      Throws:
      IllegalArgumentException - 存在重复键
      Since:
      1.19.0
    • asMap

      public static <K,V> Map<K,V> asMap(Set<K> set, Function<K,V> mapper)
      集合→映射视图(对齐 Guava Maps.asMap)。

      对集合中每个元素应用函数生成值;返回新 HashMap(可变)。

      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      set - 键集合,可为 null
      mapper - 值生成函数
      Returns:
      映射 Map;null 输入返回空 Map
      Since:
      1.19.0