Java 8 LocalDate формат Джексона
Для java.util.Date, когда я делаю
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy")
private Date dateOfBirth;
тогда в JSON запрос когда отправлю
{ {"dateOfBirth":"01/01/2000"} }
оно работает.
Как я должен сделать это для поля LocalDate Java 8??
Я пытался
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate dateOfBirth;
Это не сработало.
Может кто-нибудь, пожалуйста, дайте мне знать, как правильно сделать это..
Ниже приведены зависимости
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>jaxrs-api</artifactId>
<version>3.0.9.Final</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jaxrs-json-provider</artifactId>
<version>2.4.2</version>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.3.10</version>
</dependency>
<dependency>
17 ответов
Я никогда не мог заставить это работать просто, используя аннотации. Чтобы заставить его работать, я создал ContextResolver за ObjectMapper Затем я добавил JSR310Module наряду с еще одним предупреждением, которое было необходимо установить для параметра write-date-as-timestamp значение false. Подробнее смотрите в документации по модулю JSR310. Вот пример того, что я использовал.
зависимость
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.4.0</version>
</dependency>
Примечание: одна проблема, с которой я столкнулся, заключается в том, что jackson-annotation версия, загруженная другой зависимостью, использовала версию 2.3.2, которая отменила 2.4, требуемый jsr310 , Что случилось, я получил NoClassDefFound для ObjectIdResolver , который 2,4 класс. Так что мне просто нужно выстроить включенные версии зависимостей
ContextResolver
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JSR310Module;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
@Provider
public class ObjectMapperContextResolver implements ContextResolver<ObjectMapper> {
private final ObjectMapper MAPPER;
public ObjectMapperContextResolver() {
MAPPER = new ObjectMapper();
MAPPER.registerModule(new JSR310Module());
MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
}
@Override
public ObjectMapper getContext(Class<?> type) {
return MAPPER;
}
}
Ресурсный класс
@Path("person")
public class LocalDateResource {
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getPerson() {
Person person = new Person();
person.birthDate = LocalDate.now();
return Response.ok(person).build();
}
@POST
@Consumes(MediaType.APPLICATION_JSON)
public Response createPerson(Person person) {
return Response.ok(
DateTimeFormatter.ISO_DATE.format(person.birthDate)).build();
}
public static class Person {
public LocalDate birthDate;
}
}
Тестовое задание
curl -v http://localhost:8080/api/person
Результат:{"birthDate":"2015-03-01"}
curl -v -POST -H "Content-Type:application/json" -d "{\"birthDate\":\"2015-03-01\"}" http://localhost:8080/api/person
Результат:2015-03-01
Смотрите также здесь для решения JAXB.
ОБНОВИТЬ
JSR310Module устарела с версии 2.7 Джексона. Вместо этого вы должны зарегистрировать модуль JavaTimeModule, Это все та же зависимость.
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
отлично работает для меня
@JsonSerialize и @JsonDeserialize отлично работали для меня. Они устраняют необходимость импортировать дополнительный модуль jsr310:
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate dateOfBirth;
десериализатор:
public class LocalDateDeserializer extends StdDeserializer<LocalDate> {
private static final long serialVersionUID = 1L;
protected LocalDateDeserializer() {
super(LocalDate.class);
}
@Override
public LocalDate deserialize(JsonParser jp, DeserializationContext ctxt)
throws IOException, JsonProcessingException {
return LocalDate.parse(jp.readValueAs(String.class));
}
}
Serializer:
public class LocalDateSerializer extends StdSerializer<LocalDate> {
private static final long serialVersionUID = 1L;
public LocalDateSerializer(){
super(LocalDate.class);
}
@Override
public void serialize(LocalDate value, JsonGenerator gen, SerializerProvider sp) throws IOException, JsonProcessingException {
gen.writeString(value.format(DateTimeFormatter.ISO_LOCAL_DATE));
}
}
В весенней загрузке веб-приложение с версиями 2.8.5"Джексон" и "JSR310"
compile "com.fasterxml.jackson.core:jackson-databind:2.8.5"
runtime "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.8.5"
@JsonFormat работает:
import com.fasterxml.jackson.annotation.JsonFormat;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
private LocalDate birthDate;
Самое простое решение (которое поддерживает десериализацию и сериализацию)
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy")
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate dateOfBirth;
При использовании следующих зависимостей в вашем проекте.
специалист
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.7</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.7</version>
</dependency>
Gradle
compile "com.fasterxml.jackson.core:jackson-databind:2.9.7"
compile "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.9.7"
Никакой дополнительной реализации ContextResolver, Serializer или Deserializer не требуется.
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonSerialize(using = LocalDateTimeSerializer.class)
@JsonDeserialize(using = LocalDateTimeDeserializer.class)
private LocalDateTime createdDate;
Поскольку LocalDateSerializer по умолчанию превращает его в "[год, месяц, день]" (массив json), а не в "год-месяц-день" (строку json), и поскольку я не хочу требовать каких-либо специальных ObjectMapper настройка (вы можете сделать LocalDateSerializer генерировать строки, если вы отключите SerializationFeature.WRITE_DATES_AS_TIMESTAMPS но это требует дополнительной настройки вашего ObjectMapper), Я использую следующее:
импорт:
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
код:
// generates "yyyy-MM-dd" output
@JsonSerialize(using = ToStringSerializer.class)
// handles "yyyy-MM-dd" input just fine
@JsonDeserialize(using = LocalDateDeserializer.class)
private LocalDate localDate;
И теперь я могу просто использовать new ObjectMapper() читать и писать мои объекты без какой-либо специальной настройки.
Самый простой и самый короткий:
@JsonFormat(pattern = "yyyy-MM-dd")
private LocalDate localDate;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime localDateTime;
при загрузке Spring>= 2.2+ зависимость не требуется
Следующая аннотация сработала для меня.
Никаких дополнительных зависимостей не требуется.
@JsonProperty("created_at")
@JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
@JsonDeserialize(using = LocalDateTimeDeserializer.class)
@JsonSerialize(using = LocalDateTimeSerializer.class)
private LocalDateTime createdAt;
Просто обновление ответа Кристофера.
Начиная с версии 2.6.0
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.0</version>
</dependency>
Используйте JavaTimeModule вместо JSR310Module (не рекомендуется).
@Provider
public class ObjectMapperContextResolver implements ContextResolver<ObjectMapper> {
private final ObjectMapper MAPPER;
public ObjectMapperContextResolver() {
MAPPER = new ObjectMapper();
MAPPER.registerModule(new JavaTimeModule());
MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
}
@Override
public ObjectMapper getContext(Class<?> type) {
return MAPPER;
}
}
Согласно документации, новый JavaTimeModule использует те же стандартные настройки по умолчанию для сериализации, которая НЕ использует идентификаторы часовых поясов, а вместо этого использует только ISO-8601-совместимые смещения часовых поясов.
Поведение может быть изменено с использованием SerializationFeature.WRITE_DATES_WITH_ZONE_ID
/questions/32287076/java-8-localdate-format-dzheksona/32287077#32287077 - это самый простой способ сериализации / десериализации свойства. У меня есть две проблемы относительно этого подхода - до некоторой степени нарушение принципа СУХОЙ и высокая связь между pojo и картографом.
public class Trade {
@JsonFormat(pattern = "yyyyMMdd")
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate tradeDate;
@JsonFormat(pattern = "yyyyMMdd")
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate maturityDate;
@JsonFormat(pattern = "yyyyMMdd")
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate entryDate;
}
Если у вас есть POJO с несколькими полями LocalDate, лучше настроить mapper вместо POJO. Это может быть так же просто, как /questions/32287076/java-8-localdate-format-dzheksona/32287081#32287081 если вы используете значения ISO-8601 ("2019-01-31")
В случае, если вам нужно обработать пользовательский формат, код будет выглядеть так:
ObjectMapper mapper = new ObjectMapper();
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyyMMdd")));
javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyyMMdd")));
mapper.registerModule(javaTimeModule);
Логика написана только один раз, она может быть повторно использована для нескольких POJO
Начиная с 2020 и Jackson 2.10.1 нет необходимости в каком-либо специальном коде, просто нужно сказать Джексону, что вы хотите:
ObjectMapper objectMapper = new ObjectMapper();
// Register module that knows how to serialize java.time objects
// Provided by jackson-datatype-jsr310
objectMapper.registerModule(new JavaTimeModule());
// Ask Jackson to serialize dates as String (ISO-8601 by default)
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
Об этом уже упоминалось в этом ответе, я добавляю модульный тест, проверяющий функциональность:
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import lombok.Data;
import org.junit.jupiter.api.Test;
import java.time.LocalDate;
import static org.junit.jupiter.api.Assertions.assertEquals;
public class LocalDateSerializationTest {
@Data
static class TestBean {
// Accept default ISO-8601 format
LocalDate birthDate;
// Use custom format
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy")
LocalDate birthDateWithCustomFormat;
}
@Test
void serializeDeserializeTest() throws JsonProcessingException {
ObjectMapper objectMapper = new ObjectMapper();
// Register module that knows how to serialize java.time objects
objectMapper.registerModule(new JavaTimeModule());
// Ask Jackson to serialize dates as String (ISO-8601 by default)
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
// The JSON string after serialization
String json = "{\"birthDate\":\"2000-01-02\",\"birthDateWithCustomFormat\":\"03/02/2001\"}";
// The object after deserialization
TestBean object = new TestBean();
object.setBirthDate(LocalDate.of(2000, 1, 2));
object.setBirthDateWithCustomFormat(LocalDate.of(2001, 2, 3));
// Assert serialization
assertEquals(json, objectMapper.writeValueAsString(object));
// Assert deserialization
assertEquals(object, objectMapper.readValue(json, TestBean.class));
}
}
TestBean использует Lombok для создания шаблона для bean-компонента.
Весной немного проще:
///...
@Configuration
public class ApplicationCtxBeans {
//....
@Bean
public ObjectMapper objectMapper() {
ObjectMapper MAPPER = new ObjectMapper();
MAPPER.registerModule(new JavaTimeModule()); // to handle LocalDateTime etc
return MAPPER;
}
//...
}
Использование :
@Service
public class SomeService {
//...
@Autowired
ObjectMapper jsonMapper;
//...
JsonNode node = jsonMapper.readTree(
jsonMapper.writeValueAsString(instance_Of_Class_With_LocalDate_Fields)
);
//...
}
С весенней загрузкой 2.3.9.RELEASE я только что зарегистрировал модуль времени java без явной аннотации в классе POJO, имеющем поле LocalDate, и это сработало.
var objectMapper = new ObjectMapper();
objectMapper.registerModule(new JavaTimeModule());
В классе конфигурации определяют LocalDateSerializer и LocalDateDeserializer класс и зарегистрировать их в ObjectMapper через JavaTimeModule, как показано ниже:
@Configuration
public class AppConfig
{
@Bean
public ObjectMapper objectMapper()
{
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_EMPTY);
//other mapper configs
// Customize de-serialization
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer());
javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer());
mapper.registerModule(javaTimeModule);
return mapper;
}
public class LocalDateSerializer extends JsonSerializer<LocalDate> {
@Override
public void serialize(LocalDate value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
gen.writeString(value.format(Constant.DATE_TIME_FORMATTER));
}
}
public class LocalDateDeserializer extends JsonDeserializer<LocalDate> {
@Override
public LocalDate deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
return LocalDate.parse(p.getValueAsString(), Constant.DATE_TIME_FORMATTER);
}
}
}
Если ваш запрос содержит объект вроде этого:
{
"year": 1900,
"month": 1,
"day": 20
}
Тогда вы можете использовать:
data class DateObject(
val day: Int,
val month: Int,
val year: Int
)
class LocalDateConverter : StdConverter<DateObject, LocalDate>() {
override fun convert(value: DateObject): LocalDate {
return value.run { LocalDate.of(year, month, day) }
}
}
Над полем:
@JsonDeserialize(converter = LocalDateConverter::class)
val dateOfBirth: LocalDate
Код находится на Kotlin, но, конечно, это сработает и для Java.
аннотация в Pojo без использования дополнительных зависимостей
@DateTimeFormat (pattern = "yyyy/MM/dd", iso = DateTimeFormat.ISO.DATE)
private LocalDate enddate;