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

前言

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

方法介绍

方法一、fastjson的注解

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

@JSONField(serialize = false)
private String password;

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

方法二、Java关键字

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

private transient String password;

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

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

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

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

这个方法可以过滤掉属性字段id和password，这里使用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));

这样就是只序列化传入的id和name了。

总结：

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

建议：

自定制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);
    }

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

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