Java 中 @JsonFilter 注释的重要性?

javajsonobject oriented programmingprogramming更新于 2025/7/24 22:36:17

@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";
}