com.dahuatech.hutool.core.lang.Dict Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.core.lang;

import com.dahuatech.hutool.core.bean.BeanUtil;
import com.dahuatech.hutool.core.collection.CollectionUtil;
import com.dahuatech.hutool.core.convert.Convert;
import com.dahuatech.hutool.core.getter.BasicTypeGetter;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.sql.Time;
import java.sql.Timestamp;
import java.util.*;

/**
 * 字典对象，扩充了HashMap中的方法
 *
 * @author loolly
 */
public class Dict extends LinkedHashMap implements BasicTypeGetter {
  static final float DEFAULT_LOAD_FACTOR = 0.75f;
  static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
  private static final long serialVersionUID = 6135423866861206530L;
  /** 是否大小写不敏感 */
  private boolean caseInsensitive;

  // --------------------------------------------------------------- Static method start
  /** 构造 */
  public Dict() {
    this(false);
  }

  /**
   * 构造
   *
   * @param caseInsensitive 是否大小写不敏感
   */
  public Dict(boolean caseInsensitive) {
    this(DEFAULT_INITIAL_CAPACITY, caseInsensitive);
  }
  // --------------------------------------------------------------- Static method end

  // --------------------------------------------------------------- Constructor start
  /**
   * 构造
   *
   * @param initialCapacity 初始容量
   */
  public Dict(int initialCapacity) {
    this(initialCapacity, false);
  }

