https://www.baeldung.com/spring-boot-formatting-json-dates

1. 개요

이 튜토리얼에서는 Spring Boot 애플리케이션에서 JSON 날짜 필드의 형식을 지정하는 방법을 보여줍니다.

Spring Boot에서 기본 JSON 프로세서로 사용하는 Jackson을 사용하여 날짜 형식을 지정하는 다양한 방법을 살펴 보겠습니다 .

2. 날짜 필드 에서 @JsonFormat 사용

2.1. 형식 설정

특정 필드의 형식을 지정하기 위해 @JsonFormat 주석을 사용할 수 있습니다 .

 public class Contact {
 
    // other fields
 
    @JsonFormat(pattern="yyyy-MM-dd")
    private LocalDate birthday;
     
    @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
    private LocalDateTime lastUpdate;
 
    // standard getters and setters
 
}

온 생일 필드, 우리는에있는 동안 날짜 만 렌더링하는 패턴을 사용 LASTUPDATE 필드 우리는 또한 시간을 포함합니다.

우리는 임시 유형을 다루는 데 매우 편리한 Java 8 날짜 유형 을 사용했습니다 . 물론 java.util.Date 와 같은 레거시 유형을 사용해야하는 경우 동일한 방식으로 주석을 사용할 수 있습니다.

 public class ContactWithJavaUtilDate {
 
     // other fields
 
     @JsonFormat(pattern="yyyy-MM-dd")
     private Date birthday;
     
     @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
     private Date lastUpdate;
 
     // standard getters and setters
}

마지막으로 주어진 날짜 형식으로 @JsonFormat 을 사용하여 렌더링 된 출력을 살펴 보겠습니다 .

 {
    "birthday": "2019-02-03",
    "lastUpdate": "2019-02-03 10:08:02"
}

보시다시피 @JsonFormat 어노테이션을 사용하는 것은 특정 날짜 필드의 형식을 지정하는 훌륭한 방법입니다.

그러나 필드에 대한 특정 형식이 필요할 때만 사용해야합니다. 응용 프로그램의 모든 날짜에 대한 일반적인 형식을 원할 경우 나중에 살펴 보 겠지만이를 달성하는 더 좋은 방법이 있습니다.

2.2. 시간대 설정

또한 특정 시간대를 사용해야하는 경우 @ JsonFormat 의 시간대 속성을 설정할 수 있습니다 .

 @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss", timezone="Europe/Zagreb")
private LocalDateTime lastUpdate;

예를 들어 java.time.ZonedDatetime 과 같이 유형에 이미 시간대가 포함되어있는 경우에는 사용할 필요가 없습니다 .

3. 기본 형식 구성

@JsonFormat 은 그 자체로 강력하지만 형식과 시간대를 하드 코딩하면 길 을 잃을 수 있습니다.

응용 프로그램의 모든 날짜에 대한 기본 형식을 구성하려는 경우 보다 유연한 방법은 application.properties 에서 구성하는 것입니다 .

 spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

JSON 날짜에 특정 시간대를 사용하려는 경우 해당 속성도 있습니다.

 spring.jackson.time-zone=Europe/Zagreb

이와 같이 기본 형식을 설정하는 것은 매우 편리하고 간단하지만 이 방법에는 단점이 있습니다. 불행히도 LocalDate 및 LocalDateTime 과 같은 Java 8 날짜 유형 에서는 작동하지 않습니다 . java.util.Date 또는 java.util.Calendar 유형의 필드를 형식화하는 데만 사용할 수 있습니다 . 하지만 곧 보게 될 희망이 있습니다.

4. Jackson의 ObjectMapper 사용자 정의

따라서 Java 8 날짜 유형 을 사용하고 기본 날짜 형식을 설정하려면 Jackson2ObjectMapperBuilderCustomizer Bean 을 만들어야합니다 .

 @Configuration
public class ContactAppConfig {
 
    private static final String dateFormat = "yyyy-MM-dd";
    private static final String dateTimeFormat = "yyyy-MM-dd HH:mm:ss";
 
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
        return builder -> {
            builder.simpleDateFormat(dateTimeFormat);
            builder.serializers(new LocalDateSerializer(DateTimeFormatter.ofPattern(dateFormat)));
            builder.serializers(new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(dateTimeFormat)));
        };
    }
 
}

위의 예는 애플리케이션에서 기본 형식을 구성하는 방법을 보여줍니다. 빈을 정의 하고 원하는 형식을 설정하기 위해 사용자 정의 메소드를 재정의해야 합니다.

이 접근 방식은 다소 복잡해 보일 수 있지만, 좋은 점은 Java 8 및 레거시 날짜 유형 모두에서 작동한다는 것입니다.

5. 결론

이 기사에서는 Spring Boot 애플리케이션에서 JSON 날짜 형식을 지정하는 여러 가지 방법을 살펴 보았습니다.

항상 그렇듯이 GitHub 에서 예제의 소스 코드를 찾을 수 있습니다 .

[Java & Spring] Spring Boot에서 JSON 날짜 형식 지정