JAVA自定义注解实现数据字典映射功能

已于 2025-06-06 17:58:14 修改
阅读量574 收藏 4
点赞数 19
CC 4.0 BY-SA版权
文章标签： spring
于 2025-06-05 14:36:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62861638/article/details/148449344

前言

在我们开发过程中，我们从前端页面接收的数据字典一般都是key（大多数为数字），但我们在页面显示的时候，想用其value值。如果我们每使用一次就要去写一些重复的代码去查询，这样会使我们的代码非常冗余，那有什么办法可以让我们查询出key的同时，将value值也查询出来，此时我们可以使用自定义注解的方式去做字段映射。

一、添加依赖

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

二、创建自定义注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestDict {

    String dicCode();

    String dicText() default "";

    String dictTable() default "";
}

三、创建JSON序列化配置

便于在序列化Java对象时为带有特定注解（如TestDict）的字段应用自定义序列化逻辑。

/**
 * JSON序列化配置
 * @author van
 */
@Configuration
public class JacksonConfig {

    /**
     * JacksonConfig配置一个自定义的ObjectMapper，
     * 通过JacksonSerializerModifier扩展Jackson的序列化功能，
     * 保证带TestDict注解的字段在序列化时触发自定义逻辑（由testFiler处理）。
     */
    @Bean
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        //初始化一个ObjectMapper，用于处理JSON序列化/反序列化，取消XML对JSON的支持。
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();

        //注册JacksonSerializerModifier，
        //使所有使用该ObjectMapper的序列化操作都会应用JacksonSerializerModifier的逻辑
        //（即为带有TestDict注解的字段绑定testFiler序列化器）。        
        objectMapper.setSerializerFactory(objectMapper.getSerializerFactory().withSerializerModifier(new JacksonSerializerModifier()));
        return objectMapper;
    }
}

四、创建JSON序列化处理器

将包含自定义序列化器的作用字段列表返回给Jackson，继续序列化整个对象。

/**
 * JSON序列化处理器
 * @author van
 */
public class JacksonSerializerModifier extends BeanSerializerModifier {

    /**
     *
     * @param config Jackson的序列化配置，包含序列化规则。
     * @param beanDesc 当前序列化的Java Bean的元信息（如类名、字段、注解）。
     * @param beanProperties 当前Bean的字段列表，每个BeanPropertyWriter表示一个字段的序列化信息。
     * @return 返回修改后的字段列表。
     */
    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
        for (BeanPropertyWriter beanProperty : beanProperties) {
            // 数据字典翻译
            //获取当前字段上的@TestDict注解。
            TestDict testDict = beanProperty.getAnnotation(TestDict.class);
            if (testDict != null){
                TestFiler testFiler = new TestFiler(beanProperty.getName(), testDict.dicCode(), testDict.dictTable(), testDict.dicText());
                //为当前字段绑定testFiler序列化器
                beanProperty.assignSerializer(testFiler);
            }
        }


        return beanProperties;
    }
}

五、创建自定义序列化器

自定义序列化器，负责在序列化Java对象时处理带有@TestDict注解的字段。它输出字段的原始值（如title: "1"），并附加一个翻译后的字段（如title_dictText: "启用"）。

@Data
public class TestFiler extends JsonSerializer<Object> {
    private static final String DICT_APPEND = "_dictText";

    private String fieldName;
    private String dicCode;
    private String dictTable;
    private String dicText;

    public TestFiler(String fieldName, String dicCode, String dictTable, String dicText){
        this.fieldName = fieldName;
        this.dicCode = dicCode;
        this.dictTable = dictTable;
        this.dicText = dicText;
    }

    /**
     * 控制字段在JSON中的输出中，包括原始值和翻译值
     * @param o 待序列化的字段值（如title的值"1"）。
     * @param jsonGenerator Jackson的JSON生成器，用于读取JSON内容
     * @param serializerProvider 序列化上下文，提供配置信息（本方法未使用）
     * @throws IOException
     */
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {

        //获取映射字段的值
        String key = o.toString();
        //将原始字段值写入JSON
        jsonGenerator.writeObject(o);

        if (StringUtils.isNotBlank(key)){
            //对指定的字段进行映射(这里可以去数据库里面通过key，去查询字典表中对应的value)
            String value = "这里映射对应的字段的意思";
            //将映射的字段和字段值序列化（输出翻译后的字段值）
            jsonGenerator.writeObjectField(fieldName + DICT_APPEND , value);
        }
    }
}

