Java一个注解实现数据字典功能过程

 更新时间:2026年06月18日 10:39:12   作者:灵感君  
本文详细介绍了通过引入jackson-databind依赖和自定义@Dict注解序列化器实现数据字典功能的方法,优化了代码的通用性和性能,适合项目开发参考

注解序列化方式实现数据字典功能

一个项目开发从无到有得考虑很多东西,做到从架构层去思考问题,需要从代码的通用性、易读性等多个方面去考虑,网上看了很多文章都是通过反射去实现,会影响性能,结合实战代码发一篇文章给广大码友做一个参考

引入依赖

除了springboot的起步依赖,还需要引入jackson-databind依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.2.1</version>
</dependency>

数据库设计

CREATE TABLE `sys_dict`  (
  `id` bigint NOT NULL COMMENT '主键id',
  `code` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '编码',
  `name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '名称',
  `describe` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '描述',
  `status` tinyint(1) NOT NULL DEFAULT 0 COMMENT '状态(0--正常1--冻结)',
  `is_delete` tinyint(1) NULL DEFAULT 0 COMMENT '删除状态(0,正常,1已删除)',
  `remark` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '备注',
  `create_by` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '创建者',
  `create_time` datetime NULL DEFAULT NULL COMMENT '创建时间',
  `update_by` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '修改者',
  `update_time` datetime NULL DEFAULT NULL COMMENT '修改时间',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
CREATE TABLE `sys_dict_detail`  (
  `id` bigint NOT NULL COMMENT '主键id',
  `dict_id` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '字典ID',
  `code` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '编码',
  `name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '名称',
  `sort` tinyint NOT NULL DEFAULT 0 COMMENT '排序',
  `create_by` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '创建人登录名称',
  `create_time` datetime NULL DEFAULT NULL COMMENT '创建日期',
  `update_by` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '更新人登录名称',
  `update_time` datetime NULL DEFAULT NULL COMMENT '更新日期',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
INSERT INTO `cloud`.`sys_dict` (`id`, `code`, `name`, `describe`, `status`, `is_delete`, `remark`, `create_by`, `create_time`, `update_by`, `update_time`) VALUES (1, 'sex', '性别', NULL, 0, 0, NULL, NULL, NULL, NULL, NULL);
INSERT INTO `cloud`.`sys_dict_detail` (`id`, `dict_id`, `code`, `name`, `sort`, `create_by`, `create_time`, `update_by`, `update_time`) VALUES (1, '1', '0', '男', 0, NULL, NULL, NULL, NULL);
INSERT INTO `cloud`.`sys_dict_detail` (`id`, `dict_id`, `code`, `name`, `sort`, `create_by`, `create_time`, `update_by`, `update_time`) VALUES (2, '1', '1', '女', 1, NULL, NULL, NULL, NULL);

代码实现

定义@Dict注解

import cn.hutool.core.annotation.AliasFor;
import com.fasterxml.jackson.annotation.JacksonAnnotation;
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@JsonSerialize(using = DictSerializer.class)
@JacksonAnnotationsInside
@JacksonAnnotation
public @interface Dict {

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

    @AliasFor(
            annotation = JsonSerialize.class,
            attribute = "using"
    )
    Class<? extends JsonSerializer> using() default DictSerializer.class;
}

序列化器

import cn.hutool.extra.spring.SpringUtil;
import com.ayu.sx.system.vo.DictVO;
import com.ayu.sx.system.bo.DictRedisBO;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import lombok.SneakyThrows;

import java.util.List;
import java.util.stream.Collectors;

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) {
        // 我这里是从redis获取数据字典,项目启动时查询数据库加载到redis
        List<Object> objects = redisTemplate.opsForList().range("dict_info:", 0, -1);
        List<DictVO> dictVOList = objects.stream().filter(item -> {
            DictVO dictRedis = (DictVO) item;
            boolean bool1 = dictRedis.getDictCode().equals(this.dictCode);
            boolean bool2 = dictRedis.getCode().equals(String.valueOf(code));
            return bool1 && bool2;
        }).map(item -> (DictVO) item).collect(Collectors.toList());
        DictVO dictVO = new DictVO();
        if (dictVOList.size() > 0) {
            dictVO = dictVOList.get(0);
        }
        gen.writeObject(dictVO);
    }
}

