Add Byte Array Overloads to ObjectSerializer (Azure#19261)

Add Byte Array Overloads to ObjectSerializer

Author: alzimmermsft

sdk/core/azure-core-experimental/src/main/java/com/azure/core/experimental/serializer/AvroSerializer.java

@@ -14,6 +14,19 @@
  * Generic interface covering basic Avro serialization and deserialization methods.
  */
 public interface AvroSerializer extends ObjectSerializer {
+    /**
+     * Reads an Avro byte array into its object representation.
+     *
+     * @param data Avro byte array.
+     * @param typeReference {@link TypeReference} representing the object.
+     * @param <T> Type of the object.
+     * @return The object represented by the deserialized Avro byte array.
+     */
+    @Override
+    default <T> T deserializeFromBytes(byte[] data, TypeReference<T> typeReference) {
+        return ObjectSerializer.super.deserializeFromBytes(data, typeReference);
+    }
+
     /**
      * Reads an Avro stream into its object representation.
      *
@@ -25,17 +38,39 @@ public interface AvroSerializer extends ObjectSerializer {
     @Override
     <T> T deserialize(InputStream stream, TypeReference<T> typeReference);
 
+    /**
+     * Reads an Avro byte array into its object representation.
+     *
+     * @param data Avro byte array.
+     * @param typeReference {@link TypeReference} representing the object.
+     * @param <T> Type of the object.
+     * @return Reactive stream that emits the object represented by the deserialized Avro byte array.
+     */
+    default <T> Mono<T> deserializeFromBytesAsync(byte[] data, TypeReference<T> typeReference) {
+        return ObjectSerializer.super.deserializeFromBytesAsync(data, typeReference);
+    }
+
     /**
      * Reads an Avro stream into its object representation.
      *
      * @param stream Avro stream.
      * @param typeReference {@link TypeReference} representing the object.
      * @param <T> Type of the object.
-     * @return The object represented by the deserialized Avro stream.
+     * @return Reactive stream that emits the object represented by the deserialized Avro stream.
      */
     @Override
     <T> Mono<T> deserializeAsync(InputStream stream, TypeReference<T> typeReference);
 
+    /**
+     * Converts the object into an Avro byte array.
+     *
+     * @param value The object.
+     * @return The Avro binary representation of the serialized object.
+     */
+    default byte[] serializeToBytes(Object value) {
+        return ObjectSerializer.super.serializeToBytes(value);
+    }
+
     /**
      * Writes an object's Avro representation into a stream.
      *
@@ -45,6 +80,17 @@ public interface AvroSerializer extends ObjectSerializer {
     @Override
     void serialize(OutputStream stream, Object value);
 
+    /**
+     * Converts the object into a Avro byte array.
+     *
+     * @param value The object.
+     * @return Reactive stream that emits the Avro binary representation of the serialized object.
+     */
+    @Override
+    default Mono<byte[]> serializeToBytesAsync(Object value) {
+        return ObjectSerializer.super.serializeToBytesAsync(value);
+    }
+
     /**
      * Writes an object's Avro representation into a stream.
      *

sdk/core/azure-core-serializer-avro-apache/src/main/java/com/azure/core/serializer/avro/apache/ApacheAvroSerializer.java

@@ -9,6 +9,7 @@
 import org.apache.avro.Schema;
 import org.apache.avro.io.DatumReader;
 import org.apache.avro.io.DatumWriter;
+import org.apache.avro.io.Decoder;
 import org.apache.avro.io.DecoderFactory;
 import org.apache.avro.io.Encoder;
 import org.apache.avro.io.EncoderFactory;
@@ -21,6 +22,7 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.UncheckedIOException;
+import java.util.function.Supplier;
 
 /**
  * Apache Avro based implementation of the {@link AvroSerializer} interface.
@@ -41,21 +43,35 @@ public class ApacheAvroSerializer implements AvroSerializer {
         this.specificData = specificData;
     }
 
+    @Override
+    public <T> T deserializeFromBytes(byte[] data, TypeReference<T> typeReference) {
+        return deserialize(data, () -> decoderFactory.binaryDecoder(data, null));
+    }
+
     @Override
     public <T> T deserialize(InputStream stream, TypeReference<T> typeReference) {
-        if (stream == null) {
+        return deserialize(stream, () -> decoderFactory.binaryDecoder(stream, null));
+    }
+
+    private <T> T deserialize(Object data, Supplier<Decoder> decoderSupplier) {
+        if (data == null) {
             return null;
         }
 
         DatumReader<T> reader = new SpecificDatumReader<>(schema, schema, specificData);
 
         try {
-            return reader.read(null, decoderFactory.binaryDecoder(stream, null));
+            return reader.read(null, decoderSupplier.get());
         } catch (IOException ex) {
             throw logger.logExceptionAsError(new UncheckedIOException(ex));
         }
     }
 
+    @Override
+    public <T> Mono<T> deserializeFromBytesAsync(byte[] data, TypeReference<T> typeReference) {
+        return Mono.fromCallable(() -> this.deserializeFromBytes(data, typeReference));
+    }
+
     @Override
     public <T> Mono<T> deserializeAsync(InputStream stream, TypeReference<T> typeReference) {
         return Mono.fromCallable(() -> deserialize(stream, typeReference));

sdk/core/azure-core-serializer-avro-apache/src/test/java/com/azure/core/serializer/avro/apache/ApacheAvroSerializerTests.java

@@ -221,9 +221,16 @@ private static Stream<Arguments> deserializeRecordSupplier() {
     }
 
     @Test
-    public void deserializeNullReturnsNull() {
+    public void deserializeNullInputStreamReturnsNull() {
         StepVerifier.create(getSerializer(schemaCreator("null"))
-            .deserializeAsync(null, createInstance(void.class)))
+            .deserializeAsync((InputStream) null, createInstance(void.class)))
+            .verifyComplete();
+    }
+
+    @Test
+    public void deserializeNullByteArrayReturnsNull() {
+        StepVerifier.create(getSerializer(schemaCreator("null"))
+            .deserializeFromBytesAsync((byte[]) null, createInstance(void.class)))
             .verifyComplete();
     }
 

sdk/core/azure-core-serializer-json-gson/src/main/java/com/azure/core/serializer/json/gson/GsonJsonSerializer.java

@@ -21,7 +21,6 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.Member;
 import java.lang.reflect.Modifier;
-import java.nio.charset.StandardCharsets;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -44,7 +43,11 @@ public final class GsonJsonSerializer implements JsonSerializer, MemberNameConve
 
     @Override
     public <T> T deserialize(InputStream stream, TypeReference<T> typeReference) {
-        return gson.fromJson(new InputStreamReader(stream, StandardCharsets.UTF_8), typeReference.getJavaType());
+        if (stream == null) {
+            return null;
+        }
+
+        return gson.fromJson(new InputStreamReader(stream, UTF_8), typeReference.getJavaType());
     }
 
     @Override
@@ -64,6 +67,11 @@ public void serialize(OutputStream stream, Object value) {
         }
     }
 
+    @Override
+    public Mono<byte[]> serializeToBytesAsync(Object value) {
+        return Mono.fromCallable(() -> serializeToBytes(value));
+    }
+
     @Override
     public Mono<Void> serializeAsync(OutputStream stream, Object value) {
         return Mono.fromRunnable(() -> serialize(stream, value));

sdk/core/azure-core-serializer-json-gson/src/test/java/com/azure/core/serializer/json/gson/GsonJsonSerializerTests.java

@@ -33,6 +33,20 @@ public class GsonJsonSerializerTests {
         .serializer(new GsonBuilder().registerTypeAdapter(Person.class, new PersonAdapter()).create())
         .build();
 
+    @Test
+    public void deserializeNullInputStreamReturnsNull() {
+        StepVerifier.create(DEFAULT_SERIALIZER
+            .deserializeAsync((InputStream) null, TypeReference.createInstance(Person.class)))
+            .verifyComplete();
+    }
+
+    @Test
+    public void deserializeNullByteArrayReturnsNull() {
+        StepVerifier.create(DEFAULT_SERIALIZER
+            .deserializeFromBytesAsync((byte[]) null, TypeReference.createInstance(Person.class)))
+            .verifyComplete();
+    }
+
     @Test
     public void deserializeWithDefaultSerializer() {
         String json = "{\"name\":null,\"age\":50}";

sdk/core/azure-core-serializer-json-jackson/src/main/java/com/azure/core/serializer/json/jackson/JacksonJsonSerializer.java

@@ -49,6 +49,19 @@ public final class JacksonJsonSerializer implements JsonSerializer, MemberNameCo
         this.typeFactory = mapper.getTypeFactory();
     }
 
+    @Override
+    public <T> T deserializeFromBytes(byte[] data, TypeReference<T> typeReference) {
+        if (data == null) {
+            return null;
+        }
+
+        try {
+            return mapper.readValue(data, typeFactory.constructType(typeReference.getJavaType()));
+        } catch (IOException ex) {
+            throw logger.logExceptionAsError(new UncheckedIOException(ex));
+        }
+    }
+
     @Override
     public <T> T deserialize(InputStream stream, TypeReference<T> typeReference) {
         if (stream == null) {
@@ -62,11 +75,25 @@ public <T> T deserialize(InputStream stream, TypeReference<T> typeReference) {
         }
     }
 
+    @Override
+    public <T> Mono<T> deserializeFromBytesAsync(byte[] data, TypeReference<T> typeReference) {
+        return Mono.fromCallable(() -> deserializeFromBytes(data, typeReference));
+    }
+
     @Override
     public <T> Mono<T> deserializeAsync(InputStream stream, TypeReference<T> typeReference) {
         return Mono.fromCallable(() -> deserialize(stream, typeReference));
     }
 
+    @Override
+    public byte[] serializeToBytes(Object value) {
+        try {
+            return mapper.writeValueAsBytes(value);
+        } catch (IOException ex) {
+            throw logger.logExceptionAsError(new UncheckedIOException(ex));
+        }
+    }
+
     @Override
     public void serialize(OutputStream stream, Object value) {
         try {
@@ -76,6 +103,11 @@ public void serialize(OutputStream stream, Object value) {
         }
     }
 
+    @Override
+    public Mono<byte[]> serializeToBytesAsync(Object value) {
+        return Mono.fromCallable(() -> this.serializeToBytes(value));
+    }
+
     @Override
     public Mono<Void> serializeAsync(OutputStream stream, Object value) {
         return Mono.fromRunnable(() -> serialize(stream, value));

sdk/core/azure-core-serializer-json-jackson/src/test/java/com/azure/core/serializer/json/jackson/JacksonJsonSerializerTests.java

@@ -39,8 +39,16 @@ public class JacksonJsonSerializerTests {
         .build();
 
     @Test
-    public void deserializeNull() {
-        StepVerifier.create(DEFAULT_SERIALIZER.deserializeAsync(null, TypeReference.createInstance(Person.class)))
+    public void deserializeNullInputStreamReturnsNull() {
+        StepVerifier.create(DEFAULT_SERIALIZER
+            .deserializeAsync((InputStream) null, TypeReference.createInstance(Person.class)))
+            .verifyComplete();
+    }
+
+    @Test
+    public void deserializeNullByteArrayReturnsNull() {
+        StepVerifier.create(DEFAULT_SERIALIZER
+            .deserializeFromBytesAsync((byte[]) null, TypeReference.createInstance(Person.class)))
             .verifyComplete();
     }
 

sdk/core/azure-core/src/main/java/com/azure/core/util/BinaryData.java

@@ -214,13 +214,7 @@ public static BinaryData fromBytes(byte[] data) {
      * @see JsonSerializer
      */
     public static BinaryData fromObject(Object data) {
-        if (Objects.isNull(data)) {
-            return EMPTY_DATA;
-        }
-        final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        getDefaultSerializer().serialize(outputStream, data);
-
-        return new BinaryData(outputStream.toByteArray());
+        return fromObject(data, getDefaultSerializer());
     }
 
     /**
@@ -241,7 +235,7 @@ public static BinaryData fromObject(Object data) {
      * @see JsonSerializer
      */
     public static Mono<BinaryData> fromObjectAsync(Object data) {
-        return Mono.fromCallable(() -> fromObject(data));
+        return fromObjectAsync(data, getDefaultSerializer());
     }
 
     /**
@@ -278,9 +272,7 @@ public static BinaryData fromObject(Object data, ObjectSerializer serializer) {
 
         Objects.requireNonNull(serializer, "'serializer' cannot be null.");
 
-        final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        serializer.serialize(outputStream, data);
-        return new BinaryData(outputStream.toByteArray());
+        return new BinaryData(serializer.serializeToBytes(data));
     }
 
     /**
@@ -461,8 +453,7 @@ public <T> T toObject(TypeReference<T> typeReference, ObjectSerializer serialize
         Objects.requireNonNull(typeReference, "'typeReference' cannot be null.");
         Objects.requireNonNull(serializer, "'serializer' cannot be null.");
 
-        InputStream jsonStream = new ByteArrayInputStream(this.data);
-        return serializer.deserialize(jsonStream, typeReference);
+        return serializer.deserializeFromBytes(this.data, typeReference);
     }
 
     /**
@@ -515,7 +506,7 @@ public <T> Mono<T> toObjectAsync(Class<T> clazz) {
      * @see JsonSerializer
      */
     public <T> Mono<T> toObjectAsync(TypeReference<T> typeReference) {
-        return Mono.fromCallable(() -> toObject(typeReference));
+        return toObjectAsync(typeReference, getDefaultSerializer());
     }
 
     /**