  /**
   * 构造
   *
   * @param initialCapacity 初始容量
   * @param caseInsensitive 是否大小写不敏感
   */
  public Dict(int initialCapacity, boolean caseInsensitive) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR, caseInsensitive);
  }

  /**
   * 构造
   *
   * @param initialCapacity 初始容量
   * @param loadFactor 容量增长因子，0~1，即达到容量的百分之多少时扩容
   */
  public Dict(int initialCapacity, float loadFactor) {
    this(initialCapacity, loadFactor, false);
  }

  /**
   * 构造
   *
   * @param initialCapacity 初始容量
   * @param loadFactor 容量增长因子，0~1，即达到容量的百分之多少时扩容
   * @param caseInsensitive 是否大小写不敏感
   * @since 4.5.16
   */
  public Dict(int initialCapacity, float loadFactor, boolean caseInsensitive) {
    super(initialCapacity, loadFactor);
    this.caseInsensitive = caseInsensitive;
  }

  /**
   * 构造
   *
   * @param m Map
   */
  public Dict(Map m) {
    super((null == m) ? new HashMap() : m);
  }

  /**
   * 创建Dict
   *
   * @return Dict
   */
  public static Dict create() {
    return new Dict();
  }

  /**
   * 将PO对象转为Dict
   *
   * @param  Bean类型
   * @param bean Bean对象
   * @return Vo
   */
  public static  Dict parse(T bean) {
    return create().parseBean(bean);
  }
  // --------------------------------------------------------------- Constructor end

  /**
   * 转换为Bean对象
   *
   * @param  Bean类型
   * @param bean Bean
   * @return Bean
   */
  public  T toBean(T bean) {
    return toBean(bean, false);
  }

  /**
   * 转换为Bean对象
   *
   * @param  Bean类型
   * @param bean Bean
   * @return Bean
   * @since 3.3.1
   */
  public  T toBeanIgnoreCase(T bean) {
    BeanUtil.fillBeanWithMapIgnoreCase(this, bean, false);
    return bean;
  }

  /**
   * 转换为Bean对象
   *
   * @param  Bean类型
   * @param bean Bean
   * @param isToCamelCase 是否转换为驼峰模式
   * @return Bean
   */
  public  T toBean(T bean, boolean isToCamelCase) {
    BeanUtil.fillBeanWithMap(this, bean, isToCamelCase, false);
    return bean;
  }

  /**
   * 转换为Bean对象,并使用驼峰法模式转换
   *
   * @param  Bean类型
   * @param bean Bean
   * @return Bean
   */
  public  T toBeanWithCamelCase(T bean) {
    BeanUtil.fillBeanWithMap(this, bean, true, false);
    return bean;
  }

  /**
   * 填充Value Object对象
   *
   * @param  Bean类型
   * @param clazz Value Object（或者POJO）的类
   * @return vo
   */
  public  T toBean(Class clazz) {
    return BeanUtil.mapToBean(this, clazz, false);
  }

  /**
   * 填充Value Object对象，忽略大小写
   *
   * @param  Bean类型
   * @param clazz Value Object（或者POJO）的类
   * @return vo
   */
  public  T toBeanIgnoreCase(Class clazz) {
    return BeanUtil.mapToBeanIgnoreCase(this, clazz, false);
  }

  /**
   * 将值对象转换为Dict

   * 类名会被当作表名，小写第一个字母
   *
   * @param  Bean类型
   * @param bean 值对象
   * @return 自己
   */
  public  Dict parseBean(T bean) {
    Assert.notNull(bean, "Bean class must be not null");
    this.putAll(BeanUtil.beanToMap(bean));
    return this;
  }

  /**
   * 将值对象转换为Dict

   * 类名会被当作表名，小写第一个字母
   *
   * @param  Bean类型
   * @param bean 值对象
   * @param isToUnderlineCase 是否转换为下划线模式
   * @param ignoreNullValue 是否忽略值为空的字段
   * @return 自己
   */
  public  Dict parseBean(T bean, boolean isToUnderlineCase, boolean ignoreNullValue) {
    Assert.notNull(bean, "Bean class must be not null");
    this.putAll(BeanUtil.beanToMap(bean, isToUnderlineCase, ignoreNullValue));
    return this;
  }

  /**
   * 与给定实体对比并去除相同的部分

   * 此方法用于在更新操作时避免所有字段被更新，跳过不需要更新的字段 version from 2.0.0
   *
   * @param  字典对象类型
   * @param dict 字典对象
   * @param withoutNames 不需要去除的字段名
   */
  public  void removeEqual(T dict, String... withoutNames) {
    HashSet withoutSet = CollectionUtil.newHashSet(withoutNames);
    for (Map.Entry entry : dict.entrySet()) {
      if (withoutSet.contains(entry.getKey())) {
        continue;
      }

      final Object value = this.get(entry.getKey());
      if (null != value && value.equals(entry.getValue())) {
        this.remove(entry.getKey());
      }
    }
  }

  /**
   * 过滤Map保留指定键值对，如果键不存在跳过
   *
   * @param keys 键列表
   * @return Dict 结果
   * @since 4.0.10
   */
  public Dict filter(String... keys) {
    final Dict result = new Dict(keys.length, 1);

    for (String key : keys) {
      if (this.containsKey(key)) {
        result.put(key, this.get(key));
      }
    }
    return result;
  }

  // -------------------------------------------------------------------- Set start
  /**
   * 设置列
   *
   * @param attr 属性
   * @param value 值
   * @return 本身
   */
  public Dict set(String attr, Object value) {
    this.put(attr, value);
    return this;
  }

  /**
   * 设置列，当键或值为null时忽略
   *
   * @param attr 属性
   * @param value 值
   * @return 本身
   */
  public Dict setIgnoreNull(String attr, Object value) {
    if (null != attr && null != value) {
      set(attr, value);
    }
    return this;
  }
  // -------------------------------------------------------------------- Set end

  // -------------------------------------------------------------------- Get start

  @Override
  public Object getObj(String key) {
    return super.get(key);
  }

  /**
   * 获得特定类型值
   *
   * @param  值类型
   * @param attr 字段名
   * @return 字段值
   * @since 4.6.3
   */
  public  T getBean(String attr) {
    return get(attr, null);
  }

  /**
   * 获得特定类型值
   *
   * @param  值类型
   * @param attr 字段名
   * @param defaultValue 默认值
   * @return 字段值
   */
  @SuppressWarnings("unchecked")
  public  T get(String attr, T defaultValue) {
    final Object result = get(attr);
    return (T) (result != null ? result : defaultValue);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public String getStr(String attr) {
    return Convert.toStr(get(attr), null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public Integer getInt(String attr) {
    return Convert.toInt(get(attr), null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public Long getLong(String attr) {
    return Convert.toLong(get(attr), null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public Float getFloat(String attr) {
    return Convert.toFloat(get(attr), null);
  }

  @Override
  public Short getShort(String attr) {
    return Convert.toShort(get(attr), null);
  }

  @Override
  public Character getChar(String attr) {
    return Convert.toChar(get(attr), null);
  }

  @Override
  public Double getDouble(String attr) {
    return Convert.toDouble(get(attr), null);
  }

  @Override
  public Byte getByte(String attr) {
    return Convert.toByte(get(attr), null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public Boolean getBool(String attr) {
    return Convert.toBool(get(attr), null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public BigDecimal getBigDecimal(String attr) {
    return Convert.toBigDecimal(get(attr));
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  @Override
  public BigInteger getBigInteger(String attr) {
    return Convert.toBigInteger(get(attr));
  }

  @Override
  public > E getEnum(Class clazz, String key) {
    return Convert.toEnum(clazz, get(key));
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  public byte[] getBytes(String attr) {
    return get(attr, null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  public Date getDate(String attr) {
    return get(attr, null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  public Time getTime(String attr) {
    return get(attr, null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  public Timestamp getTimestamp(String attr) {
    return get(attr, null);
  }

  /**
   * @param attr 字段名
   * @return 字段值
   */
  public Number getNumber(String attr) {
    return get(attr, null);
  }
  // -------------------------------------------------------------------- Get end

  @Override
  public Object put(String key, Object value) {
    return super.put(customKey(key), value);
  }

  @Override
  public Dict clone() {
    return (Dict) super.clone();
  }

  /**
   * 将Key转为小写
   *
   * @param key KEY
   * @return 小写KEY
   */
  private String customKey(String key) {
    if (this.caseInsensitive && null != key) {
      key = key.toLowerCase();
    }
    return key;
  }
}