自定义注解valuefilter(自定义注解使用场景)
Jackson全面解析--注解全讲解九(过滤无用信息@JsonInclude)
当我们在序列一个DTO给到前端的时候,如果说DTO里面的属性很多都是null的,如下
其实这些为null的数据序列化之后,对前端来说,没有任何的意义,那是否在序列化的时候我们可以将这个为null的字段去除呢,Jackson提供了@JsonInclude的注解来实现这个功能,@JsonInclude注解提供了四个属性
1 value 一般来说,pojo中只有简单的属性的话,只需要使用此value配置就可以了
2 content 但是在pojo中可能包含复杂的复合对象,比如map和optional,需要进一步的判断此复合对象的内容是否为空的时候,就可以使用到此配置
3 valueFilter 如果Jackson提供的value配置都不能满足你的要求的话,我们可以自定义value的过滤器,由我们自己来决定哪些字段是否序列化
4 contentFilter 如果Jackson提供的content配置都不能满足你的要求的话,我们可以自定义content的过滤器,由我们自己来决定哪些复杂的复合属性是否序列化
对于value和content两个属性,Jackson提供了几个默认的序列化策略
1 ALWAYS 默认级别,所有的pojo的属性都会被序列化
2 NON_NULL 只有非null的属性才会被序列化
3 NON_ABSENT java中有些复杂的数据结构,比如AtomicReference或是Optional,如果某个属性是这个类型,虽然此属性不为null,但是其包装的内容是null的,此注解的作用是,只有此属性不为null,且其包装的内容是有值的才会被序列化
4 NON_EMPTY 不为空,有些属性如果是Collection或是Map或是Timestamp等,比如某个属性是Timestamp且其值是0,那么可以认为这个属性是empty
5 NON_DEFAULT 只有此属性不为默认值的时候,才序列化
6 CUSTOM 自定义,filter定义的过滤器需要重写equals方法,如果返回false,那么进行序列化,如果为true,就不序列化
7 USE_DEFAULTS 使用默认
介绍完之后,还是用上面的例子
但是att3我们认为也不该序列化出来,所以我们再修改如下
一般来说在Jackson提供的序列化级别中
NON_EMPTY NON_ABSENT NON_NULL ALWAYS
我们只需要配置成NON_EMPTY就可以解决很多的问题,但是我在本地遇到了个这问题
如下
照理说按照Jackson的说法,att3不应该序列化出来,暂时未知原因,不过既然@JsonInclude提供了自定义的filter我们也可以将此种情况下att3不序列化出来如下