Java @JsonInclude注解的使用|极客笔记

Java @JsonInclude注解的使用

在使用Java进行开发过程中，经常需要将对象序列化为JSON格式，以便于在网络传输或存储中进行数据交换。在序列化过程中，有时候我们只希望包含某些特定的属性，而排除其他属性。这时候就可以使用@JsonInclude注解来控制序列化过程中哪些属性应该被包含。

@JsonInclude注解概述

@JsonInclude注解是Jackson库提供的一个注解，用于控制对象在序列化为JSON格式时包含哪些属性。通过在类或属性上添加@JsonInclude注解，可以灵活地控制JSON序列化的过程。

@JsonInclude注解有以下几种属性值：

JsonInclude.Include.ALWAYS：始终包含指定属性，即使属性值为null；
JsonInclude.Include.NON_NULL：只包含不为null的属性；
JsonInclude.Include.NON_DEFAULT：只包含属性值为非默认值的属性；
JsonInclude.Include.NON_EMPTY：只包含不为空的属性。

@JsonInclude注解的使用示例

下面通过一个简单的示例来演示如何使用@JsonInclude注解。

假设我们有一个User类，包含id、name和age三个属性：

import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private Long id;
    private String name;
    private Integer age;

    // 省略构造方法和getter、setter方法
}

在上面的示例中，我们在User类上添加了@JsonInclude注解，并指定为JsonInclude.Include.NON_NULL，表示只包含不为null的属性。

下面我们来编写一个简单的测试类，将User对象序列化为JSON字符串：

import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonIncludeExample {
    public static void main(String[] args) throws Exception {
        User user = new User();
        user.setId(1L);
        user.setName("Alice");
        // 年龄属性为null

        ObjectMapper mapper = new ObjectMapper();
        String json = mapper.writeValueAsString(user);
        System.out.println(json);
    }
}

运行上面的测试类，我们会得到如下输出：