package com.gitegg.platform.base.annotation.dict;

import java.lang.annotation.*;

/**
 * 數(shù)據(jù)字典注解，注解在方法上，自動設(shè)置返回參數(shù)的字典數(shù)據(jù)
 * 1、可以注解在 service和 controller上，只注解返回值，支持引用類型和常用的集合類型
 * 2、具體的實體類中，如果是引用類型，那么遞歸賦值
 * 3、支持的集合類型：List Set Queue ，引用類型：Array一維數(shù)組，普通對象類型（自定義實體bean）。
 * @author GitEgg
 */
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DictAuto {
}

package com.gitegg.platform.base.annotation.dict;

import java.lang.annotation.*;

/**
 * 數(shù)據(jù)字典注解，注解在字段上
 * 如果dictCode為空，且此字段是對象類型，那么表示此字段對象中擁有字典類型，
 * 也就是只有注解了此字段的數(shù)據(jù)才會去遞歸設(shè)置字典值，不去隨便做無所謂的遍歷
 *
 * @author GitEgg
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DictField {

    /**
     * 數(shù)據(jù)字典類型 ：系統(tǒng)字典 system 業(yè)務(wù)字典 business  地區(qū)字典 areas  其他字典：直接表名,例： t_sys_role
     * 1、確定選擇哪種類型的數(shù)據(jù)字典
     */
    String dictType() default "business";
    
    /**
     * 數(shù)據(jù)字典編碼，就是取哪些數(shù)據(jù)字典的值
     * 2、確定需要匹配數(shù)據(jù)字典的集合
     */
    String dictCode() default "";

    /**
     * 要最終轉(zhuǎn)換最終數(shù)據(jù)字典的鍵，是實體類中的一個字段，通常配置為此字段的定義名稱，通過此字段作為key來轉(zhuǎn)換數(shù)據(jù)字典的值
     * 3、確定需要把實體中哪個字段轉(zhuǎn)換為字典值
     */
    String dictKey() default "";

    /**
     * 如果是自定義表數(shù)據(jù)時，此字段作為字典code，對應(yīng)數(shù)據(jù)表的字段
     * 4、表中作為數(shù)據(jù)字典的鍵
     */
    String dictFiled() default "";

    /**
     * 如果是自定義表數(shù)據(jù)時，此字段作為字典value，對應(yīng)數(shù)據(jù)表的字段
     * 5、表中作為數(shù)據(jù)字典的值
     */
    String dictValue() default "";
}

package com.gitegg.platform.boot.aspect;

import cn.hutool.core.util.ArrayUtil;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.gitegg.platform.base.annotation.dict.DictAuto;
import com.gitegg.platform.base.annotation.dict.DictField;
import com.gitegg.platform.base.constant.DictConstant;
import com.gitegg.platform.base.constant.GitEggConstant;
import com.gitegg.platform.base.result.Result;
import com.gitegg.platform.boot.util.GitEggAuthUtils;
import com.gitegg.platform.redis.lock.IDistributedLockService;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import jodd.util.StringPool;
import lombok.RequiredArgsConstructor;
import lombok.extern.log4j.Log4j2;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.lang.NonNull;
import org.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.math.BigDecimal;
import java.util.*;
import java.util.function.Consumer;


/**
 * 數(shù)據(jù)字典切面
 * @author GitEgg
 * @date 2022-4-10
 */
@Log4j2
@Component
@Aspect
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@ConditionalOnProperty(name = "enabled", prefix = "dict", havingValue = "true", matchIfMissing = true)
public class DictAspect {
    
    /**
     * 是否開啟租戶模式
     */
    @Value("${tenant.enable}")
    private Boolean enable;
    
    private final RedisTemplate redisTemplate;
    
    /**
     * 后置通知 解析返回參數(shù)，進行字典設(shè)置
     * @AfterReturning 只有存在返回值時才會執(zhí)行 @After 無論有沒有返回值都會執(zhí)行  所以這里使用 @AfterReturning 只有存在返回值時才執(zhí)行字典值注入操作
     * @param dictAuto 注解配置
     */
    @AfterReturning(pointcut = "@annotation(dictAuto)", returning = "returnObj")
    public void doAfterReturning( DictAuto dictAuto, Object returnObj){
        // 返回不為null時，進行數(shù)據(jù)字典處理
        if (null != returnObj) {
            doDictAuto(dictAuto, returnObj);
        }
    }

