Формат JSON Java 8 LocalDateTime в Spring Boot


112

У меня небольшая проблема с форматированием Java 8 LocalDateTime в моем приложении Spring Boot. С "нормальными" датами у меня проблем нет, но поля LocalDateTime преобразуются в следующие:

"startDate" : {
    "year" : 2010,
    "month" : "JANUARY",
    "dayOfMonth" : 1,
    "dayOfWeek" : "FRIDAY",
    "dayOfYear" : 1,
    "monthValue" : 1,
    "hour" : 2,
    "minute" : 2,
    "second" : 0,
    "nano" : 0,
    "chronology" : {
      "id" : "ISO",
      "calendarType" : "iso8601"
    }
  }

Хотя я хотел бы преобразовать его во что-то вроде:

"startDate": "2015-01-01"

Мой код выглядит так:

@JsonFormat(pattern="yyyy-MM-dd")
@DateTimeFormat(iso = DateTimeFormat.ISO.TIME)
public LocalDateTime getStartDate() {
    return startDate;
}

Но любая из приведенных выше аннотаций не работает, дата продолжает форматироваться, как указано выше. Предложения приветствуются!

Ответы:


135

обновление : Spring Boot 2.x больше не требует этой конфигурации. Я написал здесь более свежий ответ .


(Это способ делать это до Spring Boot 2.x, это может быть полезно для людей, работающих над более старой версией Spring Boot)

Я наконец нашел здесь, как это сделать. Чтобы исправить это, мне понадобилась еще одна зависимость:

compile("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.4.0")

Включив эту зависимость, Spring автоматически зарегистрирует для нее конвертер, как описано здесь . После этого вам нужно добавить в application.properties следующее:

spring.jackson.serialization.write_dates_as_timestamps=false

Это обеспечит использование правильного конвертера, а даты будут напечатаны в формате 2016-03-16T13:56:39.492

Аннотации нужны только в том случае, если вы хотите изменить формат даты.


25
Вероятно, стоит включить следующую аннотацию - @JsonSerialize(using = LocalDateTimeSerializer.class)...
Ник Грили

3
Вероятно, лучше просто использовать application.propertiesзапись, как предлагает ответ @patelb.
membersound

Не работает. Но ответ PATELIB просто работает из коробки!
Михаил Копытоненко

В качестве хедз-апа нам нужна была @JsonSerializeаннотация, о которой говорил Ник, чтобы заставить ее работать.
pennstatephil

92

Я добавил com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.6.1зависимость и начал получать дату в следующем формате:

"birthDate": [
    2016,
    1,
    25,
    21,
    34,
    55
  ]

это не то, что я хотел, но я приближался. Затем я добавил следующее

spring.jackson.serialization.write_dates_as_timestamps=false

в файл application.properties, который дал мне нужный формат.

"birthDate": "2016-01-25T21:34:55"

2
Сработало из коробки при включении jackson-datatype-jsr310зависимости. Это должен быть принятый ответ.
membersound

6
В качестве FYI, то application.properties часть может быть сделано с помощью Java конфигурации , если вы настройки ObjectMapper с:mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
Justin

31

Вот он в maven, со свойством, чтобы вы могли выжить между обновлениями весенней загрузки

<dependency>
        <groupId>com.fasterxml.jackson.datatype</groupId>
        <artifactId>jackson-datatype-jsr310</artifactId>
        <version>${jackson.version}</version>
</dependency>

1
Используйте это решение с комментарием @NickGrealy: Вероятно, стоит включить следующую аннотацию -@JsonSerialize(using = LocalDateTimeSerializer.class)
HairOfTheDog

19

1) Зависимость

 compile group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.8.8' 

2) Аннотация с форматом даты и времени.

public class RestObject {

    private LocalDateTime timestamp;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    public LocalDateTime getTimestamp() {
        return timestamp;
    }
}

3) Spring Config.

@Configuration
public class JacksonConfig {

