如何动态忽略Jackson序列化上的属性

Question

我有一个实体具有多个@ManyToOne关联。我正在使用spring-boot公开一个REST API。目前，我有多个REST API，它们返回整个实体的JSON响应，包括关联。

但我不想序列化所有REST API中的所有关联对象。

例如：

• API-1应返回parent+associationA对象
• API-2应返回parent+associationA+associationB对象
• API-3应返回parent+associationB+associationC+AssociationOnd

注意：我对每一个都使用相同的类；我对为每个API创建DTO不感兴趣。

任何建议都非常感谢。

Answer 1

我将在Jackson中执行动态过滤的三种方法放在一起。其中一个必须适合你的需要。

您可以使用@jsonview:

public class Views {         
    interface Simple { }  
    interface Detailed extends Simple { }   
}

public class Foo {

    @JsonView(Views.Simple.class)
    private String name;

    @JsonView(Views.Detailed.class)
    private String details;

    // Getters and setters
}

@RequestMapping("/foo")
@JsonView(Views.Detailed.class)
public Foo getFoo() {
    Foo foo = new Foo();
    return foo;
}

或者，您可以使用mappingjacksonvalue动态设置视图。

@RequestMapping("/foo")
public MappingJacksonValue getFoo() {
    Foo foo = new Foo();
    MappingJacksonValue result = new MappingJacksonValue(foo);
    result.setSerializationView(Views.Detailed.class);
    return result;
}

public class CustomSerializerModifier extends BeanSerializerModifier {

    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config,
        BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {

        // In this method you can add, remove or replace any of passed properties

        return beanProperties;
    }
}

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new SimpleModule() {

    @Override
    public void setupModule(SetupContext context) {
        super.setupModule(context);
        context.addBeanSerializerModifier(new CustomSerializerModifier());
    }
});

查看这里和这里的示例。

另一种方法涉及@jsonfilter:

@JsonFilter("customPropertyFilter")
public class Foo {

    private String name;
    private String details;

    // Getters and setters
}

根据需要扩展SimpleBeanPropertyFilter并重写SerializeAsField()方法：

public class CustomPropertyFilter extends SimpleBeanPropertyFilter {

    @Override
    public void serializeAsField(Object pojo, JsonGenerator jgen,
                                 SerializerProvider provider, 
                                 PropertyWriter writer) throws Exception {

        // Serialize a field
        // writer.serializeAsField(pojo, jgen, provider, writer);

        // Omit a field from serialization
        // writer.serializeAsOmittedField(pojo, jgen, provider);
    }
}

FilterProvider filterProvider = new SimpleFilterProvider()
        .addFilter("customPropertyFilter", new CustomPropertyFilter());

ObjectMapper mapper = new ObjectMapper();
mapper.setFilterProvider(filterProvider);

如果希望使筛选器“全局”，即应用于所有bean，可以创建一个mix-in类，并使用@JSONFilter（“CustomPropertyFilter”）对其进行注释：

@JsonFilter("customPropertyFilter")
public class CustomPropertyFilterMixIn {

}

然后将mix-in类绑定到object:

mapper.addMixIn(Object.class, CustomPropertyFilterMixIn.class);