    /**
     * key的組成為: dict:userId:sessionId:uri:method:(根據(jù)spring EL表達式對參數(shù)進行拼接)
     * 此處要考慮多種返回類型，集合類型、引用類型、對象類型和基本數(shù)據(jù)類型，這里只處理 集合類型：List Set Queue ，引用類型：Array數(shù)組，Array只支持一維數(shù)組。
     * 對于對象中的子對象，為了提升性能，同樣需要加@DictField注解才去填充，否則每個子對象都去遞歸判斷，影響性能
     * 我們要考慮此處的邏輯：
     * 1、判斷返回數(shù)據(jù)類型，如果是集合類型，那么取出包含實體對象的集合類，然后進行對象解析
     * 2、如果是對象類型，那么直接進行對象解析
     * 3、如果是IPage類型，那么取出其中的list數(shù)據(jù)，判斷是否為空，不為空，執(zhí)行 1 步驟
     * 4、如果是Result類型，判斷Result的data是IPage還是集合類型，分別執(zhí)行對應(yīng)的 1 步驟 或 3 步驟，如果不是IPage也不是集合類型，直接執(zhí)行第 2 步驟
     * @param dictAuto 注解
     * @param objectReturn 方法返回值
     */
    private void doDictAuto(@NonNull DictAuto dictAuto, Object objectReturn) {
       // 臨時存儲數(shù)據(jù)字典map
       Map<String, Map<Object, Object>> dictMap = new HashMap<>();
       this.translationObjectDict(objectReturn, dictMap);
    }
    
    /**
     * 找到實際的對象或?qū)ο罅斜?/span>
     * 此處要考慮多種返回類型，集合類型、引用類型、對象類型和基本數(shù)據(jù)類型，這里只處理 集合類型：List Set Queue ，引用類型：Array一維數(shù)組。
     * @param objectReturn
     * @param dictMap
     * @return
     */
    private void translationObjectDict(Object objectReturn, Map<String, Map<Object, Object>> dictMap) {
        if (Objects.isNull(objectReturn))
        {
            return;
        }
        // 判斷返回值類型是Result、IPage、List、Object
        if (objectReturn instanceof Result) {
            Object objectTarget = ((Result) objectReturn).getData();
            translationObjectDict(objectTarget, dictMap);
        } else if (objectReturn instanceof IPage) {
            List<Object> objectTargetList = ((IPage) objectReturn).getRecords();
            translationObjectDict(objectTargetList, dictMap);
        } else if (objectReturn instanceof Collection) {
            ((Collection) objectReturn).forEach(object-> translationObjectDict(object, dictMap));
        } else if (ArrayUtil.isArray(objectReturn)) {
            // 數(shù)組這里需要處理
            ((Collection) objectReturn).forEach(object-> translationObjectDict(object, dictMap));
        } else {
            parseObjectFieldCodeValue(objectReturn, dictMap);
        }
    }
    
    /**
     * 取出對象中需要進行字典轉(zhuǎn)換的字段
     *
     * @param targetObj   : 取字段的對象
     * @param dictMap     : 存儲數(shù)據(jù)字典
     * @author liam
     */
    private void parseObjectFieldCodeValue(Object targetObj, Map<String, Map<Object, Object>> dictMap) {
        if (Objects.isNull(targetObj))
        {
            return;
        }
        // 獲取當(dāng)前對象所有的field
        Field[] declaredFields = targetObj.getClass().getDeclaredFields();
        // 構(gòu)造填充映射關(guān)系
        Arrays.stream(declaredFields).forEach(field ->
            // 遞歸處理
            parseFieldObjDict(field, targetObj,
                    fieldObj -> parseObjectFieldCodeValue(fieldObj, dictMap),
                    // 解析注解字段信息
                    () -> parseDictAnnotation(targetObj, field, dictMap)
            )
        );
    }
    
