使用 Jackson 序列化时如何仅包含特定属性

Question

我正在尝试实现一种将给定对象序列化为 JSON 的通用方法，但仅限于在集合中传递的那些属性。如果可能的话，我想在不指定 @JsonFilter 的情况下获得此功能。为此，我尝试使用 Jackson 2.4.1 中的 FilterExceptFilter。依赖：

• jackson-core-2.4.1.jar
• jackson-databind-2.4.1.jar
• jackson-annotations-2.4.0.jar

这是我目前拥有的：

public static String serializeOnlyGivenFields(Object o,
                    Collection<String> fields) throws JsonProcessingException {
    if ((fields == null) || fields.isEmpty()) return null;

    Set<String> properties = new HashSet<String>(fields);

    SimpleBeanPropertyFilter filter =
        new SimpleBeanPropertyFilter.FilterExceptFilter(properties);
    SimpleFilterProvider fProvider = new SimpleFilterProvider();
    fProvider.addFilter("fieldFilter", filter);
    fProvider.setDefaultFilter(filter);

    ObjectMapper mapper = new ObjectMapper();
    mapper.setFilters(fProvider);

    String json = mapper.writeValueAsString(o);
    return json;
}

但是，过滤器永远不会应用。它总是序列化所有属性。

Set<String> fields = new HashSet<String>(); fields.add("name");
String json = Serializer.serializeOnlyGivenFields(e, fields);
System.out.println(json);

{"name":"测试实体","description":"测试描述"}

我也尝试注册FilterProvider on the ObjectWriter，但结果相同：

String json = mapper.writer(fProvider).writeValueAsString(o);

我错过了什么？有没有一种很好的方法可以通过 Jackson 实现这一目标？

Answer 1

基于http://www.cowtowncoder.com/blog/archives/2011/09/entry_461.html，另一种设置过滤器的方法是设置一个扩展JacksonAnnotationIntrospector 并覆盖findFilterId 的类。然后，您可以指定在 findFilterId 中查找您的过滤器。如果您希望基于其他一些地图或算法，这可以变得同样健壮。下面是示例代码。不确定性能是否比上面的解决方案更好，但它似乎更简单并且可能更容易扩展。我这样做是为了使用 Jackson 序列化 CSV。欢迎任何反馈！

public class JSON {

private static String FILTER_NAME = "fieldFilter";

public static String serializeOnlyGivenFields(Object o,
                                              Collection<String> fields) throws JsonProcessingException {
    if ((fields == null) || fields.isEmpty()) fields = new HashSet<String>();

    Set<String> properties = new HashSet<String>(fields);

    SimpleBeanPropertyFilter filter =
            new SimpleBeanPropertyFilter.FilterExceptFilter(properties);
    SimpleFilterProvider fProvider = new SimpleFilterProvider();
    fProvider.addFilter(FILTER_NAME, filter);

    ObjectMapper mapper = new ObjectMapper();
    mapper.setAnnotationIntrospector( new AnnotationIntrospector() );

    String json = mapper.writer(fProvider).writeValueAsString(o);
    return json;
}

private static class AnnotationIntrospector extends JacksonAnnotationIntrospector {
    @Override
    public Object findFilterId(Annotated a) {
        return FILTER_NAME;
    }
}

}

Answer 2

另外一件事是，您必须通过@JsonFilter 注解指明要使用过滤器的 Java 类：

@JsonFilter("fieldFilter") public class MyType { }

然后它应该适用。

Answer 3

我找到了基于Jackson: How to add custom property to the JSON without modifying the POJO 的解决方案。我覆盖 BeanSerializer#serializeFields 以始终使用 BeanSerializer#serializeFieldsFiltered 代替。这样过滤器就会一直应用。

性能方面不是一个很好的解决方案，因为必须在每次方法调用时构造一个ObjectMapper。随时发布改进或建议！

模块实现：

public class FilteredModule extends SimpleModule {
    private static final long serialVersionUID = 1L;

    @Override
    public void setupModule(SetupContext context) {
        super.setupModule(context);

        context.addBeanSerializerModifier(new BeanSerializerModifier() {

            @Override
            public JsonSerializer<?> modifySerializer(
                    SerializationConfig config,
                    BeanDescription beanDesc,
                    JsonSerializer<?> serializer) {
                if (serializer instanceof BeanSerializerBase) { 
                    return new FilteredBeanSerializer(
                            (BeanSerializerBase) serializer);
                } 
                return serializer; 

            }                   
        });
    }

    private class FilteredBeanSerializer extends BeanSerializer {

        public FilteredBeanSerializer(BeanSerializerBase source) {
            super(source);
        }

        @Override
        protected void serializeFields(Object arg0, JsonGenerator arg1,
                SerializerProvider arg2) throws IOException,
                JsonGenerationException {
            super.serializeFieldsFiltered(arg0, arg1, arg2);
        }

    }
}

API 方法：

public static String serializeOnlyGivenFields(Object o,
            Collection<String> fields) throws JsonProcessingException {
    if ((fields == null) || fields.isEmpty()) fields = new HashSet<String>();

    Set<String> properties = new HashSet<String>(fields);

    SimpleBeanPropertyFilter filter =
            new SimpleBeanPropertyFilter.FilterExceptFilter(properties);
    SimpleFilterProvider fProvider = new SimpleFilterProvider();
    fProvider.addFilter("fieldFilter", filter);
    fProvider.setDefaultFilter(filter);

    ObjectMapper mapper = new ObjectMapper();
    mapper.registerModule(new FilteredModule());

    String json = mapper.writer(fProvider).writeValueAsString(o);
    return json;
}

示例

Entity e = new Entity("Test entity", "Test description");   
Set<String> fields = new HashSet<String>(); fields.add("name");
String json = JSON.serializeOnlyGivenFields(e, fields);
System.out.println(json);

{"name":"测试实体"}

基准测试： 对同一对象进行 1000 次迭代

serializeOnlyGivenFields:           536 ms
serialize (reuses ObjectMapper):    23 ms