    @Bean
    @Primary
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
        System.out.println("Config is starting.");
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        return objectMapper;
    }
}

2
Спасибо. @JsonFormat - это тот, кто решил это за меня. Ни один из приведенных выше решений не работал для меня по какой - то причине
theprogrammer

7

Я нашел другое решение, которое вы можете преобразовать в любой формат, который хотите, и применить ко всем типам данных LocalDateTime, и вам не нужно указывать @JsonFormat над каждым типом данных LocalDateTime. сначала добавьте зависимость:

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
</dependency>

Добавьте следующий bean-компонент:

@Configuration
public class Java8DateTimeConfiguration {
    /**
     * Customizing
     * http://docs.spring.io/spring-boot/docs/current/reference/html/howto-spring-mvc.html
     *
     * Defining a @Bean of type Jackson2ObjectMapperBuilder will allow you to customize both default ObjectMapper and XmlMapper (used in MappingJackson2HttpMessageConverter and MappingJackson2XmlHttpMessageConverter respectively).
     */
    @Bean
    public Module jsonMapperJava8DateTimeModule() {
        val bean = new SimpleModule();

        bean.addDeserializer (ZonedDateTime.class, new JsonDeserializer<ZonedDateTime>() {
            @Override
            public ZonedDateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
                return ZonedDateTime.parse(jsonParser.getValueAsString(), DateTimeFormatter.ISO_ZONED_DATE_TIME);
            }
        });

        bean.addDeserializer(LocalDateTime.class, new JsonDeserializer<LocalDateTime>() {
            @Override
            public LocalDateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
                return LocalDateTime.parse(jsonParser.getValueAsString(), DateTimeFormatter.ISO_LOCAL_DATE_TIME);
            }
        });

        bean.addSerializer(ZonedDateTime.class, new JsonSerializer<ZonedDateTime>() {
            @Override
            public void serialize(
                    ZonedDateTime zonedDateTime, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
                    throws IOException {
                jsonGenerator.writeString(DateTimeFormatter.ISO_ZONED_DATE_TIME.format(zonedDateTime));
            }
        });

        bean.addSerializer(LocalDateTime.class, new JsonSerializer<LocalDateTime>() {
            @Override
            public void serialize(
                    LocalDateTime localDateTime, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
                    throws IOException {
                jsonGenerator.writeString(DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(localDateTime));
            }
        });

        return bean;
    }
}

в вашем файле конфигурации добавьте следующее:

@Import(Java8DateTimeConfiguration.class)

Это будет сериализовать и десериализовать все свойства LocalDateTime и ZonedDateTime, если вы используете objectMapper, созданный spring.

Формат для ZonedDateTime: «2017-12-27T08: 55: 17.317 + 02: 00 [Азия / Иерусалим]» для LocalDateTime: «2017-12-27T09: 05: 30.523».


Вероятно, вам нужно заменить bean-компонент val на bean-компонент SimpleModule = new SimpleModule ();
Абхишек Галода

Это для Java 9?
Daniel Dai

@DanielDai Это на Java 8.
Ида Амит

@Abhi, SimpleModuleрасширяется Module. Moduleэто абстрактный. val bean = new SimpleModule(); работает отлично.
Ида Амит

для SpringBoot версии 1.5.3.RELEASE не требовалось добавлять зависимость jackson-datatype-jsr310.
Moon13

7

Пишу этот ответ как напоминание и для меня.

Я объединил здесь несколько ответов, и в итоге мой работал с чем-то вроде этого. (Я использую SpringBoot 1.5.7 и Lombok 1.16.16)

@Data
public Class someClass {

   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
   @JsonSerialize(using = LocalDateTimeSerializer.class)
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
   private LocalDateTime someDate;

}

1
вы можете захотеть добавить импорт для DateTimeFormatи других.
прайагупд

4

Это отлично работает:

Добавьте зависимость:

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jdk8</artifactId>
</dependency>

Добавьте аннотацию:

