Boon-@JsonInclude

Boon-@JsonInclude 是一个基于 Boon JSON 库的注解，用于更精确地控制 Java 对象序列化为 JSON 字符串时包含或排除某些属性。该注解可以用于类、字段、方法三个级别。

用法

引入依赖

<dependency>
    <groupId>io.advantageous.boon</groupId>
    <artifactId>boon-json</artifactId>
    <version>0.37.0</version>
</dependency>

序列化时包含指定属性

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private String name;
    private Integer age;
    private String email;
    // getter、setter
}

使用 @JsonInclude(JsonInclude.Include.NON_NULL) 注解可表示只包含属性值不为 null 的字段。也可以使用 JsonInclude.Include.NON_EMPTY 表示只包含属性值非 null 且非空值的字段。

序列化时排除指定属性

public class User {
    private String name;
    @JsonIgnore
    private Integer age;
    private String email;
    // getter、setter
}

使用 @JsonIgnore 注解可表示排除该字段。也可以使用 @JsonInclude(JsonInclude.Include.NON_DEFAULT) 表示排除默认值字段。

序列化时自定义过滤器

@JsonFilter("myFilter")
public class User {
    private String name;
    private Integer age;
    private String email;
    // getter、setter
}

ObjectMapper objectMapper = new ObjectMapper();
SimpleFilterProvider filterProvider = new SimpleFilterProvider()
        .addFilter("myFilter", SimpleBeanPropertyFilter.filterOutAllExcept("name"));
objectMapper.setFilterProvider(filterProvider);

使用 @JsonFilter("myFilter") 注解可表示开启自定义过滤器，可以通过 ObjectMapper 的 filterOutAllExcept 方法实现过滤器过滤属性的名称。

总结

Boon-@JsonInclude 提供了非常灵活的属性控制，可以根据实际业务情况选择不同的使用方式，以实现最大程度的定制化。