Java 8 LocalDate Jackson格式


138

对于java.util.Date当我做

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy")  
  private Date dateOfBirth;

然后在发送JSON请求时

{ {"dateOfBirth":"01/01/2000"} }  

有用。

我应如何针对Java 8的LocalDate字段执行此操作?

我尝试过

@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>

Answers:


106

我从来没有能够使用注释使它简单地工作。为了使其正常工作,我创建了一个ContextResolverfor ObjectMapper,然后添加了JSR310Moduleupdate:现在JavaTimeModule改为),以及另外一个警告,那就是需要将write-date-as-stampst设置为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。发生了什么事,我得到了一个N​​oClassDefFound 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();
        // Now you should use JavaTimeModule instead
        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解决方案。

更新

JSR310ModuleJackson的2.7版本开始不推荐使用。相反,您应该注册module JavaTimeModule。它仍然是相同的依赖项。


1
嗨Peeskillet,字段birthDate,正在生成为“ birthDate”:{“ year”:0,“ month”:“ Month”,“ dayOfMonth”:0,“ dayOfWeek”:“ DayOfWeek”,“ era”:{“ value“:0},” dayOfYear“:0,” leapYear“:false,” monthValue“:0,” chronology“:{” id“:”“,” calendarType“:”“}}}我怎么做作为“出生日期” ???
JAB

检查ContextResolver是否被调用。在getContext方法中添加打印语句。如果调用此方法,则看不到不起作用的原因。如果未调用,则可能需要通过应用程序配置对其进行修复。为此,我需要看到的不仅仅是您提供的内容。与Resteasy版本,依赖项一样,应用程序配置为web.xml或Application子类。基本上足以重现问题
保罗Samsotha

ContextResolver没有被称为Peeskillet。我在web.xml中将其重新命名为<context-param> <param-name> resteasy.resources </ param-name> <param-value> com.bac.ObjectMapperContextResolver </ param-value> </ context-param>我正在使用的依赖项的更新问题
JAB 2015年

昂首阔步似乎是问题所在。我想说要禁用它,但是从这个问题来看,存在一个已提交的问题,在Swagger的ObjectMapper和尝试使用您自己的之间存在冲突。您可以尝试禁用它们的配置,然后在ContextResolver中将所有配置都设置ObjectMapper为大张旗鼓(您可以在问题中看到一个链接)。我不知道,因为我不太会招摇。但是我认为招摇是主要问题,为什么没有调用contextresolver。
Paul Samsotha

进一步的测试后,注释工作。即使我们必须使用Swagger ObjectMapper,也已经为我们配置了时间戳为false。所以这应该工作。为了获得更好的帮助,我强烈建议您提供一个演示该问题的MCVE
Paul Samsotha

95

@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));
    }

}

序列化器:

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
这是对我最好的答案。谢谢!
罗密欧·小·马拉南

7
这些类包含在中jackson-datatype-jsr310。无需在项目中手动定义它们。
NeuroXc

1
使用中的序列化程序,该解决方案对我有用jackson-datatype-jsr310
戴夫

2
这应该是新的最佳答案。
医生参数

1
如果在jackson-datatype-jsr310中使用序列化器和反序列化器,则最好将@JsonFormat(shape = JsonFormat.Shape.STRING)添加到您的字段中。如果没有反序列化,则没有此格式的值将被序列化为[年,月,日]。
简晨

74
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);

对我来说很好。


2
new com.fasterxml.jackson.datatype.jsr310.JSR310Module()适用于Jackson的2.5.4版本。此版本中不存在JavaTimeModule类。
user3774109 '17

此答案也适用于LocalDateTime(杰克逊2.9.5)。还需要1个额外的依赖关系,因此我的build.sbt看起来像:"com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.9.5", "com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.9.5"
ruhong

2
这应该有更多的选票。简单有效。
mkasberg '18

工作完美!谢谢。
MAD-HAX

这为我指明了正确的方向,谢谢!我要补充一点,在spring-boot中,您需要做的就是将以下内容添加到application.properties:spring.jackson.serialization.write-dates-as-timestamps = false
Joost Lambregts

46

在Spring Boot Web应用程序中,具有JacksonJSR 310版本“ 2.8.5”

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;

2
这对反序列化有效吗?或仅序列化?反序列化没有成功
取消了

