前言

回看 Jackson 序列号字典字段属性内容的时候发现，业务开发过程中，不一定需要转换成完整的对象返回，有时候单纯的只是想要看显示值而已，不关心码值。所有有了升级的想法。可以支持多种不同的返回类型。既然是多种，又是不同。很自然的就想到的策略模式，然后就用上了策略枚举。有关策略枚举的内容，有兴趣的可以查看一下本人的 策略枚举的用法 专栏。

正文

1. 返回类型枚举 DictReEnum

该枚举的主要用途是在字典注解中，指定需要返回的类型。是字符串，还是字典对象。通过枚举的方式，实现强制绑定，方便管理所有的返回类型。

package com.cah.project.core.annotation;

import com.cah.project.core.cache.DictCacheUtil;
import com.cah.project.core.domain.bo.DictData;

/**
 * 功能描述: 字典返回类型 <br/>
 */
public enum DictReEnum {

    /** 字典字符 */
    STRING {
        @Override
        public Object getLabel(String type, String separator, String code) {
            return changeLabel(type, separator, code);
        }
    },
    /** 字典对象 */
    DICT_DATA {
        @Override
        public Object getLabel(String type, String separator, String code) {
            DictData dd = new DictData();
            dd.setType(type);
            dd.setValue(code);
            dd.setLabel(changeLabel(type, separator, code));
            return dd;
        }
    },
    ;

    /**
     * 功能描述: 改变值 <br/>
     *
     * @param type 字典类型
     * @param separator 分隔符
     * @param code 字典码值
     * @return "java.lang.String"
     */
    private static String changeLabel(String type, String separator, String code) {
        if(separator != null && separator.length() > 0) {
            String[] strs = code.split(separator);
            if (strs.length > 1) {
                StringBuilder sb = new StringBuilder();
                for (String str : strs) {
                    // 从缓存中获取字典。如果不行，通过SpringUtil.getBean(); 获取服务处理
                    sb.append(DictCacheUtil.getLabel(type, str)).append(separator);
                }
                return sb.substring(0, sb.length() - 1);
            }
        }
        // 从缓存中获取字典。如果不行，通过SpringUtil.getBean(); 获取服务处理
        return DictCacheUtil.getLabel(type, code);
    }

    /**
     * 功能描述: 抽象的获取字典显示值的方法 <br/>
     *
     * @param type 字典类型
     * @param separator 分隔符
     * @param code 字典码值
     * @return "java.lang.Object"
     */
    public abstract Object getLabel(String type, String separator, String code);

}

2.注解改造 @Dict

添加了返回类型的方法。并且指定默认返回类型，不影响现有的功能。

package com.cah.project.core.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 功能描述: 字典注解 <br/>
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Dict {

    /** 字典类型 {@link com.cah.project.module.standard.domain.entity.DictTypeEntity 的 typeCode 字段内容} */
    String type();
    /** 字典类型描述 {@link com.cah.project.module.standard.domain.entity.DictTypeEntity 的 typeName 字段内容} */
    String desc() default "";
    /** 如果多个字典拼接，自定义分隔符 */
    String separator() default ",";
    /** 返回类型 */
    DictReEnum re() default DictReEnum.STRING;

}

3.字典序列号对象 DictSerializer

将原来的构造函数入参去掉，改成注解入参，方便一些。并且修改 serialize 方法的实现，使用枚举的方式，获得字典转换对象。

package com.cah.project.conf.serializer;

import com.cah.project.core.annotation.Dict;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;

/**
 * 功能描述: 字典序列化 <br/>
 */
public class DictSerializer extends StdSerializer<Object> {

    /** 字典注解 */
    private final Dict dict;

    public DictSerializer(Dict dict) {
        super(Object.class);
        this.dict = dict;
    }

    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeObject(dict.re().getLabel(dict.type(), dict.separator(), value.toString()));
    }

}

4.内省器改造

只需要修改创建字典序列化的方法即可

package com.cah.project.conf.serializer;

import com.cah.project.core.annotation.Dict;
import com.fasterxml.jackson.databind.introspect.Annotated;
import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;

/**
 * 功能描述: 自定义项目内省器 <br/>
 */
public class ProjectJacksonAnnotationIntrospector extends JacksonAnnotationIntrospector {

    public ProjectJacksonAnnotationIntrospector() {}

    /**
     * 功能描述: 序列号 <br/>
     *
     * @param a 带注释字段
     * @return "java.lang.Object"
     */
    @Override
    public Object findSerializer(Annotated a) {
        // 如果是字典注解
        Dict dict = _findAnnotation(a, Dict.class);
        if(dict != null) {
            return new DictSerializer(dict);
        }
        // 其他扩展。。。
        return super.findSerializer(a);
    }
}

5.返回对象改造

测试能否通过不同的返回类型，返回不一样的字典对象

@Data
public class TestOutVO implements Serializable {

    private String name;

    @Dict(type = "STATUS_CD")
    private String status;

    @Dict(type = "SEX_CD", re = DictReEnum.DICT_DATA)
    private String sex;

    private List<ChildOutVO> children;

}

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ChildOutVO {

    private String name;

    @Dict(type = "TYPE_CD", re = DictReEnum.DICT_DATA)
    private Integer type;

    @Dict(type = "SEX_CD")
    private String sex;

}

测试结果

在这里插入图片描述

总结

通过回顾，对现有的代码提出疑问，或者增加场景。看看是否还有继续优化和扩展的地方。

代码地址

Jackson 序列化字典字段属性（升级）

前言

正文