    /**
     * 解析field對象，對基本數(shù)據(jù)類型和復(fù)雜類型直接根據(jù)注解賦值，對于對象或集合類型，繼續(xù)進行遞歸遍歷
     *
     * @param field          : 字段對象
     * @param obj            : 字段所屬的obj對象
     * @param recursiveFunc  : 遞歸處理方法
     * @author liam
     */
    private static void parseFieldObjDict(Field field, Object obj, Consumer<Object> recursiveFunc,
                                          NestedFunction parseAnnotationFunc) {
        Class cls = field.getType();
        // 不處理map數(shù)據(jù)
        if (Map.class.isAssignableFrom(cls)) {
            return;
        }
        // 需要數(shù)據(jù)字典轉(zhuǎn)換的屬性：有Dict注解， @DictField只注解在普通字段上，不要注解到復(fù)雜對象上
        if (field.isAnnotationPresent(DictField.class)) {
            // 分析注解并轉(zhuǎn)換數(shù)據(jù)字典值
            parseAnnotationFunc.run();
        }
        // 沒有注解的屬性判斷
        else {
            try {
                // 獲取字段值且非空處理
                field.setAccessible(true);
                Optional.ofNullable(field.get(obj)).ifPresent(fieldValue -> {
                            // 集合類型，如果泛型的類型是JavaBean，繼續(xù)遞歸處理
                            if (Collection.class.isAssignableFrom(cls)) {
                                // 如果是list-map結(jié)果，則這里返回null
                                Class generic = getGeneric(obj.getClass(), field.getName());
                                if (null != generic && notInFilterClass(generic)) {
                                    // 循環(huán)遞歸處理
                                    ((Collection) fieldValue).forEach(recursiveFunc::accept);
                                }
                            }
                            // 非基本數(shù)據(jù)類型
                            else if (notInFilterClass(cls)) {
                                recursiveFunc.accept(fieldValue);
                            }
                        }
                );
            } catch (Exception e) {
                log.error(e.getMessage(), e);
            }
        }
    }
    
