自定义注解Dict，解决数据字典批量翻译繁琐的问题

概述

由于业务的需要，录入很多信息，而这些信息中绝大多数都是字典code，所以就会有很多数据字典的定义。
而前台数据的获取基本上都是下拉列表的选择。在保存或编辑的时候，返回到前端只要字典code就可以，但是在查看的时候，需要将字典翻译同时返回用于展示。

基于这样的前提下，受Hibernate Validator校验方式的启示，通过自定义注解的方式来实现。
这样做有一个非常大的优势：可拓展性强，以后新增字典项或字典类型直接加入字典仓库，然后在相关字段上声明就可以了。

实现的功能

由于公司项目的特殊性，存在老的字典码和新字典码映射转换；所以除了字典code的翻译，还有字典code的转换。
除了一对一的字典code的翻译，还有一种是上下级的翻译，比如省市区

1. 一般字典code的翻译
2. 上下级字典code的翻译
3. 字典code的转换（主要是新老系统的兼容对接）

具体实现

话不多说，来看示例：

1. 首先在DTO中添加自定义的注解

@Data
public class PersonDTO {
    /** 证件类型（字典） */
    private String custCertificateType;
    /** 学历（字典） */
    private String custEducation;
    /** 学位（字典） */
    private String custDegree;
    /** 单位所在省份（字典） */
    private String companyProvince;
    /** 单位所在城市（字典） */
    private String companyCity;
    /** 单位所在区/县（字典） */
    private String companyDistrict;

    /** 证件类型（名称） */
    @Dict(DICT_CERTIFICATE_TYPE)
    private String custCertificateTypeName;
    /** 学历（名称） */
    @Dict(DICT_EDUCATION)
    private String custEducationName;
    /** 学位（名称） */
    @Dict(DICT_DEGREE)
    private String custDegreeName;

    /** 单位所在省份（名称） */
    @Dict(value = DICT_AR_PROVINCE)
    private String companyProvinceName;
    /** 单位所在城市（名称） */
    @Dict(value = DICT_SYSTEM_AREA, isChild = true, parentField = "companyProvince")
    private String companyCityName;
    /** 单位所在区/县（名称） */
    @Dict(value = DICT_SYSTEM_AREA, isChild = true, parentField = "companyCity")
    private String companyDistrictName;
}

自定义注解Dict的定义如下：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Dict {

    /** 数据字典code类型； 如果查找二级编码，则该值存储二级编码类型前缀，比如AR表示区域 */
    String value() default "";

    /** 存储编号的字段名称 如果是添加了Name后缀，则可省略*/
    String codeName() default "";

    /** 是否是子元素，如果是true，则 parentField不得为空*/
    boolean isChild() default false;

    /** 子元素的上级code字段名 */
    String parentField() default "";

    /** 当转换后的值为null的时候，是否进行赋值；默认为false，表示不覆盖 */
    boolean whetherSetIfNull() default false;

    /** 是否是转换编码；也就是说默认不转换code，而是翻译成name */
    boolean whetherConvertCode() default false;
}

2. 其次是在接口输出list结果前调用service方法解析@Dict注解

使用注解的方式自定义解析，比较灵活。哪里需要使用，哪里调用方法解析就可以。

@Autowired private DictService dictService;

// 这里person从数据库查询出来的对象
PersonDTO person =  ……

// 数据字典翻译
dictService.translationDictCode(person);

// translationDictCode 方法的实现
@Override
public void translationDictCode(Object obj) {
    DictUtil.translationDictCode(obj, this::queryDictMapData, false);
}

// 其中DictUtil.translationDictCode方的定义如下：
 /**
     * 将DTO对象（对象中含有有Dict注解的对象）的字典码转换为字典值名称（注：通过Dict注解标识码值的字段）
     *
     * @param obj                处理的对象
     * @param convertMapFun      字典类型和值的集合转换为名称
     * @param whetherConvertCode 是否转换编码
     */
    public static void translationDictCode(final Object obj, Function, Map> convertMapFun,
                                              boolean whetherConvertCode) 

// 这里的queryDictMapData定义如下：做为translationDictCode中的入参convertMapFun，它是接收一个map，然后返回另一个map，其中param是根据解析DTO上的Dict注解构造出来的查询参数。

/**
 * 查询字典码对应的name
 */
private Map queryDictMapData(Map param) {
    // 调用接口根据入参param查询数据字典翻译出来的name值
    // 一般数据字典放在redis缓存中，统一一个地方处理；这里可以根据这种入参去缓存中查询，然后封装返回需要格式的数据
// 主要就是解析入参，然后构建特定格式的返回值，比如：{"xx:certificateType=1": "身份证", "xx:certificateType=2": "护照"}
    return ……;
}

对queryDictMapData方法的入参和返回值的解读：

param 示例：{"relationship": "1,2", "AR:1001": "", ……}
其中key是字典type，value是要查询的字典值，有多个则用逗号分隔；
relationship对应一个字典项列表，比如[{"1": "朋友"}, {"2", "同事"}, {"3", "亲属"}……]
而value说明要查询字典code 1和2对应的翻译，那么返回结果如下：
因为字典type可能会有冒号字符，这里用=做链接符
{"relationship=1": "朋友", "relationship=2": "同事"}

3. DictUtil的部分方法
   首先从方法translationDictCode一步步来剖析：

其实一开始是没有参数whetherConvertCode，后来为了兼容一种情况，就是先字典code的转换（老系统的code转换为新系统的code，反之亦然），然后再进行字典翻译

public static void translationDictCode(final Object obj, Function, Map> convertMapFun,
                                              boolean whetherConvertCode) {
        if (Objects.isNull(obj)) {
            return;
        }

        Map fieldKeyMap = new HashMap<>();
        Map keyCodeMap = new HashMap<>();

        // 解析需要转换的字典码（递归处理）
        parseFieldCodeValue(obj, fieldKeyMap, keyCodeMap, whetherConvertCode);

        // 字典值转换（具体转换的方法）
        Map convertedMap = convertMapFun.apply(keyCodeMap);

        // 回填字典码对应的值（递归处理）
        backFillCodeName(obj, fieldKeyMap, convertedMap, whetherConvertCode);
    }

除了对Object进行翻译，直接对List