爱威尔-jeecgboot字典aop DictAspect处理Result 的IPage的分页列表数据进行动态字典注入和list集合带树结构数据的动态字典注入

官网的字典注入只处理了Result 的IPage的分页列表数据进行动态字典注入，本代码加入了对list集合而且携带tree树结构数据的动态字典注入，这样一来不但可以处理IPage的分页列表数据，还可以处理list列表数据和树结构数据。
![](/view/131/20220209192852_701.png)
比如这样的树结构数据
直接上代码，大家细品，不知道为什么jeecg他们官网没想到这种需求：
    package org.jeecg.common.aspect;
    
    import com.alibaba.fastjson.JSONArray;
    import com.alibaba.fastjson.JSONObject;
    import com.baomidou.mybatisplus.core.metadata.IPage;
    import com.fasterxml.jackson.annotation.JsonFormat;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.jeecg.common.api.CommonAPI;
    import org.jeecg.common.api.vo.Result;
    import org.jeecg.common.aspect.annotation.Dict;
    import org.jeecg.common.constant.CommonConstant;
    import org.jeecg.common.system.vo.DictModel;
    import org.jeecg.common.util.oConvertUtils;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    
    import java.lang.reflect.Field;
    import java.text.SimpleDateFormat;
    import java.util.*;
    import java.util.concurrent.TimeUnit;
    import java.util.stream.Collectors;
    
    /**
     * @Description: 字典aop类
     * @Author: dangzhenghui
     * @Date: 2019-3-17 21:50
     * @Version: 1.0
     */
    @Aspect
    @Component
    @Slf4j
    public class DictAspect {
    
    	@Autowired
    	private CommonAPI commonAPI;
    	@Autowired
    	public RedisTemplate redisTemplate;
    
    	// 定义切点Pointcut
    	@Pointcut("execution(public * org.jeecg.modules..*.*Controller.*(..)) || execution(public * com.yunbang.erp..*.*Controller.*(..))")
    	public void excudeService() {
    	}
    
    	@Around("excudeService()")
    	public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    		long time1 = System.currentTimeMillis();
    		Object result = pjp.proceed();
    		long time2 = System.currentTimeMillis();
    		log.debug("获取JSON数据 耗时：" + (time2 - time1) + "ms");
    		long start = System.currentTimeMillis();
    		this.parseDictText(result);
    		long end = System.currentTimeMillis();
    		log.debug("注入字典到JSON数据  耗时" + (end - start) + "ms");
    		return result;
    	}
    
    	/**
    	 * 本方法针对返回对象为Result 的IPage的分页列表数据进行动态字典注入 字典注入实现 通过对实体类添加注解@dict
    	 * 来标识需要的字典内容,字典分为单字典code即可 ，table字典 code table text配合使用与原来jeecg的用法相同 示例为SysUser
    	 * 字段为sex 添加了注解@Dict(dicCode = "sex") 会在字典服务立马查出来对应的text
    	 * 然后在请求list的时候将这个字典text，已字段名称加_dictText形式返回到前端 例输入当前返回值的就会多出一个sex_dictText字段 {
    	 * sex:1, sex_dictText:"男" } 前端直接取值sext_dictText在table里面无需再进行前端的字典转换了
    	 * customRender:function (text) { if(text==1){ return "男"; }else if(text==2){
    	 * return "女"; }else{ return text; } } 目前vue是这么进行字典渲染到table上的多了就很麻烦了
    	 * 这个直接在服务端渲染完成前端可以直接用
    	 * 
    	 * @param result
    	 */
    	private void parseDictText(Object result) {
    		if (result instanceof Result) {
    			if (((Result) result).getResult() instanceof IPage) {
    				List<JSONObject> items = new ArrayList<>();
    
    				// step.1 筛选出加了 Dict 注解的字段列表
    				List<Field> dictFieldList = new ArrayList<>();
    				// 字典数据列表， key = 字典code，value=数据列表
    				Map<String, List<String>> dataListMap = new HashMap<>();
    
    				for (Object record : ((IPage) ((Result) result).getResult()).getRecords()) {
    					listFor(items, dictFieldList, dataListMap, record);
    				}
    
    				listForSecond(items, dictFieldList, dataListMap);
    
    				((IPage) ((Result) result).getResult()).setRecords(items);
    			}
    			else if (((Result) result).getResult() instanceof List) {
    				List<JSONObject> items = new ArrayList<>();
    
    				// step.1 筛选出加了 Dict 注解的字段列表
    				List<Field> dictFieldList = new ArrayList<>();
    				// 字典数据列表， key = 字典code，value=数据列表
    				Map<String, List<String>> dataListMap = new HashMap<>();
    				for (Object record : (List) ((Result) result).getResult()) {
    					listFor(items, dictFieldList, dataListMap, record);
    				}
    				listForSecond(items, dictFieldList, dataListMap);
    				((Result) result).setResult(items);
    			}
    
    		}
    	}
    
    	private void listForSecond(List<JSONObject> items, List<Field> dictFieldList,
    			Map<String, List<String>> dataListMap) {
    		// step.2 调用翻译方法，一次性翻译
    		Map<String, List<DictModel>> translText = this.translateAllDict(dataListMap);
    
    		// step.3 将翻译结果填充到返回结果里
    		for (JSONObject record : items) {
    			jsonObjRecordRecursion(dictFieldList, translText, record);
    		}
    	}
    
    	private void jsonObjRecordRecursion(List<Field> dictFieldList, Map<String, List<DictModel>> translText,
    			JSONObject record) {
    		recordField(dictFieldList, translText, record);
    		JSONArray jsonArray = record.getJSONArray("children");
    		if (jsonArray == null) {
    			return;
    		}
    		for (int i = 0; i < jsonArray.size(); i++) {
    			JSONObject jsonObject = jsonArray.getJSONObject(i);
    			jsonObjRecordRecursion(dictFieldList, translText, jsonObject);
    		}
    	}
    	
    	private void recordField(List<Field> dictFieldList, Map<String, List<DictModel>> translText, JSONObject record) {
    		for (Field field : dictFieldList) {
    			String code = field.getAnnotation(Dict.class).dicCode();
    			String text = field.getAnnotation(Dict.class).dicText();
    			String table = field.getAnnotation(Dict.class).dictTable();
    
    			String fieldDictCode = code;
    			if (!StringUtils.isEmpty(table)) {
    				fieldDictCode = String.format("%s,%s,%s", table, text, code);
    			}
    
    			String value = record.getString(field.getName());
    			if (oConvertUtils.isNotEmpty(value)) {
    				List<DictModel> dictModels = translText.get(fieldDictCode);
    				if (dictModels == null || dictModels.size() == 0) {
    					continue;
    				}
    
    				String textValue = this.translDictText(dictModels, value);
    //					log.debug(" 字典Val : " + textValue);
    //					log.debug(" __翻译字典字段__ " + field.getName() + CommonConstant.DICT_TEXT_SUFFIX + "： " + textValue);
    
    				// TODO-sun 测试输出，待删
    //					log.debug(" ---- dictCode: " + fieldDictCode);
    //					log.debug(" ---- value: " + value);
    //					log.debug(" ----- text: " + textValue);
    //					log.debug(" ---- dictModels: " + JSON.toJSONString(dictModels));
    
    				record.put(field.getName() + CommonConstant.DICT_TEXT_SUFFIX, textValue);
    			}
    		}
    	}
    
    	private void listFor(List<JSONObject> items, List<Field> dictFieldList, Map<String, List<String>> dataListMap,
    			Object record) {
    		ObjectMapper mapper = new ObjectMapper();
    		String json = "{}";
    		try {
    			// 解决@JsonFormat注解解析不了的问题详见SysAnnouncement类的@JsonFormat
    			json = mapper.writeValueAsString(record);
    		} catch (JsonProcessingException e) {
    			log.error("json解析失败" + e.getMessage(), e);
    		}
    		JSONObject item = JSONObject.parseObject(json);
    		// update-begin--Author:scott -- Date:20190603 ----for：解决继承实体字段无法翻译问题------
    		// for (Field field : record.getClass().getDeclaredFields()) {
    		// 遍历所有字段，把字典Code取出来，放到 map 里
    		for (Field field : oConvertUtils.getAllFields(record)) {
    			String value = item.getString(field.getName());
    			if (oConvertUtils.isEmpty(value)) {
    				continue;
    			}
    			// update-end--Author:scott -- Date:20190603 ----for：解决继承实体字段无法翻译问题------
    			if (field.getAnnotation(Dict.class) != null) {
    				if (!dictFieldList.contains(field)) {
    					dictFieldList.add(field);
    				}
    				String code = field.getAnnotation(Dict.class).dicCode();
    				String text = field.getAnnotation(Dict.class).dicText();
    				String table = field.getAnnotation(Dict.class).dictTable();
    
    				List<String> dataList;
    				String dictCode = code;
    				if (!StringUtils.isEmpty(table)) {
    					dictCode = String.format("%s,%s,%s", table, text, code);
    				}
    				dataList = dataListMap.computeIfAbsent(dictCode, k -> new ArrayList<>());
    				this.listAddAllDeduplicate(dataList, Arrays.asList(value.split(",")));
    			}
    			// date类型默认转换string格式化日期
    			if (field.getType().getName().equals("java.util.Date") && field.getAnnotation(JsonFormat.class) == null
    					&& item.get(field.getName()) != null) {
    				SimpleDateFormat aDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    				item.put(field.getName(), aDate.format(new Date((Long) item.get(field.getName()))));
    			}
    			if (field.getType().getName().equals("java.util.List")) {
    				List<? extends Object> parseArray = JSONObject.parseArray(value, record.getClass());
    				treeRecursion(parseArray, null, dictFieldList, dataListMap);
    			}
    		}
    		if (items!=null) {			
    			items.add(item);
    		}
    	}
    	private void treeRecursion(List<? extends Object> parseArray,List<JSONObject> items, List<Field> dictFieldList, Map<String, List<String>> dataListMap) {
    		for (Object object : parseArray) {
    			listFor(items, dictFieldList, dataListMap, object);
    		}
    	}
    	/**
    	 * list 去重添加
    	 */
    	private void listAddAllDeduplicate(List<String> dataList, List<String> addList) {
    		// 筛选出dataList中没有的数据
    		List<String> filterList = addList.stream().filter(i -> !dataList.contains(i)).collect(Collectors.toList());
    		dataList.addAll(filterList);
    	}
    
    	/**
    	 * 一次性把所有的字典都翻译了 1. 所有的普通数据字典的所有数据只执行一次SQL 2. 表字典相同的所有数据只执行一次SQL
    	 * 
    	 * @param dataListMap
    	 * @return
    	 */
    	private Map<String, List<DictModel>> translateAllDict(Map<String, List<String>> dataListMap) {
    		// 翻译后的字典文本，key=dictCode
    		Map<String, List<DictModel>> translText = new HashMap<>();
    		// 需要翻译的数据（有些可以从redis缓存中获取，就不走数据库查询）
    		List<String> needTranslData = new ArrayList<>();
    		// step.1 先通过redis中获取缓存字典数据
    		for (String dictCode : dataListMap.keySet()) {
    			List<String> dataList = dataListMap.get(dictCode);
    			if (dataList.size() == 0) {
    				continue;
    			}
    			// 表字典需要翻译的数据
    			List<String> needTranslDataTable = new ArrayList<>();
    			for (String s : dataList) {
    				String data = s.trim();
    				if (data.length() == 0) {
    					continue; // 跳过循环
    				}
    				if (dictCode.contains(",")) {
    					String keyString = String.format("sys:cache:dictTable::SimpleKey [%s,%s]", dictCode, data);
    					if (redisTemplate.hasKey(keyString)) {
    						try {
    							String text = oConvertUtils.getString(redisTemplate.opsForValue().get(keyString));
    							List<DictModel> list = translText.computeIfAbsent(dictCode, k -> new ArrayList<>());
    							list.add(new DictModel(data, text));
    						} catch (Exception e) {
    							log.warn(e.getMessage());
    						}
    					} else if (!needTranslDataTable.contains(data)) {
    						// 去重添加
    						needTranslDataTable.add(data);
    					}
    				} else {
    					String keyString = String.format("sys:cache:dict::%s:%s", dictCode, data);
    					if (redisTemplate.hasKey(keyString)) {
    						try {
    							String text = oConvertUtils.getString(redisTemplate.opsForValue().get(keyString));
    							List<DictModel> list = translText.computeIfAbsent(dictCode, k -> new ArrayList<>());
    							list.add(new DictModel(data, text));
    						} catch (Exception e) {
    							log.warn(e.getMessage());
    						}
    					} else if (!needTranslData.contains(data)) {
    						// 去重添加
    						needTranslData.add(data);
    					}
    				}
    
    			}
    			// step.2 调用数据库翻译表字典
    			if (needTranslDataTable.size() > 0) {
    				String[] arr = dictCode.split(",");
    				String table = arr[0], text = arr[1], code = arr[2];
    				String values = String.join(",", needTranslDataTable);
    				log.info("translateDictFromTableByKeys.dictCode:" + dictCode);
    				log.info("translateDictFromTableByKeys.values:" + values);
    				List<DictModel> texts = commonAPI.translateDictFromTableByKeys(table, text, code, values);
    				log.info("translateDictFromTableByKeys.result:" + texts);
    				List<DictModel> list = translText.computeIfAbsent(dictCode, k -> new ArrayList<>());
    				list.addAll(texts);
    
    				// 做 redis 缓存
    				for (DictModel dict : texts) {
    					String redisKey = String.format("sys:cache:dictTable::SimpleKey [%s,%s]", dictCode,
    							dict.getValue());
    					try {
    						// update-begin-author:taoyan date:20211012 for: 字典表翻译注解缓存未更新 issues/3061
    						// 保留5分钟
    						redisTemplate.opsForValue().set(redisKey, dict.getText(), 300, TimeUnit.SECONDS);
    						// update-end-author:taoyan date:20211012 for: 字典表翻译注解缓存未更新 issues/3061
    					} catch (Exception e) {
    						log.warn(e.getMessage(), e);
    					}
    				}
    			}
    		}
    
    		// step.3 调用数据库进行翻译普通字典
    		if (needTranslData.size() > 0) {
    			List<String> dictCodeList = Arrays.asList(dataListMap.keySet().toArray(new String[] {}));
    			// 将不包含逗号的字典code筛选出来，因为带逗号的是表字典，而不是普通的数据字典
    			List<String> filterDictCodes = dictCodeList.stream().filter(key -> !key.contains(","))
    					.collect(Collectors.toList());
    			String dictCodes = String.join(",", filterDictCodes);
    			String values = String.join(",", needTranslData);
    			log.info("translateManyDict.dictCodes:" + dictCodes);
    			log.info("translateManyDict.values:" + values);
    			Map<String, List<DictModel>> manyDict = commonAPI.translateManyDict(dictCodes, values);
    			log.info("translateManyDict.result:" + manyDict);
    			for (String dictCode : manyDict.keySet()) {
    				List<DictModel> list = translText.computeIfAbsent(dictCode, k -> new ArrayList<>());
    				List<DictModel> newList = manyDict.get(dictCode);
    				list.addAll(newList);
    
    				// 做 redis 缓存
    				for (DictModel dict : newList) {
    					String redisKey = String.format("sys:cache:dict::%s:%s", dictCode, dict.getValue());
    					try {
    						redisTemplate.opsForValue().set(redisKey, dict.getText());
    					} catch (Exception e) {
    						log.warn(e.getMessage(), e);
    					}
    				}
    			}
    		}
    		return translText;
    	}
    
    	/**
    	 * 字典值替换文本
    	 *
    	 * @param dictModels
    	 * @param values
    	 * @return
    	 */
    	private String translDictText(List<DictModel> dictModels, String values) {
    		List<String> result = new ArrayList<>();
    
    		// 允许多个逗号分隔，允许传数组对象
    		String[] splitVal = values.split(",");
    		for (String val : splitVal) {
    			String dictText = val;
    			for (DictModel dict : dictModels) {
    				if (val.equals(dict.getValue())) {
    					dictText = dict.getText();
    					break;
    				}
    			}
    			result.add(dictText);
    		}
    		return String.join(",", result);
    	}
    
    	/**
    	 * 翻译字典文本
    	 * 
    	 * @param code
    	 * @param text
    	 * @param table
    	 * @param key
    	 * @return
    	 */
    	@Deprecated
    	private String translateDictValue(String code, String text, String table, String key) {
    		if (oConvertUtils.isEmpty(key)) {
    			return null;
    		}
    		StringBuffer textValue = new StringBuffer();
    		String[] keys = key.split(",");
    		for (String k : keys) {
    			String tmpValue = null;
    			log.debug(" 字典 key : " + k);
    			if (k.trim().length() == 0) {
    				continue; // 跳过循环
    			}
    			// update-begin--Author:scott -- Date:20210531 ----for： !56
    			// 优化微服务应用下存在表字段需要字典翻译时加载缓慢问题-----
    			if (!StringUtils.isEmpty(table)) {
    				log.info("--DictAspect------dicTable=" + table + " ,dicText= " + text + " ,dicCode=" + code);
    				String keyString = String.format("sys:cache:dictTable::SimpleKey [%s,%s,%s,%s]", table, text, code,
    						k.trim());
    				if (redisTemplate.hasKey(keyString)) {
    					try {
    						tmpValue = oConvertUtils.getString(redisTemplate.opsForValue().get(keyString));
    					} catch (Exception e) {
    						log.warn(e.getMessage());
    					}
    				} else {
    					tmpValue = commonAPI.translateDictFromTable(table, text, code, k.trim());
    				}
    			} else {
    				String keyString = String.format("sys:cache:dict::%s:%s", code, k.trim());
    				if (redisTemplate.hasKey(keyString)) {
    					try {
    						tmpValue = oConvertUtils.getString(redisTemplate.opsForValue().get(keyString));
    					} catch (Exception e) {
    						log.warn(e.getMessage());
    					}
    				} else {
    					tmpValue = commonAPI.translateDict(code, k.trim());
    				}
    			}
    			// update-end--Author:scott -- Date:20210531 ----for： !56
    			// 优化微服务应用下存在表字段需要字典翻译时加载缓慢问题-----
    
    			if (tmpValue != null) {
    				if (!"".equals(textValue.toString())) {
    					textValue.append(",");
    				}
    				textValue.append(tmpValue);
    			}
    
    		}
    		return textValue.toString();
    	}
    
    }
慢慢看能不能看懂