添加数据字典表注解@Dict,并在缓存中执行
引言
- ①某些变量在多个地方使用，而且一般是固定的，但是随着系统升级和后期变化，可能需要改变，如果这些变量写死在代码里面将会变得难以维护，所以要将其从代码中抽离出来。(维护性强)
②一般的业务系统客户端与用户交互的时候都会使用下拉框组件，对于某些比较固定的值的下拉组件的数据来源一般都是比较固定的一类数值。 - 字典表的设计：通常分成两张表来实现，一个是字典类型表，一个是字典表。字典类型应该是不可编辑的，因为字典类型通常会和具体代码实现紧密联合，如果非要进行编辑的话需要考虑到对代码的影响以及如何保证修改之后系统正常工作。
创建表
直接借鉴Ruoyi框架提供的2张字典表，sys_dict_type（字典类型定义表）、sys_dict_data（字典数据表）
CREATE TABLE `sys_dict_type` (
`dict_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '字典主键',
`dict_name` varchar(100) DEFAULT '' COMMENT '字典名称',
`dict_type` varchar(100) DEFAULT '' COMMENT '字典类型',
`status` char(1) DEFAULT '0' COMMENT '状态（0正常 1停用）',
`create_by` varchar(64) DEFAULT '' COMMENT '创建者',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`update_by` varchar(64) DEFAULT '' COMMENT '更新者',
`update_time` datetime DEFAULT NULL COMMENT '更新时间',
`remark` varchar(500) DEFAULT NULL COMMENT '备注',
PRIMARY KEY (`dict_id`),
UNIQUE KEY `dict_type` (`dict_type`)
) COMMENT='字典类型表';
CREATE TABLE `sys_dict_data` (
`dict_code` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '字典编码',
`dict_sort` int(4) DEFAULT '0' COMMENT '字典排序',
`dict_label` varchar(100) DEFAULT '' COMMENT '字典标签',
`dict_value` varchar(100) DEFAULT '' COMMENT '字典键值',
`dict_type` varchar(100) DEFAULT '' COMMENT '字典类型',
`css_class` varchar(100) DEFAULT NULL COMMENT '样式属性（其他样式扩展）',
`list_class` varchar(100) DEFAULT NULL COMMENT '表格回显样式',
`is_default` char(1) DEFAULT 'N' COMMENT '是否默认（Y是 N否）',
`status` char(1) DEFAULT '0' COMMENT '状态（0正常 1停用）',
`create_by` varchar(64) DEFAULT '' COMMENT '创建者',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`update_by` varchar(64) DEFAULT '' COMMENT '更新者',
`update_time` datetime DEFAULT NULL COMMENT '更新时间',
`remark` varchar(500) DEFAULT NULL COMMENT '备注',
PRIMARY KEY (`dict_code`)
) COMMENT='字典数据表';
注解@Dict
/**
* 类描述: 字典注解
* @author： rainyhong
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Dict {
/**
* 方法描述: 数据code
* @return 返回类型： String
*/
String dictCode();
/**
* 方法描述: 数据Text
* @return 返回类型： String
*/
String dictText() default "";
/**
* 方法描述: 数据字典表
* @return 返回类型： String
*/
String dictTable() default "";
}
切面DictAspect
调用哪个controller就在那个服务创建aspect包,并创建类DictAspect
/**
* 字典aop类
*/
@Aspect
@Component
@Slf4j
public class DictAspect {
@Autowired
private ISystemFeignService dictService;
/**
* 定义切点Pointcut
*/
@Pointcut("execution(public * com.rainyhon.*.*.*Controller.*(..))")
public void dict() {
}
@Around("dict()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
StopWatch sw = new StopWatch();
sw.start("task1");
Object result = pjp.proceed();
sw.stop();
log.debug("获取JSON数据 耗时：" + sw.prettyPrint() + "ms");
sw.start("task2");
this.parseDictText(result);
sw.stop();
log.debug("解析注入JSON数据 耗时" + sw.prettyPrint() + "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 TableDataInfo) {
List<JSONObject> items = new ArrayList<>();
for (Object record : (((TableDataInfo) result).getRows())) {
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()) {
for (Field field : ObjectConvertUtils.getAllFields(record)) {
//update-end--Author:scott -- Date:20190603 ----for：解决继承实体字段无法翻译问题------
if (field.getAnnotation(Dict.class) != null) {
String code = field.getAnnotation(Dict.class).dictCode();
String key = String.valueOf(item.get(field.getName()));
//翻译字典值对应的txt
String textValue = translateDictValue(code, key);
//log.debug(" 字典Val : " + textValue);
//log.debug(" __翻译字典字段__ " + field.getName() + Constants.DICT_TEXT_SUFFIX + "： " + textValue);
item.put(field.getName() + Constants.DICT_TEXT_SUFFIX, textValue);
}
//date类型默认转换string格式化日期
if ("java.util.Date".equals(field.getType().getName()) && 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()))));
}
}
items.add(item);
}
((TableDataInfo) result).setRows(items);
}
}
/**
* 翻译字典文本
*
* @param code
* @param key
* @return
*/
private String translateDictValue(String code, String key) {
if (Strings.isEmpty(key)) {
return null;
}
StringBuilder textValue = new StringBuilder();
String[] keys = key.split(",");
for (String k : keys) {
String tmpValue = null;
//log.debug(" 字典 key : " + k);
if (k.trim().length() == 0) {
continue; //跳过循环
}
tmpValue = dictService.getInfo(code, key);
if (tmpValue != null) {
if (!"".equals(textValue.toString())) {
textValue.append(",");
}
textValue.append(tmpValue);
}
}
return textValue.toString();
}
}
编写工具类
Slf4j
@SuppressWarnings("ALL")
public class ObjectConvertUtils {
/**
* 替换空格
*/
private static Pattern REPLACE_BLANK_PATTERN = Pattern.compile("\\s*|\t|\r|\n");
public static Field[] getAllFields(Object object) {
Class<?> clazz = object.getClass();
List<Field> fieldList = new ArrayList<>();
while (clazz != null) {
fieldList.addAll(new ArrayList<>(Arrays.asList(clazz.getDeclaredFields())));
clazz = clazz.getSuperclass();
}
Field[] fields = new Field[fieldList.size()];
fieldList.toArray(fields);
return fields;
}
public static boolean isEmpty(Object object) {
if (object == null) {
return (true);
}
if ("".equals(object)) {
return (true);
}
if ("null".equals(object)) {
return (true);
}
return (false);
}
}
远程调用的接口
因为是服务之间调用,所以用到openfeign
@FeignClient(value = "{系统服务名}")
public interface ISystemFeignService {
/**
* 远程调用数据字典表
* @param dictType
* @param dictValue
* @return
*/
@GetMapping("/dict/type/info/{dictType}/{dictValue}")
String getInfo(@PathVariable(value = "dictType") String dictType, @PathVariable(value = "dictValue") String dictValue);
}
被调用的contoller层
@GetMapping("/info/{code}/{key}")
public String queryDictTextByKey(@PathVariable String code, @PathVariable String key) {
return dictTypeService.queryDictTextByKey(code, key);
}
业务层加入缓存
@Override
@Cacheable(value = CacheConstants.SYS_DICT_CACHE,key = "#code+':'+#key", unless = "#result == null")
public String queryDictTextByKey(String code, String key) {
log.info("无缓存dictText的时候调用这里！");
return baseMapper.queryDictTextByKey(code, key);
}
数据层
String queryDictTextByKey(@Param("code") String code, @Param("key") String key);
mapper.xml
<!-- 通过字典code获取字典数据 -->
<select id="queryDictTextByKey" parameterType="String" resultType="String">
select s.dict_label from sys_dict_data s
where s.dict_type = #{arg0} and s.dict_value = #{arg1}
</select>
测试
在返回字段中加入@Dict
查看接口返回值