DictVO

@Data
public class DictVO {

    private String dictCode;

    private String code;

    private String name;

}

测试类

controller

@RestController
@RequestMapping("/test")
@Api(tags = "测试")
public class TestController {

    @RequestMapping(value = "/query", method = RequestMethod.GET)
    public Test1Entity query() {
        Test1Entity testEntity = new Test1Entity();
        testEntity.setSex(1);
        return testEntity;
    }

}

entity

import com.ayu.sx.dict.Dict;
import lombok.Data;

@Data
public class Test1Entity {

    @Dict(value = "sex")
    private Integer sex;

}

测试结果

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 手写一个@Valid字段校验器的示例代码

    手写一个@Valid字段校验器的示例代码

    这篇文章主要为大家详细介绍了如何手写一个@Valid字段校验器,文中的示例代码讲解详细,对我们学习有一定帮助,需要的可以参考一下
    2022-07-07
  • SpringBoot整合MP通过Redis实现二级缓存方式

    SpringBoot整合MP通过Redis实现二级缓存方式

    这篇文章主要介绍了SpringBoot整合MP通过Redis实现二级缓存方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Java Map 按照Value排序的实现方法

    Java Map 按照Value排序的实现方法

    Map是键值对的集合接口,它的实现类主要包括:HashMap,TreeMap,Hashtable以及LinkedHashMap等。这篇文章主要介绍了Java Map 按照Value排序的实现方法,需要的朋友可以参考下
    2016-08-08
  • JVM用寄存器实现程序计数

    JVM用寄存器实现程序计数

    这篇文章主要介绍了JVM用寄存器实现程序计数,JVM中的程序计数寄存器(Program Counter Register),Register的命名源于CPU的寄存器,寄存器存储指令相关的现场信息。CPU只有把数据装载到寄存器才能够运行
    2023-02-02
  • Java Set接口及常用实现类总结

    Java Set接口及常用实现类总结

    Collection的另一个子接口就是Set,他并没有我们List常用,并且自身也没有一些额外的方法,全是继承自Collection中的,因此我们还是简单总结一下,包括他的常用实现类HashSet、LinkedHashSet、TreeSet的总结
    2023-01-01
  • SpringBoot将多个文件夹进行压缩的两种方法(浏览器下载和另存为)

    SpringBoot将多个文件夹进行压缩的两种方法(浏览器下载和另存为)

    Spring Boot项目通常不会自动对文件夹进行压缩,不过,在打包应用时,如果你使用了Maven或Gradle这样的构建工具,并且配置了相应的插件,可以在打成jar或war包的时候将依赖的库文件合并并压缩,本文介绍了SpringBoot将多个文件夹进行压缩的两种方法
    2024-07-07
  • Java OpenCV实现图像镜像翻转效果

    Java OpenCV实现图像镜像翻转效果

    这篇文章主要为大家详细介绍了Java OpenCV实现图像镜像翻转效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • Spring Boot小型项目如何使用异步任务管理器实现不同业务间的解耦

    Spring Boot小型项目如何使用异步任务管理器实现不同业务间的解耦

    这篇文章主要介绍了Spring Boot小型项目如何使用异步任务管理器实现不同业务间的解耦,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-08-08
  • Jmeter如何基于命令行运行jmx脚本

    Jmeter如何基于命令行运行jmx脚本

    这篇文章主要介绍了Jmeter如何基于命令行运行jmx脚本,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • java实例方法被覆盖,静态方法被隐藏Explain(详解)

    java实例方法被覆盖,静态方法被隐藏Explain(详解)

    下面小编就为大家带来一篇java实例方法被覆盖,静态方法被隐藏Explain(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05

最新评论