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>

回答:


106

注釈を使用してこれを簡単に機能させることはできませんでした。それを機能させるContextResolverためにObjectMapper、for を作成し、次にJSR310Moduleupdate:now it is JavaTimeModule代わりに)を追加し、さらに1つの警告を追加しました。これは、write-date-as-timestampをfalseに設定する必要があったためです。JSR310モジュールのドキュメントで詳細を参照してください。これが私が使った例です。

依存

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

注:これで私が直面した1つの問題jackson-annotationは、別の依存関係によって取り込まれたバージョンがバージョン2.3.2を使用していたため、に必要な2.4がキャンセルされたことjsr310です。何が起こったのかObjectIdResolverは、2.4クラスのNoClassDefFoundを取得したことです。だから私は含まれている依存関係のバージョンを並べる必要がありました

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ソリューション。

更新

JSR310Moduleジャクソンのバージョン2.7から非推奨になりました。代わりに、モジュールを登録する必要があります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 ":" "}}どうすればそれを簡単に作成できますか"birthDate" ???
JAB 2015年

ContextResolverが呼び出されていることを確認します。getContextメソッドにprintステートメントを追加します。このメソッドが呼び出された場合、これが機能しない理由はわかりません。呼び出されない場合は、アプリの構成で修正する必要がある可能性があります。そのためには、あなたが提供した以上のものを見る必要があります。Resteasyのバージョン、依存関係と同様に、web.xmlまたはApplicationサブクラスのいずれかのアプリ構成。基本的に問題を再現するのに十分です
Paul Samsotha

ContextResolverはPeeskilletと呼ばれていません。<context-param> <param-name> resteasy.resources </ param-name> <param-value> com.bac.ObjectMapperContextResolver </ param-value> </ context-param>としてweb.xmlに登録しています私が使用している依存関係の更新された質問
JAB

Swaggerが問題のようです。私はそれを無効にするつもりですが、この質問から見て SwaggerのObjectMapperと独自のObjectMapperの使用が競合するという問題が提起されています。あなたはそれらを試して無効にすることができ、ContextResolverで、すべての構成をswaggerと同じように設定しますObjectMapper(質問のリンクを見ることができます)。私はswaggerをあまり使っていないのでわかりません。しかし、swaggerが主な問題だと思います。なぜcontextresolverが呼び出されないのでしょうか。
ポールサムソタ2015年

さらなるテストの後、アノテーション機能します。Swagger ObjectMapperを使用する必要がある場合でも、タイムスタンプは既にfalseに設定されています。これでうまくいくはずです。より良いヘルプのために、問題を示すMCVEを提供することを強くお勧めします。
Paul Samsotha

95

@JsonSerializeと@JsonDeserializeは私にとってはうまくいきました。追加のjs310モジュールをインポートする必要がなくなります。

@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
これが私にとって最良の答えです。ありがとう!
Romeo Jr Maranan

7
これらのクラスはに含まれていjackson-datatype-jsr310ます。プロジェクトで手動で定義する必要はありません。
NeuroXc

1
このソリューションは、のシリアライザーを使用して私に役立ちましたjackson-datatype-jsr310
デイブ

2
これが新しい最良の答えになるはずです。
ドクターパラメーター

1
jackson-datatype-jsr310でシリアライザーとデシリアライザーを使用する場合は、@ JsonFormat(shape = JsonFormat.Shape.STRING)をフィールドに追加することをお勧めします。この形式がない場合、値は[年、月、日]としてシリアル化されますが、逆シリアル化は機能します。
Jian Chen

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()ジャクソンのバージョン2.5.4。JavaTimeModuleクラスはこのバージョンには存在しません。
user3774109 2017

この答えはLocalDateTime(jackson 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 2018

完璧に働きました!ありがとうございました。
MAD-HAX

これは正しい方向に私を向けました、ありがとう!スプリングブートで必要なのは、application.propertiesに以下を追加することだけです。spring.jackson.serialization.write-dates-as-timestamps= false
Joost Lambregts

46

Spring Boot Webアプリで、JacksonおよびJSR 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
これは逆シリアル化で機能しますか?またはシリアル化のみですか?逆シリアル化で成功しない
リウルフ2017年

7
私はデシリアライザを明示的に宣言しなければなり@JsonDeserialize(using= LocalDateDeserializer.class)
ませんでした

1
はるかに簡単です!
アントニオ

@JsonFormat出力データ形式を変更するためだけです。 stackoverflow.com/a/53251526/816759はで完璧に動作します@JsonFormat@JsonDeserialize@JsonSerialize
バハ

あなたはJSR310の依存関係を追加したら、春ブーツでは、すべてを行う必要が追加されspring.jackson.serialization.write-dates-as-timestamps=false、あなたにapplication.properties、そしてそれは、それをフォーマットyyyy-MM-ddに自動的に。必要なし@JsonFormat
esfandia

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>

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の追加の実装は必要ありません。


華麗で、遠く離れていても、最も簡単です。参考までに、多くの依存関係がある人は、Jacksonアノテーションを組み込んだ他のいくつかのライブラリを更新する必要がありました。
BRT

この答えは、問題を解決するために最も近いものです。直列化は働いているが、直列化復元はので、私は私が(@JsonFormat(形状= JsonFormat.Shape.STRING、パターン=考える@JsonFormatで使用するパターンで失敗している"DD-MM-yyyy_HH:MM:SS"。)
fsakiyama

逆シリアル化に失敗した場合は、おそらく登録されてObjectMapperいない可能性がありますJavaTimeModule。ObjectMapperインスタンスがspring / MessageConverterフレームワークから提供される場合。彼らはそれらを接続するためにいくつかの魔法をかけました。他の場合では、POJOのすべての「LocalDate」に対してデフォルトでregisterModule有効にする必要LocalDateDeserializerがあります
Dennis C

19

以来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 (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

1
正解です。(1桁の月または日)形式yyyy-MM-ddではなく、(2桁の月と日)形式で動作しyyyy-M-dます。
シャドウマン

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

6

次の注釈は私にはうまくいきました。

追加の依存関係は必要ありません。

    @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は、プロパティをシリアライズ/デシリアライズする最も簡単な方法です。私はこのアプローチに関して2つの懸念を抱いています。DRY原則へのある程度の違反と、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;
}

複数のLocalDateフィールドを持つPOJOがある場合は、POJOではなくマッパーを構成することをお勧めします。https://stackoverflow.com/a/35062824/1282532のようにシンプルにすることができますISO-8601値( "2019-01-31")を使用している場合は //stackoverflow.com/a/35062824/1282532の

カスタム形式を処理する必要がある場合、コードは次のようになります。

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ブートでは依存関係は必要ありません> = 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

構成クラスでLocalDateSerializerおよびLocalDateDeserializerクラスを定義し、以下のように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でも機能します。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.