Java.util.Dateの場合
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy")
private Date dateOfBirth;
jSONリクエストで送信すると
{ {"dateOfBirth":"01/01/2000"} }
できます。
Java 8のLocalDate fieldのためにはどうすればいいですか?
やってみた
@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>
私はこれをアノテーションを使って簡単に動作させることはできませんでした。これを機能させるために、ContextResolver
に ObjectMapper
を作成し、次にJSR310Module
をもう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を使用していたことです。 jsr310
起こったことは私がObjectIdResolver
のためのNoClassDefFoundを持っていたということでした、それは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
はJacksonのバージョン2.7の時点で非推奨です。代わりに、モジュールJavaTimeModule
を登録する必要があります。それはまだ同じ依存関係です。
@ 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));
}
}
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
私にとってはうまくいきます。
'jackson'と 'jsr310'のバージョンが "2.8.5"のSpring Boot Webアプリの場合
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;
プロジェクトで以下の依存関係を使用している間。
Maven
<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を追加で実装する必要はありません。
LocalDateSerializer
はデフォルトで "year-month-day"(json文字列)ではなく "[year、month、day]"(json配列)に変換されるので、特別なObjectMapper
の設定は必要ないのでSerializationFeature.WRITE_DATES_AS_TIMESTAMPS
を無効にするとLocalDateSerializer
に文字列を生成させることができますが、それには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()
を使うことができます。
Christopherの回答を更新したものです。
バージョン以降2.6.0
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.0</version>
</dependency>
JSR310Moduleの代わりにJavaTimeModuleを使用します(廃止予定)。
@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;
}
}
documentation によると、新しいJavaTimeModuleは、デフォルトでタイムゾーンIDを使用しない標準化と同じ標準設定を使用し、代わりにISO-8601準拠のタイムゾーンオフセットのみを使用します。
振る舞いはSerializationFeature.WRITE_DATES_WITH_ZONE_IDを使用して変更できます。
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の代わりにマッパーを設定するのが良いです。 ISO-8601の値を使用している場合は、 https://stackoverflow.com/a/35062824/1282532 と同じくらい簡単です( "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のために再利用することができます
設定クラスでは、LocalDateSerializerとLocalDateDeserializerクラスを定義し、ObjectMapper via 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);
}
}
}