六、进行测试验证

        返回实体类(使用自定义注解，查看返回什么样的样式)

public class SurveyClientListRespDTO implements Serializable {

    
    private String id;

    @TestDict(dicCode = "123")
    private String title;
}

        创建接口（查看自定义注解的映射）

@RestController
@RequestMapping("/api/survey/survey")
public class SurveyController extends BaseController {

    @PostMapping("/test")
    public List<SurveyClientListRespDTO> minePaging() {
        List<SurveyClientListRespDTO> list = new ArrayList<>();
        SurveyClientListRespDTO surveyClientListRespDTO = new SurveyClientListRespDTO();
        //查看1111会映射出来对应的value
        surveyClientListRespDTO.setTitle("1111");
        surveyClientListRespDTO.setId("第一个内容");

        SurveyClientListRespDTO surveyClientListRespDTO1 = new SurveyClientListRespDTO();
        surveyClientListRespDTO.setTitle("2222");
        surveyClientListRespDTO.setId("第二个内容");

        SurveyClientListRespDTO surveyClientListRespDTO2 = new SurveyClientListRespDTO();
        surveyClientListRespDTO.setTitle("3333");
        surveyClientListRespDTO.setId("第三个内容");

        list.add(surveyClientListRespDTO);
        list.add(surveyClientListRespDTO1);
        list.add(surveyClientListRespDTO2);
        return list;
    }
}

七、返回结果

八、自定义注解的进阶使用方法

        (1)调整自定义序列化器
@Data
@Log4j2
public class TestFiler extends JsonSerializer<Object> {
    private static final String DICT_APPEND = "_dictText";

    private String fieldName;
    private String dicCode;
    private String dictTable;
    private String dicText;

    public TestFiler(String fieldName, String dicCode, String dictTable, String dicText){
        this.fieldName = fieldName;
        this.dicCode = dicCode;
        this.dictTable = dictTable;
        this.dicText = dicText;
    }

    /**
     * 获取字典业务类
     */
    private SysDicValueService sysDicValueService = SpringUtils.getBean("sysDicValueServiceImpl", SysDicValueService.class);

    /**
     * 控制字段在JSON中的输出中，包括原始值和翻译值
     * @param o 待序列化的字段值（如title的值"1"）。
     * @param jsonGenerator Jackson的JSON生成器，用于读取JSON内容
     * @param serializerProvider 序列化上下文，提供配置信息（本方法未使用）
     * @throws IOException
     */
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {

        //获取映射字段的值
        String key = o.toString();
        //将原始字段值写入JSON
        jsonGenerator.writeObject(o);

        if (StringUtils.isNotBlank(key)){
            //对指定的字段进行映射(这里可以去数据库里面通过key，去查询字典表中对应的value)
            String value = "";
            if (StringUtils.isEmpty(dictTable)) {
                value = "这里映射对应的字段的意思";
            } else {
                value = sysDicValueService.findTableText(dictTable, dicText, dicCode, key);
            }
            //将映射的字段和字段值序列化（输出翻译后的字段值）
            jsonGenerator.writeObjectField(fieldName + DICT_APPEND , value);
        }
    }


}
        (2)创建字典表业务类
@Service
public class SysDicValueServiceImpl extends ServiceImpl<SysDicValueMapper, SysDicValue> implements SysDicValueService, ExcelDictService {
    @Override
    public String findTableText(String dicTable, String dicText, String dicCode, String value){

        // 查询新数据
        String text = baseMapper.findTableText(dicTable, dicText, dicCode, value);
        if(StringUtils.isBlank(text)){
            text = "";
        }
        return text;
    }
}
public interface SysDicValueMapper extends BaseMapper<SysDicValue> {
     /**
     * 查找数据字典
     * @param dicTable
     * @param dicText
     * @param dicCode
     * @param value
     * @return
     */
    String findTableText(@Param("dicTable") String dicTable,
                         @Param("dicText") String dicText,
                         @Param("dicCode") String dicCode,
                         @Param("value") String value);
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yf.system.modules.dict.mapper.SysDicValueMapper">
    <select id="findTableText" resultType="String">
        SELECT ${dicText} FROM ${dicTable} WHERE ${dicCode}='${value}' LIMIT 1
    </select>
</mapper>
        (3)进行测试验证

        返回实体类

@Data
@ApiModel(value="问卷学员端列表响应类", description="问卷学员端列表响应类")
public class SurveyClientListRespDTO implements Serializable {

