date转json怎么不让他变成long

在Java开发中，我们经常需要将包含Date对象的数据转换为JSON格式进行传输或存储，默认情况下，许多JSON库（如Jackson、Gson）会将Date对象序列化为一个长整型时间戳（例如1678886400000），这往往不是我们期望的格式，我们更希望得到一个人类可读的日期时间字符串（如"2023-03-15 12:00:00"或"2023-03-15T12:00:00Z"），如何优雅地实现Date转JSON时不变成long呢？本文将介绍几种主流JSON库的解决方案。

问题呈现：为何Date会变成Long？

让我们先看看默认情况下会发生什么,假设我们有这样一个简单的Java类：

public class Event {
    private String name;
    private Date eventDate;
    // 构造方法、getter和setter省略
}

当使用Jackson库将其转换为JSON时,默认输出可能是：

{
  "name": "技术分享会",
  "eventDate": 1678886400000
}

这个1678886400000就是从Date对象表示的UTC时间戳（自1970年1月1日以来的毫秒数），这种格式虽然机器友好,但不便于直接阅读和调试。

Jackson库解决方案

Jackson是Java生态中最流行的JSON库之一,提供了灵活的日期格式化方式。

方法1：使用@JsonFormat注解（推荐）

这是最直接和常用的方法，可以在Date类型的字段上添加@JsonFormat注解,指定输出格式。

import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;
public class Event {
    private String name;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date eventDate;
    // 构造方法、getter和setter省略
}

说明：

• pattern：指定日期时间的格式模式，例如"yyyy-MM-dd HH:mm:ss"。
• timezone：指定时区，避免时区转换问题，例如"GMT+8"表示东八区。
• 这样，JSON输出就会变成：

  {
    "name": "技术分享会",
    "eventDate": "2023-03-15 20:00:00"
  }

方法2：全局日期格式配置

如果项目中所有Date字段都需要统一格式,可以在ObjectMapper上进行全局配置。

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.annotation.JsonFormat;
// 创建ObjectMapper实例
ObjectMapper objectMapper = new ObjectMapper();
// 注册JavaTimeModule（如果使用Java 8时间API，推荐）
objectMapper.registerModule(new JavaTimeModule());
// 禁用默认的Date序列化为时间戳
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
// 设置全局日期格式
objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ"));
// 使用objectMapper进行序列化
// Event event = new Event();
// String json = objectMapper.writeValueAsString(event);

说明：

• disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)：这是关键，告诉Jackson不要将Date写成时间戳。
• setDateFormat()：设置全局的日期格式化器。

方法3：自定义Date序列化器

对于更复杂的定制需求，可以自定义一个Date序列化器。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
public class CustomDateSerializer extends JsonSerializer<Date> {
    private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    @Override
    public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) throws IOException {
        String formattedDate = dateFormat.format(date);
        gen.writeString(formattedDate);
    }
}

然后在字段上使用@JsonSerialize注解：

@JsonSerialize(using = CustomDateSerializer.class)
private Date eventDate;

Gson库解决方案

Gson是另一个广泛使用的JSON库。

方法1：注册类型适配器（TypeAdapter）

import com.google.gson.*;
import java.lang.reflect.Type;
import java.text.SimpleDateFormat;
import java.util.Date;
public class DateTypeAdapter implements JsonSerializer<Date>, JsonDeserializer<Date> {
    private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    @Override
    public JsonElement serialize(Date src, Type typeOfSrc, JsonSerializationContext context) {
        return new JsonPrimitive(dateFormat.format(src));
    }
    @Override
    public Date deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
            throws JsonParseException {
        try {
            return dateFormat.parse(json.getAsString());
        } catch (Exception e) {
            throw new JsonParseException(e);
        }
    }
}

然后在使用Gson时注册这个适配器：

Gson gson = new GsonBuilder()
        .registerTypeAdapter(Date.class, new DateTypeAdapter())
        .create();
// Event event = new Event();
// String json = gson.toJson(event);

方法2：使用GsonBuilder设置日期格式（Gson 2.8.2+）

较新版本的Gson提供了更便捷的方式：

Gson gson = new GsonBuilder()
        .setDateFormat("yyyy-MM-dd HH:mm:ss")
        .create();

其他注意事项

1. Java 8时间API (java.time)：如果项目使用Java 8及以上版本，强烈推荐使用java.time包下的类（如LocalDateTime, ZonedDateTime, Instant等），Jackson和Gson对这些新时间类型有更好的支持,默认配置下就能得到友好的字符串格式。

   • Jackson示例：

     objectMapper.registerModule(new JavaTimeModule());
     objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

   • Gson示例（默认行为就比较友好）。

2. 时区处理：在处理日期时间时，务必注意时区问题，确保服务器、数据库和客户端之间的时区一致或正确转换。@JsonFormat中的timezone属性和SimpleDateFormat的时区设置都很重要。

3. 格式一致性：项目中应尽量保持日期时间格式的一致性,避免因格式混乱导致的解析错误。

Date对象转JSON时不希望变成long，核心思路是禁用默认的时间戳序列化方式，并指定自定义的日期格式字符串。

• Jackson：优先使用@JsonFormat(pattern = "...")注解，或通过ObjectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)并设置全局日期格式。
• Gson：通过GsonBuilder.registerTypeAdapter()自定义类型适配器，或使用GsonBuilder.setDateFormat()设置格式。
• 最佳实践：对于新项目，考虑使用Java 8的java.time API,能更优雅地处理日期时间问题。

选择哪种方式取决于你使用的JSON库和项目具体需求，这些技巧,能让你的JSON数据在可读性和易用性上得到显著提升。