FastJson toString过滤指定的对象属性

最近在做一个需求时，遇到一个问题，在把Java对象用fastjson转成json字符串时，需要过滤掉Java对象中的指定属性，通过搜索资料，解决了该问题，这里做个总结，具体实现可以参考本文中介绍的几种方式。

数据样例

本文中用到的Java对象结构和使用的对象实例分别如下：

对象结构

public class Persion {

private String id;
private String name;
private int age;

public Persion(String id, String name, int age) {
this.id = id;
this.name = name;
this.age = age;
}

public String getId() {
return id;
}

public void setId(String id) {
this.id = id;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public int getAge() {
return age;
}

public void setAge(int age) {
this.age = age;
}

}

对象实例

Persion persion = new Persion("10010", "jason", 101);

正常的json字符串如下：

{"age":101,"id":"10010","name":"jason"}

一、使用transient关键字

把需要过滤掉属性使用

transient

关键字修饰，这样在调用JSON的

toString

方法时，被

transient

修饰的属性不会出现在最终的json字符串中，举例如下：

private transient String id;

再调用

JSON.toString（）

方法时，

id

属性将被过滤掉，结果如下：

{"age":101,"name":"jason"}

二、使用注解

还是以

id

属性为例，使用注解

@JSONField(serialize=false)

，示例如下：

@JSONField(serialize=false)
private String id;

同样，再调用

JSON.toString（）

方法时，

id

属性将被过滤掉，结果如下：

{"age":101,"name":"jason"}

三、使用属性过滤器PropertyFilter

使用过滤器

PropertyFilter

，使用示例如下：

//创建Java对象
Persion persion = new Persion("10010", "jason", 101);
//创建PropertyFilter对象，并重载apply方法
PropertyFilter propertyFilter = new PropertyFilter(){
boolean flag = true;
@Override
public boolean apply(Object obj, String name, Object value) {
if(name.equalsIgnoreCase("id")){
flag = false;
}
return flag;
}

};
//调用toJSONString方法时，传入PropertyFilter对象
String jsonStr = JSON.toJSONString(persion, propertyFilter);

得到的json字符串如下：

{"age":101,"name":"jason"}

PropertyFilter属性过滤器说明：

（1）当apply方法返回TRUE时，该属性输出到json字符串中，apply方法的Java doc如下：

/**
* @param object the owner of the property
* @param name the name of the property
* @param value the value of the property
* @return true if the property will be filtered out, false otherwise
*/
boolean apply(Object object, String name, Object value);

（2）可以同时使用

属性名

和

属性值

过滤，示例如下：

@Override
public boolean apply(Object obj, String name, Object value) {
if(name.equalsIgnoreCase("id") && "10011".equals(value)){
flag = false;
}else{
flag = true;
}
return flag;
}

实现的效果为只过滤掉属性名称为

id

且

id

取值为

10011

的属性，结果如下：

{"age":101,"id":"10010","name":"jason"}

这里id并没有被过滤掉，因为value取值不是

10011

。

（3）警告：

如果某一个属性使得

flag

取值为

false

，后续所有的flag将都为fasle，导致属性均不输出，为了避免这样的错误出现，所以（2）中的示例中增加了

else{ flag = true;}

代码。

四、使用属性过滤器SimplePropertyPreFilter

示例如下，只有出现在SimplePropertyPreFilter构造器参数中的属性才会被输出：

SimplePropertyPreFilter simplePropertyPreFilter =
new SimplePropertyPreFilter(Persion.class, "name", "age");

输出json结果如下：

{"age":101,"name":"jason"}

属性

id

未被输出，因为

id

未传入SimplePropertyPreFilter构造器参数。

五、方式对比

transient

关键字和注解的优先级高于属性过滤器，即如下情形都将导致属性过滤器不起作用。：

同时使用

transient

关键字和属性过滤器；

同时使用注解和属性过滤器；

使用属性过滤器PropertyFilter最为灵活，不仅可以根据属性名过滤，还可以根据属性取值过滤。