Spring boot中优雅的实现字典管理

利用字典可以统一管理系统中的散落的状态，增强系统的整体性与逻辑性。
在开发之前我先参考了网上些许资料，其中主要参考这篇文章：https://blog.csdn.net/qq_40065776/article/details/107403576
这篇文章是采取AOP方式对响应信息进行处理，在响应体内增加一个 “变量名” + “Text” 格式的字段来对字典进行解释。
个人认为这种方式有一定缺点，其一是代码繁琐了些，因为AOP处理部分的代码是新增的，所以会增加处理逻辑，对系统会增加一定的逻辑时长。
在该文章评论区一位叫“汤同学”的网友列出了使用自定义序列化的方式来进行处理，个人认为这种思路会更加优雅且相对逻辑时长较短。
只不过该同学提供的方式需要在字段上指定字典注解之外，还需要@JsonSerialize(using = DicSerializer.class)来指定字段序列化方式。
这篇文章是对“汤同学”方式的补充，可以不写序列化注解。

1.建表

主表

CREATE TABLE `dict` (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主键id',
  `code` varchar(32) DEFAULT NULL COMMENT '编码',
  `name` varchar(32) DEFAULT NULL COMMENT '名称',
  `describe` varchar(64) DEFAULT NULL COMMENT '描述',
  `status` tinyint(1) NOT NULL DEFAULT '0' COMMENT '状态（0--正常1--冻结）',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `create_user` varchar(50) DEFAULT NULL COMMENT '创建人',
  `is_del` tinyint(1) DEFAULT '0' COMMENT '删除状态（0，正常，1已删除）',
) 

副表

CREATE TABLE `dict_detail` (
  `id` INT NOT NULL AUTO_INCREMENT COMMENT '主键id',
  `dict_code` VARCHAR(32) DEFAULT NULL COMMENT '字典编码',
  `code` VARCHAR(32) DEFAULT NULL COMMENT '编码',
  `name` VARCHAR(32) DEFAULT NULL COMMENT '名称',
  `sort` TINYINT NOT NULL DEFAULT '0' COMMENT '排序'
) 

生成实体部分就不重复赘述了，这里表索引和表之间的关系没有表明，自己看情况处理。

2.字典注解

/**
 * 数据字典注解
 * @author liujing
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Dict {

    /**
     * 字典code
     */
    String value();

}

实现自动的自定义序列化，也就是不需要在属性上指定序列化的方式

/**
 * 字典自定序列化类
 */
public class DictSerializer extends StdSerializer<Object> implements ContextualSerializer {

    private static final long serialVersionUID = -6157558261755426448L;

    private String dictCode;

    public DictSerializer() {
        super(Object.class);
    }

    public DictSerializer(String dictCode) {
        super(Object.class);
        this.dictCode = dictCode;
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
        Dict annotation = property.getAnnotation(Dict.class);
        return new DictSerializer(annotation.value());
    }

    @SneakyThrows
    @Override
    public void serialize(Object code, JsonGenerator gen, SerializerProvider provider) {
        /*
        获取键值对，这里我处理成map的方式返回给前端
        这部分要自己处理，我这里是通过一个业务类从redis中获取字典
         */ 
        DictDetailService service = SpringUtil.getBean(DictDetailService.class);
        DictDetail detail = service.get(this.dictCode, String.valueOf(code));
        DictResp resp = new DictResp();
        if (detail != null){
            resp.setDictCode(detail.getDictCode());
            resp.setCode(detail.getCode());
            resp.setName(detail.getName());
        }
        gen.writeObject(resp);
    }
}

/**
 * 字典注解序列化拦截器
 */
@Component
public class DictSensitiveAnnotationIntrospector extends NopAnnotationIntrospector {

    private static final long serialVersionUID = 1L;

    @Override
    public Object findSerializer(Annotated am) {
        Dict dict = am.getAnnotation(Dict.class);
        if (dict != null){
            return DictSerializer.class;
        }
        return null;
    }
}

下面部分代码就是增加@Dict注解属性的序列化方式

/**
 * 修改被@Dict注解标注的属性字典序列化方式
 * @author liujing
 */
@Configuration
public class DictSerializerConfig {

    @Resource
    private DictSensitiveAnnotationIntrospector dictSensitiveAnnotationIntrospector;

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> builder.annotationIntrospector(dictSensitiveAnnotationIntrospector);;
    }
}

3.测试实体

/**
 * 管理员实体类
 * @author liujing
 * @since 2021-12-15
 */
@Data
public class Admin implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 管理员编号
     */
    private Integer id;

    /**
     * 性别
     */
    @Dict("sys_gender")
    private Integer gender;

}

接口就不写了，直接显示结果，gender会被翻译成带描述信息的对象，当然也可以放更多信息，在于修改DictSerializer类中serialize方法的序列化结果对象内容。

image.png