spring MVC 中使用Jackson自定义转化json数据

一、关于Jackson

spring MVC 默认采用的Jackson 来处理Json 数据,所以不用额外去配置


二、项目演示

demo 使用spring-boot项目


三、情景介绍
  1. 在前后台分离的项目中,后端纯写Http接口,返回和接收的数据均为json

2.如果返回的Java对象属性为 null ,Jackson 在做数据转化时也会转为null,
此时转化后的数据可能为如下这样,属性 array,name 对应的值为 null

{"array":null,"name":null}

3.前端接收这个数据时可能就会有点不太方便。对于数组类型来说,如果数组中的元素个数为0,那么转化后的json 应该为 [],而字符为null 时则应该变为成 ""

 {"array":[],"name":""}

4.对于对象为null 的属性,我们也可以过滤掉,也是不参与序列化成json ,返回的对象类上加@JsonInclude(JsonInclude.Include.NON_NULL) 注解。


四、代码展示

1.创建自定义的jsonSerializer

这个两个serializer 都是当属性为Null 时才会使用

public class MyNullArrayJsonSerializer extends JsonSerializer<Object> {

@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
    if (value == null) {
        jgen.writeStartArray();
        jgen.writeEndArray();
    } else {
        jgen.writeObject(value);
    }
}}

public class MyNullObjectJsonSerializer extends JsonSerializer<Object> {

@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
    if (value == null) {
        jgen.writeString("");
    } else {
        jgen.writeObject(value);
    }
}
}

date -> string 转化,用于统一格式化时间

public class DateJsonSerializer extends JsonSerializer<Object> {

@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
    if (value == null) {
        jgen.writeString("");
    } else {
        try {
            Date date = (Date) value;
            SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd");
            String format = sf.format(date);
            jgen.writeString(format);
        } catch (Exception e) {
            e.printStackTrace();
            jgen.writeString("");
        }

    }
}

}

2.新建 MyBeanSerializerModifier.java 类 ,我们可以在 changeProperties() 方法中判断要转换的属性类型,然后再分配一个 JsonSerializer 对象给BeanPropertyWriter 对象。

writer.assignNullSerializer(this._nullArrayJsonSerializer);
指定一个serializer ,当属性是Null 的时候,Jackson 会调用这个serializer 会序列化这个属性
writer.assignSerializer(this.dateJsonSerializer);
这个方法,直接指定一个serializer 无论属性是否为空,都使用这对象转化去转化 json 数据。
public class MyBeanSerializerModifier extends BeanSerializerModifier {

private JsonSerializer<Object> _nullArrayJsonSerializer = new MyNullArrayJsonSerializer();
private JsonSerializer<Object> _nullObjectJsonSerializer = new MyNullObjectJsonSerializer();
private JsonSerializer<Object> dateJsonSerializer = new DateJsonSerializer();
@Override
public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc,
                                                 List<BeanPropertyWriter> beanProperties) {
    // 循环所有的beanPropertyWriter
    for (int i = 0; i < beanProperties.size(); i++) {
        BeanPropertyWriter writer = beanProperties.get(i);
        // 判断字段的类型,如果是array,list,set则注册nullSerializer
        if (isArrayType(writer)) {
            //给writer注册一个自己的nullSerializer
            writer.assignNullSerializer(this._nullArrayJsonSerializer);
        }else if(isStringType(writer)){
            writer.assignNullSerializer(this._nullObjectJsonSerializer);
        }else if(isDateType(writer)){
            writer.assignSerializer(this.dateJsonSerializer);
        }
    }
    return beanProperties;
}

private boolean isDateType(BeanPropertyWriter writer) {
    Class<?> clazz = writer.getPropertyType();
    return clazz.equals(Date.class);

}

private boolean isStringType(BeanPropertyWriter writer) {
    Class<?> clazz = writer.getPropertyType();
    return  clazz.equals(CharSequence.class) || clazz.equals(String.class);

}

private boolean isArrayType(BeanPropertyWriter writer) {
    Class<?> clazz = writer.getPropertyType();
    return clazz.isArray() || clazz.equals(List.class) || clazz.equals(Set.class);

}

}

3.把下列bean 对象注册到spring中,对于Jackson 的自定义配置就完成了

对于date 类型做了批量的格式化,全部会被 转化为yyyy-MM-dd 格式。
对于数组 为Null 时对应的json值会是 []。
对于字符为Null 对应的json 值为字符串空 ""。

@Bean
public MappingJackson2HttpMessageConverter mappingJacksonHttpMessageConverter() {

    final MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    ObjectMapper mapper = converter.getObjectMapper();

    mapper.setSerializerFactory(mapper.getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));

    converter.setSupportedMediaTypes(ImmutableList.of(MediaType.TEXT_HTML, MediaType.APPLICATION_JSON));

    return converter;
}

4.测试使用@RestController 类中方法返回一个对象简单测试

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容