    @ApiModelProperty(value = "ID", required=true)
    private String id;

    @ApiModelProperty(value = "问卷标题", required=true)
    @TestDict(dicCode = "123")
    private String title;

    @TestDict(dicText = "title", dictTable = "el_sys_dic", dicCode = "id")
    private String test;
}

        创建接口（查看自定义注解的映射）

@RestController
@RequestMapping("/api/survey/survey")
public class SurveyController extends BaseController {

    public List<SurveyClientListRespDTO> minePaging() {
        List<SurveyClientListRespDTO> list = new ArrayList<>();
        SurveyClientListRespDTO surveyClientListRespDTO = new SurveyClientListRespDTO();
        //查看1111会映射出来对应的value
        surveyClientListRespDTO.setTitle("1111");
        surveyClientListRespDTO.setId("第一个内容");
        //去对应表里面查询对应id的数据，返回id对应的title信息
        surveyClientListRespDTO.setTest("1924786752627765250");

        SurveyClientListRespDTO surveyClientListRespDTO1 = new SurveyClientListRespDTO();
        surveyClientListRespDTO1.setTitle("2222");
        surveyClientListRespDTO1.setId("第二个内容");
        surveyClientListRespDTO1.setTest("1925359481378607106");

        SurveyClientListRespDTO surveyClientListRespDTO2 = new SurveyClientListRespDTO();
        surveyClientListRespDTO2.setTitle("3333");
        surveyClientListRespDTO2.setId("第三个内容");
        surveyClientListRespDTO2.setTest("1924770834002571266");

        list.add(surveyClientListRespDTO);
        list.add(surveyClientListRespDTO1);
        list.add(surveyClientListRespDTO2);
        return list;
    }
}

        数据库对应的数据