@JsonFormat(pattern="yyyy-MM-dd")

Теперь вы должны получить правильный формат.

Чтобы использовать средство сопоставления объектов, вам необходимо зарегистрировать JavaTime

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());

1

Как уже упоминалось, spring -boot загрузит все, что вам нужно (как для веба, так и для стартера webflux).

Но что еще лучше - вам не нужно самостоятельно регистрировать какие-либо модули. Взгляните сюда . Поскольку @SpringBootApplicationиспользуется @EnableAutoConfigurationпод капотом, значит, оно JacksonAutoConfigurationбудет добавлено в контекст автоматически. Теперь, если вы заглянете внутрь JacksonAutoConfiguration, вы увидите:

    private void configureModules(Jackson2ObjectMapperBuilder builder) {
        Collection<Module> moduleBeans = getBeans(this.applicationContext,
                Module.class);
        builder.modulesToInstall(moduleBeans.toArray(new Module[0]));
    }

Этот парень будет вызван в процессе инициализации и получит все модули, которые сможет найти в пути к классам. (Я использую Spring Boot 2.1)


1

Я использую Springboot 2.0.6, и по какой-то причине изменения yml приложения не работали. А еще у меня было больше требований.

Я попытался создать ObjectMapper и пометить его как Primary, но весенняя загрузка пожаловалась, что у меня уже есть jacksonObjectMapper как Primary !!

Вот что я сделал. Я внес изменения во внутренний картограф.

Мои сериализатор и десериализатор особенные - они имеют дело с 'дд / ММ / ГГГГ'; и во время десериализации - он изо всех сил пытается использовать 3-4 популярных формата, чтобы убедиться, что у меня есть LocalDate.

@Autowired
ObjectMapper mapper;

@PostConstruct
public ObjectMapper configureMapper() {
    mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    mapper.enable(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT);

    mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    mapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);

    mapper.configure(MapperFeature.ALLOW_COERCION_OF_SCALARS, true);
    mapper.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true);

    SimpleModule module = new SimpleModule();
    module.addDeserializer(LocalDate.class, new LocalDateDeserializer());
    module.addSerializer(LocalDate.class, new LocalDateSerializer());
    mapper.registerModule(module);

    return mapper;
}

0

@JsonDeserialize(using= LocalDateDeserializer.class) не работает для меня с приведенной ниже зависимостью.

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version> 2.9.6</version>
</dependency>

Я использовал приведенный ниже конвертер кода для десериализации даты в файл java.sql.Date.

import javax.persistence.AttributeConverter;
import javax.persistence.Converter;


@SuppressWarnings("UnusedDeclaration")
@Converter(autoApply = true)
public class LocalDateConverter implements AttributeConverter<java.time.LocalDate, java.sql.Date> {


    @Override
    public java.sql.Date convertToDatabaseColumn(java.time.LocalDate attribute) {

        return attribute == null ? null : java.sql.Date.valueOf(attribute);
    }

    @Override
    public java.time.LocalDate convertToEntityAttribute(java.sql.Date dbData) {

        return dbData == null ? null : dbData.toLocalDate();
    }
}

0

просто используйте:

@JsonFormat(pattern="10/04/2019")

или вы можете использовать шаблон по своему усмотрению, например: ('-' in place of '/')


Этот ответ уже публиковался раньше, но с правильным синтаксисом.
Эрик Прагт

0

Я использую Spring Boot 2.1.8. Я импортировал

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-json</artifactId>
</dependency>

который включает файл jackson-datatype-jsr310 .

Затем мне пришлось добавить эти аннотации

@JsonSerialize(using = LocalDateTimeSerializer.class)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonProperty("date")
LocalDateTime getDate();

и это работает. JSON выглядит так:

"date": "2020-03-09 17:55:00"

Подсказка: включение spring-boot-starter-jsonнеобходимо только в том случае, если spring-boot-starter-webоно отсутствует.
дзюдому
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.