[bael-6309] code for blob serialize deserialize using jackson

Author: uzma

jackson-modules/jackson-conversions-3/pom.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>jackson-conversions-3</artifactId>
+    <name>jackson-conversions-3</name>
+
+    <parent>
+        <groupId>com.baeldung</groupId>
+        <artifactId>jackson-modules</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+    </parent>
+
+    <dependencies>
+        <!-- YAML -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <!-- Allow use of LocalDate -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <!-- CSV -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-csv</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mock-server</groupId>
+            <artifactId>mockserver-netty</artifactId>
+            <version>${mockserver-netty.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>${json.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <finalName>jackson-conversions-3</finalName>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+    </build>
+
+    <properties>
+        <mockserver-netty.version>5.13.2</mockserver-netty.version>
+        <json.version>20240303</json.version>
+    </properties>
+
+</project>

jackson-modules/jackson-conversions-3/src/main/java/com/baeldung/jackson/blob/SqlBlobDeserializer.java

@@ -0,0 +1,23 @@
+package com.baeldung.jackson.blob;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.annotation.JacksonStdImpl;
+
+import javax.sql.rowset.serial.SerialBlob;
+import java.io.IOException;
+import java.sql.Blob;
+
+@JacksonStdImpl
+public class SqlBlobDeserializer extends JsonDeserializer<Blob> {
+    @Override
+    public Blob deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
+        try {
+            byte[] blobBytes = p.getBinaryValue();
+            return new SerialBlob(blobBytes);
+        } catch (Exception e) {
+            throw new IOException("Failed to deserialize Blob", e);
+        }
+    }
+}
+

jackson-modules/jackson-conversions-3/src/main/java/com/baeldung/jackson/blob/SqlBlobSerializer.java

@@ -0,0 +1,21 @@
+package com.baeldung.jackson.blob;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JacksonStdImpl;
+
+import java.io.IOException;
+import java.sql.Blob;
+
+@JacksonStdImpl
+public class SqlBlobSerializer extends JsonSerializer<Blob> {
+    @Override
+    public void serialize(Blob value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
+        try {
+            byte[] blobBytes = value.getBytes(1, (int) value.length());
+            gen.writeBinary(blobBytes);
+        } catch (Exception e) {
+            throw new IOException("Failed to serialize Blob", e);
+        }
+    }
+}

jackson-modules/jackson-conversions-3/src/main/java/com/baeldung/jackson/blob/User.java

@@ -0,0 +1,33 @@
+package com.baeldung.jackson.blob;
+
+import java.sql.Blob;
+
+public class User {
+    private int id;
+    private String name;
+    private Blob profilePicture;
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Blob getProfilePicture() {
+        return profilePicture;
+    }
+
+    public void setProfilePicture(Blob profilePicture) {
+        this.profilePicture = profilePicture;
+    }
+}

jackson-modules/jackson-conversions-3/src/test/java/com/baeldung/jackson/blob/BlobSerDeserUnitTest.java

@@ -0,0 +1,58 @@
+package com.baeldung.jackson.blob;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import javax.sql.rowset.serial.SerialBlob;
+import java.sql.Blob;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class BlobSerDeserUnitTest {
+
+    private ObjectMapper mapper;
+
+    @BeforeEach
+    public void setUp() {
+        this.mapper = new ObjectMapper();
+        SimpleModule module = new SimpleModule();
+        module.addSerializer(Blob.class, new SqlBlobSerializer());
+        module.addDeserializer(Blob.class, new SqlBlobDeserializer());
+        this.mapper.registerModule(module);
+    }
+
+    @Test
+    public void givenUserWithBlob_whenSerialize_thenCorrectJsonDataProduced() throws Exception {
+        User user = new User();
+        user.setId(1);
+        user.setName("John Doe");
+
+        byte[] profilePictureData = "example data".getBytes();
+        Blob profilePictureBlob = new SerialBlob(profilePictureData);
+        user.setProfilePicture(profilePictureBlob);
+
+        String json = mapper.writeValueAsString(user);
+
+        String expectedJson = "{\"id\":1,\"name\":\"John Doe\",\"profilePicture\":\"ZXhhbXBsZSBkYXRh\"}";
+        assertEquals(expectedJson, json);
+    }
+
+    @Test
+    public void givenUserJsonWithBlob_whenDeserialize_thenCorrectDataRecieved() throws Exception {
+
+        String json = "{\"id\":1,\"name\":\"John Doe\",\"profilePicture\":\"ZXhhbXBsZSBkYXRh\"}";
+
+
+        User deserializedUser = mapper.readValue(json, User.class);
+        assertEquals(1, deserializedUser.getId());
+        assertEquals("John Doe", deserializedUser.getName());
+
+        byte[] expectedProfilePictureData = "example data".getBytes();
+        Blob deserializedProfilePictureBlob = deserializedUser.getProfilePicture();
+        byte[] deserializedData = deserializedProfilePictureBlob.getBytes(1, (int) deserializedProfilePictureBlob.length());
+        assertArrayEquals(expectedProfilePictureData, deserializedData);
+    }
+}

jackson-modules/pom.xml

@@ -18,6 +18,7 @@
         <module>jackson-annotations</module>
         <module>jackson-conversions</module>
         <module>jackson-conversions-2</module>
+        <module>jackson-conversions-3</module>
         <module>jackson-core</module>
         <module>jackson-custom-conversions</module>
         <module>jackson-exceptions</module>