7
我必须明确声明反序列化器@JsonDeserialize(using= LocalDateDeserializer.class)
重新定义

1
迄今为止最简单的!
安东尼奥

@JsonFormat仅用于更改输出数据格式。 stackoverflow.com/a/53251526/816759可以完美兼容@JsonFormat@JsonDeserialize@JsonSerialize
巴哈

在Spring Boot中,一旦添加了JSR310依赖项,您要做的就是添加spring.jackson.serialization.write-dates-as-timestamps=falseapplication.properties,并yyyy-MM-dd自动将其格式化。无需@JsonFormat
埃斯凡迪亚

31

最简单的解决方案(也支持反序列化和序列化)是

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>

摇篮

compile "com.fasterxml.jackson.core:jackson-databind:2.9.7"
compile "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.9.7"

不需要ContextResolver,Serializer或Deserializer的其他实现。


辉煌,远在咫尺。仅供参考,对于有很多依赖性的任何人,我必须更新其他一些结合了杰克逊注释的库。
brt

这个答案是我所要解决的最接近的答案。序列化有效,但反序列化失败,因为我认为与@JsonFormat一起使用的模式(@JsonFormat(shape = JsonFormat.Shape.STRING,pattern =“ dd-MM-yyyy_HH:mm:SS”)
fsakiyama

如果反序列化失败,则很可能是您ObjectMapper尚未JavaTimeModule注册。如果您的ObjectMapper实例是从spring / MessageConverter框架提供的。他们做了一些魔术来将它们连接起来。在其他情况下,应默认registerModule启用LocalDateDeserializerPOJO中的所有“ LocalDate”
Dennis C

19

以来 LocalDateSerializer默认情况下将其设置为“ [year,month,day]”(一个json数组),而不是“ year-month-day”(一个json字符串),而且由于我不想进行任何特殊ObjectMapper设置(您可以LocalDateSerializer如果您停用了make 生成字符串,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 (note: "yyyy-M-d" format will not work)
@JsonDeserialize(using = LocalDateDeserializer.class)
private LocalDate localDate;

现在,我可以使用它new ObjectMapper()来读写对象,而无需任何特殊设置。


3
我想添加的一件事是传递日期,"2018-12-07"而不是"2018-12-7"您会得到一个错误。
Kid101 '18

1
正确,它使用yyyy-MM-dd(2位月份和日期)格式,而不是yyyy-M-d(1位月份或日期)格式。
Shadow Man

8

只是克里斯托弗回答的更新。

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使用相同的标准设置来默认为不使用时区ID的序列化,而是仅使用符合ISO-8601的时区偏移量。

行为可以使用SerializationFeature.WRITE_DATES_WITH_ZONE_ID进行更改


这对我有帮助。就我而言,我需要添加MAPPER.registerModule(new JavaTimeModule());行。它让我将LocalDate对象的格式设置为“ 2020-02-20”格式。我不需要MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);线路,因为我一直在寻找
Cuga

5

以下注释对我来说效果很好。

无需额外的依赖关系。

    @JsonProperty("created_at")
    @JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
    @JsonSerialize(using = LocalDateTimeSerializer.class)
    private LocalDateTime createdAt;

5
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonSerialize(using = LocalDateTimeSerializer.class)
@JsonDeserialize(using = LocalDateTimeDeserializer.class)
private LocalDateTime createdDate;

4

https://stackoverflow.com/a/53251526/1282532是序列化/反序列化属性的最简单方法。我对此方法有两个担忧-某种程度上违反了DRY原理,并且pojo和mapper之间的耦合度很高。

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字段,最好配置映射器而不是POJO。它可以像https://stackoverflow.com/a/35062824/1282532一样简单如果您使用的是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


3

迄今为止最简单,最短的方法:

@JsonFormat(pattern = "yyyy-MM-dd")
private LocalDate localDate;

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime localDateTime;

Spring Boot> = 2.2+时不需要依赖


1

截至2020年和Jackson 2.10.1,不需要任何特殊代码,只需要告诉Jackson您想要什么:

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生成样板。


0

在配置类中,定义LocalDateSerializerLocalDateDeserializer类,然后通过JavaTimeModule将它们注册到ObjectMapper,如下所示:

@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);
        }
    }
}

0

如果您的请求包含这样的对象:

{
    "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。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.