    /**
     * 獲取一個類的屬性的泛型；如果沒有泛型，則返回null；
     * P.s 如果有多個，取第一個；如果有多層泛型，也返回null，比如List<Map>
     *
     * @param cls      :
     * @param property : 屬性名
     * @author liam
     */
    public static Class getGeneric(Class cls, String property) {
        try {
            Type genericType = cls.getDeclaredField(property).getGenericType();
            // 如果是泛型參數(shù)的類型
            if (null != genericType && genericType instanceof ParameterizedType) {
                ParameterizedType pt = (ParameterizedType) genericType;
                Type type = pt.getActualTypeArguments()[GitEggConstant.Number.ZERO];
                // 這里，type也可能是 ParameterizedType， 直接不考慮
                if (type instanceof Class) {
                    return (Class) type;
                }
            }
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return null;
    }
    
    /**
     * 解析含有注解@DictField并賦值
     *
     * @param obj         : 對象
     * @param field       : 字段
     * @param dictMap     : 數(shù)據(jù)字典
     * @author liam
     */
    private void parseDictAnnotation(Object obj, Field field, Map<String, Map<Object, Object>> dictMap) {
        // 讀取注解信息，獲取編碼類型
        DictField dictField = field.getAnnotation(DictField.class);
        String fieldName = field.getName();
        // 根據(jù)Dict的codeName屬性或者字段名稱，獲取字典編碼code
        String code = getFieldValue(obj, dictField, fieldName);
        if (!Strings.isNullOrEmpty(code)) {
            String dictType = dictField.dictType();
            String dictCode = dictField.dictCode();
            String dictKey = dictType + StringPool.COLON + dictCode;
            // 首先判斷是否開啟多租戶
            String redisDictKey = DictConstant.DICT_TENANT_MAP_PREFIX;
    
            if (enable) {
                redisDictKey += GitEggAuthUtils.getTenantId() + StringPool.COLON + dictKey;
            } else {
                redisDictKey = DictConstant.DICT_MAP_PREFIX + dictKey;
            }
            
            Map<Object, Object> dictKeyValue = dictMap.get(redisDictKey);
            // 首先從dictMap中獲取值，如果沒有，再從Redis數(shù)據(jù)庫中獲取值
            if (null == dictKeyValue) {
                // 從Redis數(shù)據(jù)庫獲取值
                Map<Object, Object> dictCodeMap = redisTemplate.opsForHash().entries(redisDictKey);
                dictMap.put(redisDictKey, dictCodeMap);
            }
            if (null != dictKeyValue.get(code))
            {
                try {
                    // 給Field賦值最終的數(shù)據(jù)字典
                    field.setAccessible(true);
                    field.set(obj, dictKeyValue.get(code));
                } catch (Exception e) {
                    log.error(e.getMessage(), e);
                }
            }
        }
    }
    
    /**
     * 根據(jù)Dict的codeName屬性或者字段名稱，獲取字段值
     * 注意：如果當(dāng)前字段沒有以Name結(jié)尾，那就取當(dāng)前字段的值；也就是根據(jù)當(dāng)前字段的值轉(zhuǎn)換。
     *
     * @param obj            : 對象
     * @param dictField      : 字段注解對象
     * @param fieldName      : 字段名稱
     * @return java.lang.String
     * @author liam
     */
    private String getFieldValue(Object obj, DictField dictField, String fieldName) {
        String codeName = dictField.dictKey();
        if (Strings.isNullOrEmpty(codeName)) {
            // 如果當(dāng)前字段是Name結(jié)尾，進行截取；否則取當(dāng)前字段名稱
            int endNameIndex = fieldName.lastIndexOf(DictConstant.NAME_SUFFIX);
            if (endNameIndex != -1) {
                codeName = fieldName.substring(0, endNameIndex);
            } else {
                codeName = fieldName;
            }
        }
        return getPropertyValue(obj, codeName);
    }
    
    /**
     * 獲取對象里指定屬性的值，并轉(zhuǎn)化為字符串
     *
     * @param obj          : 對象
     * @param propertyName : 對象里面的屬性名稱
     * @author liam
     */
    private String getPropertyValue(Object obj, String propertyName) {
        BeanWrapperImpl beanWrapper = new BeanWrapperImpl(obj);
        if (beanWrapper.isReadableProperty(propertyName)) {
            Object propertyValue = beanWrapper.getPropertyValue(propertyName);
            if (null != propertyValue) {
                return propertyValue.toString();
            }
        }
        return "";
    }
    
    /**
     * 判斷不在過濾類(常用基本數(shù)據(jù)類型)中
     */
    private static boolean notInFilterClass(Class cls) {
        return !DictConstant.baseTypeList.contains(cls);
    }
    
    /**
     * 函數(shù)式接口：類似freemarker中的<#nested>處理
     */
    @FunctionalInterface
    public interface NestedFunction {
        /**
         * 無參無返回值的方法運行
         */
        void run();
    }

}

import { getAuthCache, setAuthCache } from '/@/utils/auth';
import { DICT_SYSTEM_CACHE_KEY, DICT_BUSSINESS_CACHE_KEY } from '/@/enums/cacheEnum';
import { listDict, batchListDict } from '/@/api/system/base/dict';
import { listDictBusiness, batchListDictBusiness } from '/@/api/system/base/dictBusiness';

// System default cache time
export const DICT_CACHE_TIME = 60 * 60 * 2 * 1000;

// Dict
export interface Dict {
  // dictCode
  dictCode: string;
  // dictList
  dictList?: [];
  // filterMap
  filterMap?: {};
}

// DictMap
export interface DictMap {
  // dictList
  dictMap: {};
}

export function getDictCacheOnly(dict: Dict) {
  let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
  if (!dictMap) {
    dictMap = {};
  }
  if (dictMap[dict.dictCode]) {
    return dictMap[dict.dictCode] as Dict;
  } else {
    getDict(dict).then(function (dictReturn) {
      dictMap[dict.dictCode] = dictReturn;
      // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
      setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
    });
    return dict;
  }
}

export function getDictBusinessCacheOnly(dict: Dict) {
  let dictBusinessMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
  if (!dictBusinessMap) {
    dictBusinessMap = {};
  }
  if (dictBusinessMap[dict.dictCode]) {
    return dictBusinessMap[dict.dictCode] as Dict;
  } else {
    getDictBusiness(dict).then(function (dictReturn) {
      dictBusinessMap[dict.dictCode] = dictReturn;
      // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
      setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictBusinessMap);
    });
    return dict;
  }
}

