한국 시간으로 반환하기

문제 상황

• 시간 칼럼은 프론트엔드에서 UTC 로 넘어오지만, 다시 전달할 때는 Asia/Seoul 기준으로 전달한다.
• createdAt UTC 기준으로 DB 에 저장되어있으나 frontend 에는 Asia/Seoul 기준으로 변환해서 줘야한다.
• @JsonFormat 을 통해서 timezone 을 지정하여 전달하고 있으나, 한국시간으로 변환되지 않았음을 확인함

문제원인

• LocalDateTime @JsonFormat(timezone = “Asia/Seoul”) 이라는 옵션을 통해 timezone 을 설정해두고 있었음
• LocalDateTime 은 timezone 에 대한 정보를 저장하지 않아 변환 대상이 되는 timezone 옵션 사용이 불가함
• timezone 은 Date, ZonedDateTime 에만 timezone 정보가 있는 사용이 가능한 옵션임

문제가 된 코드

@JsonFormat(pattern = "yyyy-MM-dd HH:mm", timezone = "Asia/Seoul")
private final LocalDateTime createdAt;

해결책

구현 목표

• 시간 관련 칼럼은 DB에 UTC 시간대로 저장한다.
• DB, BE 서버의 시간대는 UTC 로 통일한다. 어떤 서버는 KST, UTC 로 설정되어있다면, 혼란이 올 수 있기 때문에 저장 및 관리하는 모든 서버는 단순하게 UTC 로 통일하고자 했다. 이전에 애플리케이션 코드 상에서 운영 서버의 시간을 UTC -> KST 로 변경하여 시간데이터를 처리하는 경우를 확인했는데 이것 때문에 데이터 정합성을 망가뜨리는 케이스를 봐서 최대한 통일하여 정리하고 싶었다.

1. createdAt Type 을 LocalDateTime 에서 ZonedDateTime 으로 변경한다. 서비스 레이어에서 LocalDateTime 을 ZonedDateTime 으로 변경하고, timezone 정보와 시간 정보를 전달하게끔 한다.

@Getter
public class SingleChatResponseDto {
    private final Long chatId;
    private final SenderResponseDto sender;
    private final String content;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm")
    private final ZonedDateTime createdAt;

    @Builder
    public SingleChatResponseDto(Long chatId, SenderResponseDto sender, String content, LocalDateTime createdAt) {
        this.chatId = chatId;
        this.sender = sender;
        this.content = content;
        this.createdAt = createdAt.atZone(ZoneId.of("UTC")).withZoneSameInstant(ZoneId.of("Asia/Seoul"));
    }

1. @Jackson2ObjectMapperBuilderCustomizer 사용하기 Front-end 로 들어오는 LocalDateTime (UTC) -> LocalDateTime (KST) 로 변경하기 장점 : 일괄적으로 들어오는 모든 datetime 을 KST 로 저장할 수 있다. @JsonFormat(timezone= “Asia/Seoul”) 처럼 매번 지정하지 않아도 된다. 단점 : 일괄적으로 들어오는 모든 datetime 을 KST 로 저장하기 때문에, configuration을 확인하지 않으면, 어떻게 시간이 변환되는지 확인할 수 없다. 마지막으로 DB 에 UTC 가 아닌 한국 시간으로 저장이 된다.

package com.tutorial.tailerbox.config;

import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.format.DateTimeFormatter;
import java.util.TimeZone;

@Configuration
public class DateFormatConfiguration {

    private static final String dateFormat = "yyyy-MM-dd";
    private static final String datetimeFormat = "yyyy-MM-dd HH:mm:ss";

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return jacksonObjectMapperBuilder -> {
            jacksonObjectMapperBuilder.timeZone(TimeZone.getTimeZone("Asia/Seoul"));
            jacksonObjectMapperBuilder.simpleDateFormat(datetimeFormat);
            jacksonObjectMapperBuilder.serializers(new LocalDateSerializer(DateTimeFormatter.ofPattern(dateFormat)));
            jacksonObjectMapperBuilder.serializers(new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(datetimeFormat)));
        };
    }