        (4)测试结果

测试用的id的数据都是自己写死的，可以根据自己业务场景使用；

（@TestDict(dicText = "title", dictTable = "el_sys_dic", dicCode = "id")）

返回结果的test的值就是通过查询el_sys_dic表中id对应的数据，映射的值是数据中对应的title信息

java 自定义字典序列化器：使用注解自动转换字典信息（自定义注解转换字典）【字典转换策略】
专注于计算机研发知识和资讯分享
01-03 463
字典项字段基于注解来实现序列化：实现自定义字典序列化注解，在对象进行序列化时，加载指定字典类型，并根据属性值匹配对应的字典项，返回对应字典项信息。序列化时，从注解获取字典类型，再结合字典编码，从redis缓存获取字段内容。需求背景：由于枚举的修改需要更新代码，因此采用字典可以更灵活的维护字典项。因为字典只有两层结构，所以采用主表和明细表结构。降低表结构的复杂性。字典类型、字典编码、字典内容。
Java数组字典自动转换映射
m0_37354578的博客
05-28 4734
一、需求背景 前、后端分离项目，持久化数据部分字段存储的是数据字典的code，而前端查询时需要返回code对应的value值，如果每个请求业务d
java自定义注解实现数据字典映射
suiyishiguang的博客
02-24 3487
java自定义注解实现数据字典映射
自己动手实现一个抽象的字典（java语言）
qq_57220516的博客
09-25 1586
重点是抽象，抽象，抽象
Java 注解与反射
f1220203087的博客
11-27 342
元注解：基本注解类型@Target：用于描述注解可用在哪些范围@Retention：表示注解的生命周期（.java -> .class -> 运行jvm）@Document：该注解被包含在javadoc中@Inherited：子类是否可以继承父类中的注解自定义注解：使用@interface自定义注解//注解可以显示赋值， 如果没有默认值default，我们必须给注解赋值@Myannotation2(name="fsz",schools={"电子科大"})
python 04字典映射
snowy_and_sunny的博客
04-07 817
因此，dict3中，把user的值和num的值都复制过来了，user的值是个字符串，而num的值是列表[1,2,3]的地址dict3中有自己的user值，但num值跟dict1中的值一样，都是指向列表[1,2,3]的地址，所以当列表[1,2,3]发生改变时，dict3和dict1中的num都会改变。实例中 dict2 其实是 dict1 的引用（别名），所以输出结果都是一致的，dict3 父对象进行了深拷贝，不会随dict1 修改而修改，子对象是浅拷贝所以随 dict1 的修改而修改。
python映射的主要特点_Python基础：映射（字典）
weixin_39603050的博客
11-21 668
一、概述映射类型（Mapping Types）是一种关联式的容器类型，它存储了对象与对象之间的映射关系。字典（dict）是Python中唯一的映射类型，它是存储了一个个 键值对（由 键 映射到 值）的关联容器。其中，键（key）必须是可哈希的Python对象，而 值（value）可以是任何Python对象。在功能上，Python中的字典类似于C++中的map。Python中最强大、最灵活的数据类型...
字典映射
JackLiu16的博客
07-17 837
def ctype(old_type): type_map = { "ab1": "AB1112", "cd2": "CD12321", "ef3": "EF" } return type_map[old_type] l = {"ab&q
映射 字典
m0_37896011的博客
07-23 602
字典是由多个键值对组成，键可以是数字，字符串，元组（即任何不可变类型），但字典中的键是唯一的，值也可以是任意数据结构，值不唯一 键和值之间用冒号：隔开，键值对与键值对之间用逗号,隔开   整个字典用大括号括起来{} 创建方式： 有两种创建方式，1用字典的定义方式，键值对表示，2用dict函数 &gt;&gt;&gt; stuno={'cc':'011','zm':'016','wyj':...
Redis数据结构(三)-字典(映射)
星光之子的博客
09-30 371
字典概述字典的实现哈希表哈希表节点字典dictType结构哈希算法解决键冲突rehash(重要!!!)哈希表的扩展/收缩触发场景(重要!!!)负载因子计算公式渐进式rehash(重要!!!)字典(的)API 概述 字典，又称为符号表（symbol table）、关联数组（associative array）或映射（map），是一种用于保存 键值对（key-value pair）的抽象数据结构 在字典中，一个键（key）可以和一个值（value）进行关联（或者说将键映射为值），这些关联的键和值就称为键值对 字
自定义注解实现数据字典映射
最新发布
03-26
### 自定义注解实现数据字典映射 #### 背景说明 在实际开发过程中，当项目中涉及大量数据字典的配置时，通常会面临代码冗余和可维护性下降的问题。为了提升代码质量并简化逻辑处理流程，可以采用自定义注解的方式...
springboot 实现REST接口返回自动拼接字典映射数据
u014682892的博客
08-19 1371
springboot http 请求返参自定义修改 字典映射
【Java系列】：枚举和注解
Baridhu的博客
03-11 784
本文详细讲解了枚举类并对注解进行了简单概述。
Python之第六章 内置容器 --- 字典（映射）
qq_57289939的博客
10-28 1208
Python之第六章 内置容器 --- 字典（映射）
Go语言程序设计（六）字典（映射）
琅琊之榜
07-06 385
在Go语言中,Map是一种特殊的数据结构,它由一对无序的数据项组成,被称为键值对(Key-value Pair)。其中的一项是键(Key),另外一项是值(Value), Map通过把键映射到值来进行访问，这种方式可以加快数据查找的速度。所以，Map通常也被称作字典(Dictionary)或哈希表(Hash table) ,本文统一称为“字典"。
java字段映射配置,mybati 字段映射
weixin_34688966的博客
03-21 1118
Java中属性命名一般使用驼峰命名法，mysql中的字段一般使用“_”来连接两个单词。例如mysql中一般都是admin_id 而不是adminId，java程序中在dao层定义的话一般都是adminId 通过驼峰法来命名字段。没有处理的情况下mysql字段和java中字段不匹配，通过SELECT 获取不到数据。需要先通过字段映射，二字段映射一般有三种情况1设置别名，返回列的别名和Model...
映射类型：字典
顿了
01-02 4120
字典：如果想将值分组到一个结构中，并且通过编号对其进行引用，列表就能派上用场了。字典是一种通过名字引用值的数据结构，字典中的值并没有特殊的顺序，但是都是存储在一个特定的键(Key)里，键可以是数字、字符串或者元组。 1.如何创建字典和给字典赋值 创建字典只需要把字典赋值给一个变量，不管这个字典是否包含元素。赋值创建字典 , key-value , 键值对 d = {"key
Python数据容器：dict(字典、映射)
weixin_48060069的博客
09-12 1067
字典同样使用{}，不过存储的元素是一个一个的键值对，语法如下：定义空字典：my_dict = {} # 空字典定义方式1my_dict = dict() # 空字典定义方式2字典的key是不允许重复的，当定义了重复的key时，后面的 键值对 会把前面的 键值对 覆盖掉（只保留最后一个）。字典同集合一样，不可以使用下标索引，但是字典可以通过Key值来取得对应的Value。字典的key不可以为字典。字典有如下特点：1、可以容纳多个数据。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值