export async function getDictCache(dict: Dict) {
  let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
  if (!dictMap) {
    dictMap = {};
  }
  if (dictMap[dict.dictCode]) {
    return dictMap[dict.dictCode] as Dict;
  } else {
    const dictReturn = await getDict(dict);
    dictMap[dict.dictCode] = dictReturn;
    // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
    setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
    return dictReturn;
  }
}

export async function getDictBusinessCache(dict: Dict) {
  let dictBusinessMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
  if (!dictBusinessMap) {
    dictBusinessMap = {};
  }
  if (dictBusinessMap[dict.dictCode]) {
    return dictBusinessMap[dict.dictCode] as Dict;
  } else {
    const dictReturn = await getDictBusiness(dict);
    dictBusinessMap[dict.dictCode] = dictReturn;
    // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
    setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictBusinessMap);
    return dictReturn;
  }
}

// 批量初始化系統(tǒng)字典
export async function initDictCache(dictCodeList: string[]) {
  let dictMap = getAuthCache(DICT_SYSTEM_CACHE_KEY) as any;
  if (!dictMap) {
    dictMap = {};
  }
  const dictResultMap = await batchListDict(dictCodeList);
  if (dictResultMap) {
    dictCodeList.forEach(function (dictCode) {
      if (dictResultMap[dictCode]) {
        const dict = {} as Dict;
        dict.dictList = dictResultMap[dictCode];
        dict.filterMap = {};
        dict.dictList.forEach((item) => {
          const itemDict = item as any;
          dict.filterMap[itemDict.dictCode] = itemDict.dictName;
        });
        dictMap[dictCode] = dict;
      }
    });
    // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
    setAuthCache(DICT_SYSTEM_CACHE_KEY, dictMap);
  }
}

// 批量初始化業(yè)務(wù)字典
export async function initDictBusinessCache(dictCodeList: string[]) {
  let dictMap = getAuthCache(DICT_BUSSINESS_CACHE_KEY) as any;
  if (!dictMap) {
    dictMap = {};
  }
  const dictResultMap = await batchListDictBusiness(dictCodeList);
  if (dictResultMap) {
    dictCodeList.forEach(function (dictCode) {
      if (dictResultMap[dictCode]) {
        const dict = {} as Dict;
        dict.dictList = dictResultMap[dictCode];
        dict.filterMap = {};
        dict.dictList.forEach((item) => {
          const itemDict = item as any;
          dict.filterMap[itemDict.dictCode] = itemDict.dictName;
        });
        dictMap[dictCode] = dict;
      }
    });
    // 數(shù)據(jù)字典默認緩存2小時，重新登陸后失效
    setAuthCache(DICT_BUSSINESS_CACHE_KEY, dictMap);
  }
}

export async function getDict(dict: Dict) {
  const dictList = await listDict(dict.dictCode);
  if (dictList && dictList.length > 0) {
    dict.dictList = dictList;
    dict.filterMap = {};
    dictList.forEach((item) => {
      dict.filterMap[item.dictCode] = item.dictName;
    });
  }
  return dict;
}

export async function getDictBusiness(dict: Dict) {
  const dictBusinessList = await listDictBusiness(dict.dictCode);
  if (dictBusinessList && dictBusinessList.length > 0) {
    dict.dictList = dictBusinessList;
    dict.filterMap = {};
    dictBusinessList.forEach((item) => {
      dict.filterMap[item.dictCode] = item.dictName;
    });
  }
  return dict;
}

// 重新初始化系統(tǒng)數(shù)據(jù)字典
      setAuthCache(DICT_SYSTEM_CACHE_KEY, {});
      // 重新初始化業(yè)務(wù)數(shù)據(jù)字典
      setAuthCache(DICT_BUSSINESS_CACHE_KEY, {});

import { getDictBusinessCache } from '/@/utils/gitegg/dictUtils';
......
  {
    label: '狀態(tài)',
    field: 'status',
    component: 'ApiRadioGroup',
    required: true,
    defaultValue: '2',
    componentProps: {
      api: getDictBusinessCache,
      params: { dictCode: 'USER_STATUS' },
      resultField: 'dictList',
      // use name as label
      labelField: 'dictName',
      // use id as value
      valueField: 'dictCode',
    },
  },
......