0
点赞
收藏
分享

微信扫一扫

【详解】使用@JsonFormat注解时，LocalDateTime反序列化失败

谷中百合517 3小时前 阅读 1
反序列化javaxmlJava后端开发

使用@JsonFormat注解时，LocalDateTime反序列化失败

在现代的Java应用开发中，JSON数据格式因其简洁和易读性而被广泛用于前后端的数据交互。Jackson作为一款强大的JSON处理库，被许多开发者用于对象的序列化与反序列化操作。然而，在处理LocalDateTime类型的数据时，有时会遇到反序列化失败的问题，尤其是在使用@JsonFormat注解的情况下。

问题描述

假设我们有一个简单的Java类，其中包含一个LocalDateTime类型的字段，并使用了@JsonFormat注解来指定日期时间的格式：

import com.fasterxml.jackson.annotation.JsonFormat;
import java.time.LocalDateTime;

public class Event {
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime eventTime;

    // getters and setters
}

当我们尝试从JSON字符串反序列化这个对象时，可能会遇到以下异常：

com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type `java.time.LocalDateTime` from String "2023-10-05 14:48:32": Failed to deserialize java.time.LocalDateTime: (java.time.format.DateTimeParseException) Text '2023-10-05 14:48:32' could not be parsed at index 10

原因分析

上述错误的原因在于@JsonFormat注解默认使用的是ISO-8601格式（例如：2023-10-05T14:48:32），而不是我们期望的"yyyy-MM-dd HH:mm:ss"格式。即使我们在注解中指定了自定义格式，Jackson也可能无法正确解析该格式的字符串。

解决方案

方法一：使用自定义的JsonDeserializer

为了确保LocalDateTime能够按照指定的格式进行反序列化，我们可以创建一个自定义的JsonDeserializer：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class CustomLocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {

    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    @Override
    public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        return LocalDateTime.parse(p.getValueAsString(), FORMATTER);
    }
}

// 在Event类中使用自定义的Deserializer
public class Event {
    @JsonDeserialize(using = CustomLocalDateTimeDeserializer.class)
    private LocalDateTime eventTime;

    // getters and setters
}

方法二：全局配置Jackson

如果项目中有多个地方需要处理类似的日期时间格式，可以考虑在全局范围内配置Jackson，使其默认支持特定格式的日期时间解析：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import java.time.format.DateTimeFormatter;

public class JacksonConfig {

    public static ObjectMapper configureObjectMapper() {
        JavaTimeModule module = new JavaTimeModule();
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        module.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(formatter));
        
        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(module);
        return mapper;
    }
}

然后在需要的地方使用配置好的ObjectMapper实例进行序列化和反序列化操作。

在使用 @JsonFormat 注解处理 LocalDateTime 类型的字段时，可能会遇到反序列化失败的问题。这通常是因为默认的日期时间格式与 JSON 中提供的格式不匹配。下面是一个具体的示例代码，展示了如何配置 @JsonFormat 以及可能遇到的反序列化失败的情况。

示例代码

假设我们有一个 Event 类，其中包含一个 LocalDateTime 类型的字段，并且我们希望使用 @JsonFormat 注解来指定日期时间格式。

Event 类

import com.fasterxml.jackson.annotation.JsonFormat;
import java.time.LocalDateTime;

public class Event {
    private String name;

    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime dateTime;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public LocalDateTime getDateTime() {
        return dateTime;
    }

    public void setDateTime(LocalDateTime dateTime) {
        this.dateTime = dateTime;
    }
}


测试代码

import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.time.LocalDateTime;

