Spring:jackson-annotaions注解大全

文章目录

一、介绍

jackson-annotations 是 Jackson 库的一部分,它提供了一系列注解,用于控制 Java 对象与 JSON 之间的序列化和反序列化过程。

二、@JsonProperty

用于指定 Java 类的属性名与 JSON 中的字段名之间的映射关系。

复制代码
public class User {  
    @JsonProperty("user_name")  
    private String name;  

    // getters and setters  
}

在上面的例子中,Java 对象的 name 属性将被序列化为 JSON 字段 user_name。

三、@JsonIgnore

用于指定某个 Java 类的属性在序列化为 JSON 时被忽略。

复制代码
public class User {  
    private String name;  

    @JsonIgnore  
    private String password;  

    // getters and setters  
}

在上面的例子中,password 属性在序列化为 JSON 时将被忽略。

四、@JsonInclude

用于指定在序列化时哪些值应该被包含。例如,可以使用 @JsonInclude(Include.NON_NULL) 来只包含非空值。

复制代码
@JsonInclude(Include.NON_NULL)  
public class User {  
    private String name;  
    private String email;  

    // getters and setters  
}

在上面的例子中,如果 email 为 null,则不会被包含在序列化的 JSON 中。

五、@JsonFormat

用于自定义日期和时间的格式。

复制代码
public class Event {  
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")  
    private Date eventDate;  

    // getters and setters  
}

在上面的例子中,eventDate 属性将按照指定的日期时间格式进行序列化和反序列化。

六、@JsonCreator 和 @JsonProperty (在构造函数中)

用于自定义反序列化时的构造函数。

复制代码
public class User {  
    private String name;  
    private int age;  

    @JsonCreator  
    public User(@JsonProperty("user_name") String name, @JsonProperty("user_age") int age) {  
        this.name = name;  
        this.age = age;  
    }  

    // getters and setters  
}

在上面的例子中,我们使用了一个带有 @JsonCreator 注解的构造函数,并使用 @JsonProperty 注解来指定 JSON 字段与 Java 构造函数参数之间的映射关系。

七、@JsonTypeName 和 @JsonTypeInfo

用于处理多态类型。

复制代码
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")  
@JsonTypeName("employee")  
public class Employee {  
    // ...  
}  

public class Manager extends Employee {  
    // ...  
}

在上面的例子中,Employee 和 Manager 类都可以被序列化为 JSON,并且包含一个 type 字段来指示对象的实际类型。反序列化时,可以根据这个 type 字段来创建正确的对象实例。

八、@JsonIgnoreProperties

  • 作用:在序列化或反序列化时忽略Java Bean中的某些属性。
  • 示例:@JsonIgnoreProperties({"propertyName1", "propertyName2"})
  • 注意:这是一个类注解,可以指定多个要忽略的属性名。

九、@JsonSerialize

  • 作用:用于自定义属性的序列化方式。
  • 示例:配合自定义的序列化器使用,如@JsonSerialize(using = CustomSerializer.class)
  • 注意:可以作用于属性或getter方法上。

十、@JsonDeserialize

  • 作用:用于自定义属性的反序列化方式。
  • 示例:配合自定义的反序列化器使用,如@JsonDeserialize(using = CustomDeserializer.class)
  • 注意:可以作用于属性或setter方法上。
相关推荐
麦兜*2 天前
MongoDB Atlas 云数据库实战:从零搭建全球多节点集群
java·数据库·spring boot·mongodb·spring·spring cloud
麦兜*2 天前
MongoDB 在物联网(IoT)中的应用:海量时序数据处理方案
java·数据库·spring boot·物联网·mongodb·spring
青衫客362 天前
Spring异步编程- 浅谈 Reactor 核心操作符
java·spring·响应式编程
Cyan_RA92 天前
SpringMVC @RequestMapping的使用演示和细节 详解
java·开发语言·后端·spring·mvc·ssm·springmvc
wuxuanok2 天前
SpringBoot -原理篇
java·spring boot·spring
若鱼19193 天前
spring-kafka消费异常处理
spring·kafka
送秋三十五3 天前
spring源码分析————ListableBeanFactory
java·后端·spring
一又四分之一.3 天前
spring、springboot、springCloud
spring boot·spring·spring cloud
float_六七3 天前
Spring事务注解@Transactional核心机制详解
java·后端·spring
Java水解3 天前
从 “Hello AI” 到企业级应用:Spring AI 如何重塑 Java 生态的 AI 开发
后端·spring