From 4118d16b31f6cfa3774c2af4fe43a1ed3ac87240 Mon Sep 17 00:00:00 2001 From: Matheus Cruz Date: Mon, 17 Mar 2025 10:28:09 -0300 Subject: [PATCH 1/2] Allow customize ObjectSerializer using a custom ObjectMapper Signed-off-by: Matheus Cruz --- sdk/pom.xml | 6 ++ .../java/io/dapr/client/ObjectSerializer.java | 14 ++-- .../CustomizableObjectSerializer.java | 23 +++++ .../serializer/ObjectSerializerFactory.java | 10 +++ .../CustomObjectSerializerTest.java | 83 +++++++++++++++++++ 5 files changed, 131 insertions(+), 5 deletions(-) create mode 100644 sdk/src/main/java/io/dapr/serializer/CustomizableObjectSerializer.java create mode 100644 sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java create mode 100644 sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java diff --git a/sdk/pom.xml b/sdk/pom.xml index a97f506dff..29e1478202 100644 --- a/sdk/pom.xml +++ b/sdk/pom.xml @@ -127,6 +127,12 @@ grpc-inprocess test + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + 2.18.2 + test + diff --git a/sdk/src/main/java/io/dapr/client/ObjectSerializer.java b/sdk/src/main/java/io/dapr/client/ObjectSerializer.java index a131060b90..ce18ebc909 100644 --- a/sdk/src/main/java/io/dapr/client/ObjectSerializer.java +++ b/sdk/src/main/java/io/dapr/client/ObjectSerializer.java @@ -43,6 +43,10 @@ public class ObjectSerializer { protected ObjectSerializer() { } + protected ObjectMapper getObjectMapper() { + return OBJECT_MAPPER; + } + /** * Serializes a given state object into byte array. * @@ -70,7 +74,7 @@ public byte[] serialize(Object state) throws IOException { } // Not string, not primitive, so it is a complex type: we use JSON for that. - return OBJECT_MAPPER.writeValueAsBytes(state); + return getObjectMapper().writeValueAsBytes(state); } /** @@ -83,7 +87,7 @@ public byte[] serialize(Object state) throws IOException { * @throws IOException In case content cannot be deserialized. */ public T deserialize(byte[] content, TypeRef type) throws IOException { - return deserialize(content, OBJECT_MAPPER.constructType(type.getType())); + return deserialize(content, getObjectMapper().constructType(type.getType())); } /** @@ -96,7 +100,7 @@ public T deserialize(byte[] content, TypeRef type) throws IOException { * @throws IOException In case content cannot be deserialized. */ public T deserialize(byte[] content, Class clazz) throws IOException { - return deserialize(content, OBJECT_MAPPER.constructType(clazz)); + return deserialize(content, getObjectMapper().constructType(clazz)); } private T deserialize(byte[] content, JavaType javaType) throws IOException { @@ -138,7 +142,7 @@ private T deserialize(byte[] content, JavaType javaType) throws IOException } } - return OBJECT_MAPPER.readValue(content, javaType); + return getObjectMapper().readValue(content, javaType); } /** @@ -149,7 +153,7 @@ private T deserialize(byte[] content, JavaType javaType) throws IOException * @throws IOException In case content cannot be parsed. */ public JsonNode parseNode(byte[] content) throws IOException { - return OBJECT_MAPPER.readTree(content); + return getObjectMapper().readTree(content); } /** diff --git a/sdk/src/main/java/io/dapr/serializer/CustomizableObjectSerializer.java b/sdk/src/main/java/io/dapr/serializer/CustomizableObjectSerializer.java new file mode 100644 index 0000000000..1838815d63 --- /dev/null +++ b/sdk/src/main/java/io/dapr/serializer/CustomizableObjectSerializer.java @@ -0,0 +1,23 @@ +package io.dapr.serializer; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.dapr.client.ObjectSerializer; + +public class CustomizableObjectSerializer extends ObjectSerializer implements DaprObjectSerializer { + + private final ObjectMapper objectMapper; + + public CustomizableObjectSerializer(ObjectMapper objectMapper) { + this.objectMapper = objectMapper; + } + + @Override + public ObjectMapper getObjectMapper() { + return objectMapper; + } + + @Override + public String getContentType() { + return "application/json"; + } +} diff --git a/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java b/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java new file mode 100644 index 0000000000..5353852dcf --- /dev/null +++ b/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java @@ -0,0 +1,10 @@ +package io.dapr.serializer; + +import com.fasterxml.jackson.databind.ObjectMapper; + +public interface ObjectSerializerFactory { + + static DaprObjectSerializer createJacksonSerializer(final ObjectMapper objectMapper) { + return new CustomizableObjectSerializer(objectMapper); + } +} diff --git a/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java b/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java new file mode 100644 index 0000000000..b185da02d5 --- /dev/null +++ b/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java @@ -0,0 +1,83 @@ +/* + * Copyright 2021 The Dapr Authors + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and +limitations under the License. +*/ + +package io.dapr.serializer; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import com.google.common.base.Objects; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.io.Serializable; +import java.time.ZoneId; +import java.time.ZonedDateTime; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.fail; + +public class CustomObjectSerializerTest { + + private static final DaprObjectSerializer SERIALIZER = + ObjectSerializerFactory.createJacksonSerializer(new ObjectMapper() + .registerModule(new JavaTimeModule()) + .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) + .setSerializationInclusion(JsonInclude.Include.NON_NULL) + .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)); + + public static class ObjectForTesting implements Serializable { + private ZonedDateTime time; + + public ZonedDateTime getTime() { + return time; + } + + public void setTime(ZonedDateTime time) { + this.time = time; + } + + @Override + public boolean equals(Object o) { + if (o == null || getClass() != o.getClass()) { + return false; + } + ObjectForTesting that = (ObjectForTesting) o; + return Objects.equal(time, that.time); + } + + @Override + public int hashCode() { + return Objects.hashCode(time); + } + } + + @Test + public void serializeObjectForTesting() { + ObjectForTesting obj = new ObjectForTesting(); + obj.setTime(ZonedDateTime.of(1900, 1, 1, 1, 1, 0, 0, ZoneId.of("UTC"))); + String expectedResult = + "{\"time\":\"1900-01-01T01:01:00Z\"}"; + + String serializedValue; + try { + serializedValue = new String(SERIALIZER.serialize(obj)); + assertEquals(expectedResult, serializedValue, + "FOUND:[[" + serializedValue + "]] \n but was EXPECTING: [[" + expectedResult + "]]"); + } catch (IOException exception) { + fail(exception.getMessage()); + } + } +} From d5aa74208520e76a4b7f56b38caff8e7e018dda6 Mon Sep 17 00:00:00 2001 From: Matheus Cruz Date: Mon, 17 Mar 2025 15:53:55 -0300 Subject: [PATCH 2/2] Apply pull request suggestions Signed-off-by: Matheus Cruz --- sdk/pom.xml | 2 +- .../io/dapr/serializer/ObjectSerializerFactory.java | 10 ---------- .../io/dapr/serializer/CustomObjectSerializerTest.java | 2 +- 3 files changed, 2 insertions(+), 12 deletions(-) delete mode 100644 sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java diff --git a/sdk/pom.xml b/sdk/pom.xml index 29e1478202..16093ec929 100644 --- a/sdk/pom.xml +++ b/sdk/pom.xml @@ -130,7 +130,7 @@ com.fasterxml.jackson.datatype jackson-datatype-jsr310 - 2.18.2 + ${jackson.version} test diff --git a/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java b/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java deleted file mode 100644 index 5353852dcf..0000000000 --- a/sdk/src/main/java/io/dapr/serializer/ObjectSerializerFactory.java +++ /dev/null @@ -1,10 +0,0 @@ -package io.dapr.serializer; - -import com.fasterxml.jackson.databind.ObjectMapper; - -public interface ObjectSerializerFactory { - - static DaprObjectSerializer createJacksonSerializer(final ObjectMapper objectMapper) { - return new CustomizableObjectSerializer(objectMapper); - } -} diff --git a/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java b/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java index b185da02d5..d32ccbeddf 100644 --- a/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java +++ b/sdk/src/test/java/io/dapr/serializer/CustomObjectSerializerTest.java @@ -32,7 +32,7 @@ public class CustomObjectSerializerTest { private static final DaprObjectSerializer SERIALIZER = - ObjectSerializerFactory.createJacksonSerializer(new ObjectMapper() + new CustomizableObjectSerializer(new ObjectMapper() .registerModule(new JavaTimeModule()) .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) .setSerializationInclusion(JsonInclude.Include.NON_NULL)