fastjson使用toJSONString序列化过滤属性字段详解

image.png

前言

开发中使用fastjson调用toJSONString()方法进行序列化时,经常会遇到根据需求需要过滤掉一些不需要的属性字段,那么使用fastjson如何来实现呢?这里来给大家简单讲解一下使用fastjson序列化时过滤属性字段的几种方法及使用注意。

方法介绍

方法一、fastjson的注解

fastjson中有个注解@JSONField(serialize = false)可以在使用fastjson进行序列化时来过滤属性字段,具体用法是直接在实体类需要过滤的属性字段上方添加该注解即可,如下:

@JSONField(serialize = false)
private String password;

该方法是最便捷,如果需求是所有用到的地方都需要过滤该字段,那么可以说这是最好的解决方法。但可能有些需求并不是所有用到的地方都需要过滤该字段,还有些用到的地方可能还不能过滤掉,这样的话就不太适合使用该方法了。

方法二、Java关键字

其实Java自带的有一个属性关键字transient是忽略序列化的,如下:

private transient String password;

使用该关键字进行修饰的字段是不参与序列化的,所以在使用fastjsonJSON字符串时就可以忽略掉该字段。但是因为是Java关键字是忽略所有的序列化的,所以也会影响该字段其他的序列化操作,如果会用到其他的序列化操作并且不需要忽略该字段的话,建议使用方法一。如果只有fastjson的转JSON字符串操作需要忽略,使用该方法也挺合适的。

方法三、fastjson的属性名过滤器

fastjsontoJSONString()方法其实除了传入实体类,还可以传入一个过滤器的参数,同时fastjson也提供了过滤器的实现类,如下:

    SimplePropertyPreFilter filter = new SimplePropertyPreFilter();
    filter.getExcludes().add("id");  
    filter.getExcludes().add("password");
    System.out.println(JSON.toJSONString(user, filter));

这个方法可以过滤掉属性字段idpassword,这里使用JSON.toJSONString(user, filter)其实还有一点小问题,就是这个方法是默认过滤忽略掉值为null的属性字段的。要解决这个问题就需要换个方法,fastjson还提供了另外的方法如下:

public static String toJSONString(Object object, SerializeFilter[] filters, SerializerFeature... features)

这个方法需要传入的过滤器是一个数组和fastjson定义的属性特性的枚举features,上边的代码可以修改一下即可,如下:

    SimplePropertyPreFilter filter = new SimplePropertyPreFilter();
    filter.getExcludes().add("id");
    filter.getExcludes().add("password");
    SerializeFilter[] filters = {filter};
    System.out.println(JSON.toJSONString(user, filters, SerializerFeature.WriteMapNullValue));

这里的SerializerFeature.WriteMapNullValue就是设置在序列化时不忽略值为null的属性字段。
上边的这种方法适合需要过滤的属性字段比较少时候使用。

如果需要过滤掉的属性字段比较多,而需要保留的属性字段比较少,也可以反过来使用filter.getIncludes().add("name")的方式来包含指定的字段,其他字段全部过滤掉。还可以直接在new的时候带上,这里是可变参数,可以同时指定多个,如下:

    SimplePropertyPreFilter filter = new SimplePropertyPreFilter("id", "name");
    SerializeFilter[] filters = {filter};
    System.out.println(JSON.toJSONString(user, filters, SerializerFeature.WriteMapNullValue));

这样就是只序列化传入的idname了。

总结:

以上三种方法都各有利弊。
方法一和方法二:最简单便捷,但是使用不够灵活,适用于一些固定的需求。
方法三:使用比较灵活,但是用起来会代码比较繁琐。

建议:

自定制JSONUtils工具类将方法三进行封装成如下方法:

public static String toJSONString(Object object, String[] filterFields) {
        if (filterFields != null && filterFields.length > 0) {
            SimplePropertyPreFilter filter = new SimplePropertyPreFilter();
            for (String field : filterFields) {
                filter.getExcludes().add(field);
            }
            SerializeFilter[] filters = {filter};
            return JSON.toJSONString(object, filters,
                    SerializerFeature.WriteMapNullValue);
        }
        return JSON.toJSONString(object,
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullListAsEmpty);
    }

这样在使用的时候就方便多了。这个封装只是提供一个思路,实现的比较简单,大家可以根据自己的需求来进行相适应的封装。

最后,希望可以帮助到有需要的码友。

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

推荐阅读更多精彩内容