Java 8 LocalDateTime Serialization, Deserialization 이슈

Issue

토이프로젝트를 진행하면서 생긴 LocalDateTime 직렬화/역직렬화에 관한 이슈가 발생했다.

게시글을 조회할 때에 게시글의 작성 시간을 Dto에 주입해서 리턴하는 것을 구현하는 것을 추가하는 와중에

createdAt(생성시간) 을 리턴할 때 값이 받아오지 않고 예외가 발생했다.

 

Problem

Exception is occurred.org.springframework.http.converter.HttpMessageConversionException: Type definition error: [simple type, class java.time.LocalDateTime]

 

에러 내용에서 확인해보면 LocalDateTime의 타입이 맞지 않아서 에러가 발생한 것으로 보인다.

 

그럼 타입을 맞춰보기 위해서는 @DateTimeFormat 을 사용하는 것이다.

@DateTimeFormat 은 Spring에서 지원하는 어노테이션으로 LocalDate 와 LocalDateTime 와 같은 날짜 관련 타입의 직렬화를 지원하는 어노테이션입니다.

 

여기서 말하는 직렬화 란 무엇인가?

 

직렬화(Serialization)은 자바 객체를 JSON, XML 등 다른 데이터의 형식으로 변환하는 것을 말합니다.

역직렬화(Deserialization) 은 반대로 JSON,XML 등의 다른 데이터 형식을 자바 객체로 변환하는 것을 말합니다.

 

 

현재 @DataTimeFormat 을 사용했지만 @JsonFormat 어노테이션으로도 대체가 가능하다.

 

@DataTimeFormat 과 @JsonFormat 의 차이점에 대해 알아보면

@JsonFormat 어노테이션은 Jackson에서 제공하는 어노테이션이고 @DataTimeFormat 은 Spring의 어노테이션입니다.

 

@JsonFormat 은 LocalDate 혹은 LocalDateTime 을 JSON으로 직렬화할 때 포맷을 관리합니다.

 

Solve

@DateTimeFormat 어노테이션을 이용해서 직렬화를 진행했다.

@Getter
@Setter
@NoArgsConstructor
public class PostResponse {
  private Long id;
  private String title;
  private String content;
  private String username;
  private int likeCount;
  
  @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  private LocalDateTime createdAt;
}

 

직렬화를 진행했지만 해당 에러는 계속 발생했다.

 

다른 점을 확인해보니 내가 만들었었던 ObjectMapper를 재정의를 했기 때문에 발생했던 것이었다.

 

ObjectMapper란?

텍스트 형태의 JSON을 Object로 변경해주거나 Object를 텍스트 형태의 JSON으로 변경해주는 것을 의미한다.

@Configuration
public class AppConfig {
  @Bean
  public ObjectMapper objectMapper() {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper;
  }
}

 

 

여기서 확인해볼 것은 기본 설정은 Java 8의 LocalDateTime 타입을 지원하지 않습니다.

 

해당 타입들은 표준 Java 라이브러리 일부가 아니라 Java 8에 처음 도입된 jsr-310 모듈의 일부이기 때문입니다.

 

여기서 jsr-310 은 자바 플랫폼의 자바 사양을 정의한 문서와 같은 맥락으로 이중 310은 날짜와 시간에 관련된 API를 정의합니다.

 

하지만, jsr-310 의 의존성은 이미 spring-boot-starter-web에 의해 이미 추가가 되어있습니다.

 

그렇기에 데이터 유형을 적절하게 처리하기 위해서 사용자 정의 모듈을 추가해줘야한다.

날짜와 시간 타입의 데이터를 처리하기 위해 추가해야하는 모듈은 JavaTimeModule 입니다.

 

JavaTimeModule 이란?

JavaTimeModule 은 Java 8에 도입된 새로운 날짜 및 시간 API를 Jackson 라이브러리에서 적절하게 처리할 수 있게 도와주는 모듈입니다. 기본적으로 Jackson 라이브러리는 Java 8의 새로운 날짜 및 시간 타입들을 인식하지 못하기 때문에 해당 타입들을 JSON으로 직렬화 하거나, 역직렬화할 때 문제가 발생할 수 있습니다.

 

이러한 문제를 해결하기 위해서 JavaTimeModule을 ObjectMapper에 등록하면 날짜/시간 타입을 적절하게 직렬화하고 역직렬화할 수 있게 됩니다.

 

@Configuration
public class AppConfig {
  @Bean
  public ObjectMapper objectMapper() {
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.registerModule(new JavaTimeModule());
    objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
    return objectMapper;
  }
}

 

위의 코드와 같이 JavaTimeModule을 등록한 objectMapper를 스프링 빈으로 등록하면 사용할 수 있습니다.

등록한 objectMapper를 사용하면 날짜/시간 타입에 대해 직렬화와 역직렬화가 정상적으로 동작하는 것을 확인할 수 있습니다.

 

요약

ObjectMapper 빈을 설정하지 않는다면 기본 LocalDateTime으로 직렬화/역직렬화를 해도 문제 없다.

@DateTimeFormat 이나 @JsonFormat 어노테이션을 사용하면 된다.

하지만 objectMapper를 스프링 빈으로 등록했다면 JavaTimeModule을 추가하는 설정을 따로 해줘야한다.

 

 

Reference

https://jojoldu.tistory.com/361

 

https://stackoverflow.com/questions/40274353/how-to-use-localdatetime-requestparam-in-spring-i-get-failed-to-convert-string

 

https://woo-chang.tistory.com/75

 

https://umanking.github.io/2021/07/24/jackson-localdatetime-serialization/