该@JsonFilter注解用于定义一个自定义过滤器序列化的Java对象。我们需要使用FilterProvider 类来定义一个过滤器并获取实际的过滤器实例。现在,通过将FilterProvider 分配给ObjectMapper 类来配置过滤器。
@Target(value={ANNOTATION_TYPE,TYPE,METHOD,FIELD,PARAMETER}) @Retention(value=RUNTIME) public @interface JsonFilter
在下面的示例中,可以将customFilter 声明为@JsonFilter批注的参数,以仅提取名称并滤除bean的其他属性。
import com.fasterxml.jackson.annotation.JsonFilter; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ser.FilterProvider; import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter; import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider; public class JsonFilterAnnotationTest { public static void main(String args[]) throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); FilterProvider filterProvider = new SimpleFilterProvider().addFilter("customFilter", SimpleBeanPropertyFilter.filterOutAllExcept("empName")); String jsonString = mapper.writer(filterProvider).writeValueAsString(new FilterBean()); System.out.println(jsonString); } } @JsonFilter("customFilter")class FilterBean { public int empId = 110; public String empName = "Raja Ramesh"; public String gender = "male"; }
输出结果
{"empName":"Raja Ramesh"}