Jackson 序列号字典字段属性

Jackson 序列号字典字段属性

Jackson 序列号字典字段属性

前言场景正文

一 添加配置二 添加项目内省器三 自定义序列化规则四 字典缓存工具五 测试对象六 测试接口七 测试结果 总结

前言

在前后端分离的项目中，存在很多字段是下拉框选项的情况。
比如：性别字段

代码值value显示值label1男0女2其他

在数据库中，存的是代码值，前端显示的时候，需要显示值。这时候，在返回的时候，就需要做一次代码转换。
（为什么不是前端自己转换？为了统一管理和方便变更。）

场景

字典字段为空，则不转换。一个对象中的多个字段是字典字段。对象中的子对象也有字典字段。对象的子对象是集合，也存在字典字段。 正文

因为在业务开发过程中，存在非常多的这种实体，所以需要制定一个统一处理。减少业务开发的工作量。
（最终结果，减少到只需要一行注解）

一 添加配置

项目中都有 fasterxml 的依赖吧，没有自己添加。
添加类 JacksonConfig，用于配置自定义内省器。

import com.cah.project.conf.serializer.ProjectJacksonAnnotationIntrospector;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;


@Configuration
public class JacksonConfig {

    public JacksonConfig() {}

    @Bean
    @Primary
    @ConditionalOnMissingBean({ObjectMapper.class})
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        // 定义 不为空，才能进行序列化
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        // 添加 自定义 项目注解内省器
        objectMapper.setAnnotationIntrospector(new ProjectJacksonAnnotationIntrospector());
        return objectMapper;
    }

}

二 添加项目内省器

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


public class ProjectJacksonAnnotationIntrospector extends JacksonAnnotationIntrospector {

    public ProjectJacksonAnnotationIntrospector() {}

    @Override
    public Object findSerializer(Annotated a) {
        // 如果是字典注解
        Dict dict = _findAnnotation(a, Dict.class);
        if(dict != null) {
            return new DictSerializer(dict.type(), dict.separator());
        }
        // 其他扩展。。。
        return super.findSerializer(a);
    }

}

其中 Dict 注解类 为自定义注解。内容如下：

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)
public @interface Dict {

    
    String type();
    
    String desc() default "";
    
    String separator() default ",";

}

三 自定义序列化规则

import com.cah.project.core.cache.DictCacheUtil;
import com.cah.project.core.domain.bo.DictData;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;


public class DictSerializer extends StdSerializer