Jackson @JsonFormat 注解

1. 概述

Jackson 是一个著名的Java库，专门用于将Java对象转换为JSON格式以及从JSON反序列化回Java对象。有时，在这个转换过程中，可能需要自定义某些字段的格式，特别是日期和时间字段。在这种情况下，Jackson的@JsonFormat注解可以提供帮助。

`@JsonFormat` 注解概览

@JsonFormat注解用于指定日期、时间和数字字段在序列化和反序列化时应采用的格式。该注解提供了对这些格式的精细控制，确保JSON输出中此类字段表示的一致性。

2. 开发步骤

启动一个新的Maven项目。
添加必要的Jackson依赖项。
设计User类，并应用@JsonFormat注解进行日期格式化。
创建一个单独的类来实现序列化机制。
构建一个主类来展示序列化过程。

3. 创建Maven项目

创建简单Maven项目有几种方式：

使用命令行界面创建简单的Maven项目
使用Eclipse IDE创建简单的Maven项目
使用IntelliJ IDEA创建简单的Maven项目

4. Maven依赖

打开pom.xml文件，并添加以下Jackson数据绑定依赖项：

<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.0</version>
</dependency>

5. 示例代码

以用户管理系统为例，我们来看具体实现：

// User.java
import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;public class User {private String username;@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy")private Date birthdate;// 标准构造函数、getter和setter...public User() {}public String getUsername() {return username;}public void setUsername(String username) {this.username = username;}public Date getBirthdate() {return birthdate;}public void setBirthdate(Date birthdate) {this.birthdate = birthdate;}
}// JsonSerializer.java
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;public class JsonSerializer {public static String serializeToJson(Object object) throws JsonProcessingException {ObjectMapper mapper = new ObjectMapper();return mapper.writeValueAsString(object);}
}// MainClass.java
import java.util.Calendar;public class MainClass {public static void main(String[] args) {User user = new User();user.setUsername("bob");Calendar calendar = Calendar.getInstance();calendar.set(1990, Calendar.JANUARY, 1);user.setBirthdate(calendar.getTime());try {String json = JsonSerializer.serializeToJson(user);System.out.println(json);} catch (JsonProcessingException e) {e.printStackTrace();}}
}

输出:

json">{"username":"bob","birthdate":"01-01-1990"}

代码解释：

在User类中，birthdate字段是Date类型，并使用了@JsonFormat注解来指定其在序列化期间所需的格式。这确保了结果JSON中的日期将以"dd-MM-yyyy"格式表示。
JsonSerializer类利用Jackson的ObjectMapper简化了序列化操作。
MainClass作为驱动类，创建了一个User实例，设置了它的属性，并调用序列化逻辑以生成格式化的JSON输出。