public class Main {
    public static void main(String[] args) {
        ObjectMapper objectMapper = new ObjectMapper();

        // 正确的 JSON 格式
        String jsonCorrect = "{\"name\":\"Meeting\",\"dateTime\":\"2023-10-01 12:30:00\"}";

        // 错误的 JSON 格式
        String jsonIncorrect = "{\"name\":\"Meeting\",\"dateTime\":\"2023-10-01T12:30:00\"}";

        try {
            // 正确的反序列化
            Event eventCorrect = objectMapper.readValue(jsonCorrect, Event.class);
            System.out.println("Correct Deserialization: " + eventCorrect);

            // 错误的反序列化
            Event eventIncorrect = objectMapper.readValue(jsonIncorrect, Event.class);
            System.out.println("Incorrect Deserialization: " + eventIncorrect);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

运行结果

  1. 正确的反序列化：
  • JSON 格式为 "2023-10-01 12:30:00"，与 @JsonFormat 指定的格式匹配。
  • 输出：Correct Deserialization: Event{name='Meeting', dateTime=2023-10-01T12:30}
  1. 错误的反序列化：
  • JSON 格式为 "2023-10-01T12:30:00"，与 @JsonFormat 指定的格式不匹配。
  • 输出：com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type 'java.time.LocalDateTime' from String "2023-10-01T12:30:00": Failed to deserialize java.time.LocalDateTime: (java.time.format.DateTimeParseException) Text '2023-10-01T12:30:00' could not be parsed at index 10

解决方法

  1. 调整 JSON 格式：
  • 确保 JSON 中的日期时间格式与 @JsonFormat 指定的格式一致。
  1. 自定义反序列化器：
  • 如果需要支持多种日期时间格式，可以自定义反序列化器。
自定义反序列化器示例

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class Event {
    private String name;

    @JsonDeserialize(using = CustomLocalDateTimeDeserializer.class)
    private LocalDateTime dateTime;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public LocalDateTime getDateTime() {
        return dateTime;
    }

    public void setDateTime(LocalDateTime dateTime) {
        this.dateTime = dateTime;
    }
}

class CustomLocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {
    private static final DateTimeFormatter[] FORMATTERS = new DateTimeFormatter[]{
        DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"),
        DateTimeFormatter.ISO_LOCAL_DATE_TIME
    };

    @Override
    public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        String dateStr = p.getValueAsString();
        for (DateTimeFormatter formatter : FORMATTERS) {
            try {
                return LocalDateTime.parse(dateStr, formatter);
            } catch (Exception e) {
                // Try the next formatter
            }
        }
        throw new RuntimeException("Unable to parse date: " + dateStr);
    }
}

通过自定义反序列化器，可以灵活地处理多种日期时间格式，从而避免反序列化失败的问题。在Java中，使用@JsonFormat注解来格式化日期时间字段（如LocalDateTime）是一个常见的需求。然而，有时在反序列化JSON字符串到Java对象时可能会遇到问题，特别是在使用Jackson库时。下面我将详细介绍如何处理LocalDateTime的反序列化失败问题，并提供一个示例代码。

问题描述

假设你有一个包含LocalDateTime字段的Java类，并且你希望在反序列化JSON字符串时能够正确解析这个字段。但是，如果JSON字符串中的日期时间格式与你在@JsonFormat注解中指定的格式不匹配，就会导致反序列化失败。

示例代码

首先，我们定义一个包含LocalDateTime字段的Java类：

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;

import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class Event {

    private String name;

    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime eventDate;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public LocalDateTime getEventDate() {
        return eventDate;
    }

    public void setEventDate(LocalDateTime eventDate) {
        this.eventDate = eventDate;
    }

    public static void main(String[] args) {
        String json = "{\"name\":\"Meeting\",\"eventDate\":\"2023-10-05 14:30:00\"}";

        ObjectMapper objectMapper = new ObjectMapper();
        // 注册JavaTimeModule以支持Java 8日期时间类型
        objectMapper.registerModule(new JavaTimeModule());

        try {
            Event event = objectMapper.readValue(json, Event.class);
            System.out.println("Name: " + event.getName());
            System.out.println("Event Date: " + event.getEventDate().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

关键点解释

  1. @JsonFormat注解：
  • shape = JsonFormat.Shape.STRING：指定字段的形状为字符串。
  • pattern = "yyyy-MM-dd HH:mm:ss"：指定日期时间的格式。
  1. ObjectMapper配置：
  • objectMapper.registerModule(new JavaTimeModule())：注册JavaTimeModule模块，以便支持Java 8的日期时间类型（如LocalDateTime）。
  1. JSON字符串：
  • JSON字符串中的eventDate字段必须与@JsonFormat注解中指定的格式完全匹配，否则会抛出反序列化异常。

常见问题及解决方法

  1. 格式不匹配：
  • 如果JSON字符串中的日期时间格式与@JsonFormat注解中指定的格式不匹配，会导致反序列化失败。
  • 解决方法：确保JSON字符串中的日期时间格式与@JsonFormat注解中指定的格式一致。
  1. 时区问题：
  • 如果涉及到时区转换，可以使用@JsonFormat注解的timezone属性来指定时区。
  • 例如：@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "UTC")。
  1. 自定义反序列化器：
  • 如果需要更复杂的日期时间解析逻辑，可以实现自定义的反序列化器。
  • 例如：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.module.SimpleModule;

import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class CustomLocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {

    private static final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    @Override
    public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        String dateStr = p.getValueAsString();
        return LocalDateTime.parse(dateStr, formatter);
    }

    public static void main(String[] args) {
        String json = "{\"name\":\"Meeting\",\"eventDate\":\"2023-10-05 14:30:00\"}";

        ObjectMapper objectMapper = new ObjectMapper();
        SimpleModule module = new SimpleModule();
        module.addDeserializer(LocalDateTime.class, new CustomLocalDateTimeDeserializer());
        objectMapper.registerModule(module);

        try {
            Event event = objectMapper.readValue(json, Event.class);
            System.out.println("Name: " + event.getName());
            System.out.println("Event Date: " + event.getEventDate().format(formatter));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

通过上述方法，你可以有效地处理LocalDateTime的反序列化问题。希望这些信息对你有所帮助！

举报

相关推荐

解决Feign反序列化LocalDateTime异常

微服务Spring ...

【详解java序列化&反序列化】

java开发语言算法

缓存对象反序列化失败

fpga开发算法

序列化和反序列化，objectMapper 详解

开发语言java

Java序列化和反序列化(详解)

序列化反序列化javaJava后端开发

29_反序列化漏洞、反序列化概念、反序列化原理、反序列化漏洞防御、序列化

adblinuxmysql

SpringMVC中LocalDate、LocalDateTime、LocalTime、Date的序列化与反序列化

SpringMVCLocalDateTimeLocalDateLocalTimeDate软件架构软件研发

Jackson @JsonUnwrapped注解扁平化 序列化反序列化数据

springspring boot单元测试

Java序列化、反序列化

JavaIT必备技能

序列化与反序列化

jsonpython开发语言
0 条评论