Skip to content

Commit

Permalink
Merge pull request #4739 from geoand/kafka-conditional-jsonb
Browse files Browse the repository at this point in the history
Tighten integration between Kafka client and jsonb - Add Jackson support
  • Loading branch information
gsmet authored Oct 23, 2019
2 parents 9467e13 + 6a58c64 commit 500d24f
Show file tree
Hide file tree
Showing 18 changed files with 285 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ public final class Capabilities extends SimpleBuildItem {
public static final String CDI_ARC = "io.quarkus.cdi";
public static final String SERVLET = "io.quarkus.servlet";
public static final String TRANSACTIONS = "io.quarkus.transactions";
public static final String JACKSON = "io.quarkus.jackson";
public static final String JSONB = "io.quarkus.jsonb";
public static final String RESTEASY_JSON_EXTENSION = "io.quarkus.resteasy-json";
public static final String SECURITY = "io.quarkus.security";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.arc.deployment.GeneratedBeanBuildItem;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
Expand Down Expand Up @@ -63,7 +64,7 @@ public class JacksonProcessor {
@Inject
List<IgnoreJsonDeserializeClassBuildItem> ignoreJsonDeserializeClassBuildItems;

@BuildStep
@BuildStep(providesCapabilities = Capabilities.JACKSON)
void register() {
addReflectiveClass(true, false,
"com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import io.quarkus.arc.deployment.GeneratedBeanBuildItem;
import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
import io.quarkus.arc.processor.BeanInfo;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
Expand All @@ -53,7 +54,7 @@ public class JsonbProcessor {
private static final DotName JSONB_TYPE_SERIALIZER = DotName.createSimple(JsonbTypeSerializer.class.getName());
private static final DotName JSONB_TYPE_DESERIALIZER = DotName.createSimple(JsonbTypeDeserializer.class.getName());

@BuildStep
@BuildStep(providesCapabilities = Capabilities.JSONB)
void build(BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
BuildProducer<SubstrateResourceBundleBuildItem> resourceBundle,
BuildProducer<ServiceProviderBuildItem> serviceProvider,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;

import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
Expand All @@ -45,6 +46,8 @@
import io.quarkus.gizmo.MethodDescriptor;
import io.quarkus.kafka.client.serialization.JsonbDeserializer;
import io.quarkus.kafka.client.serialization.JsonbSerializer;
import io.quarkus.kafka.client.serialization.ObjectMapperDeserializer;
import io.quarkus.kafka.client.serialization.ObjectMapperSerializer;

public class KafkaProcessor {

Expand All @@ -59,7 +62,6 @@ public class KafkaProcessor {
ByteBufferSerializer.class,
StringSerializer.class,
FloatSerializer.class,
JsonbSerializer.class,

//deserializers
ShortDeserializer.class,
Expand All @@ -71,13 +73,12 @@ public class KafkaProcessor {
ByteBufferDeserializer.class,
StringDeserializer.class,
FloatDeserializer.class,
JsonbDeserializer.class,
};
static final String TARGET_JAVA_9_CHECKSUM_FACTORY = "io.quarkus.kafka.client.generated.Target_Java9ChecksumFactory";

@BuildStep
public void build(CombinedIndexBuildItem indexBuildItem, BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
BuildProducer<JniBuildItem> jni) {
BuildProducer<JniBuildItem> jni, Capabilities capabilities) {
Collection<ClassInfo> serializers = indexBuildItem.getIndex()
.getAllKnownSubclasses(DotName.createSimple(Serializer.class.getName()));
Collection<ClassInfo> deserializers = indexBuildItem.getIndex()
Expand All @@ -90,6 +91,13 @@ public void build(CombinedIndexBuildItem indexBuildItem, BuildProducer<Reflectiv
for (Class i : BUILT_INS) {
reflectiveClass.produce(new ReflectiveClassBuildItem(false, false, i.getName()));
}
if (capabilities.isCapabilityPresent(Capabilities.JSONB)) {
reflectiveClass.produce(new ReflectiveClassBuildItem(false, false, JsonbSerializer.class, JsonbDeserializer.class));
}
if (capabilities.isCapabilityPresent(Capabilities.JACKSON)) {
reflectiveClass.produce(
new ReflectiveClassBuildItem(false, false, ObjectMapperSerializer.class, ObjectMapperDeserializer.class));
}

for (Collection<ClassInfo> list : Arrays.asList(serializers, deserializers, partitioners, partitionAssignors)) {
for (ClassInfo s : list) {
Expand Down
5 changes: 5 additions & 0 deletions extensions/kafka-client/runtime/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@
<artifactId>quarkus-jsonb</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-jackson</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.apache.kafka</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import java.util.Map;

import javax.json.bind.Jsonb;
import javax.json.bind.JsonbBuilder;

import org.apache.kafka.common.serialization.Deserializer;

Expand All @@ -20,7 +19,7 @@ public class JsonbDeserializer<T> implements Deserializer<T> {
private final boolean jsonbNeedsClosing;

public JsonbDeserializer(Class<T> type) {
this(type, JsonbBuilder.create(), true);
this(type, JsonbProducer.get(), true);
}

public JsonbDeserializer(Class<T> type, Jsonb jsonb) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package io.quarkus.kafka.client.serialization;

import javax.json.bind.Jsonb;
import javax.json.bind.JsonbBuilder;

import io.quarkus.arc.Arc;
import io.quarkus.arc.ArcContainer;

final class JsonbProducer {

private JsonbProducer() {
}

// Try to get JSON-B from Arc but fallback to regular JSON-B creation
// The fallback could be used for example in unit tests where Arc has not been initialized
static Jsonb get() {
Jsonb jsonb = null;
ArcContainer container = Arc.container();
if (container != null) {
jsonb = container.instance(Jsonb.class).get();
}
return jsonb != null ? jsonb : JsonbBuilder.create();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import java.util.Map;

import javax.json.bind.Jsonb;
import javax.json.bind.JsonbBuilder;

import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.Serde;
Expand All @@ -21,7 +20,7 @@ public class JsonbSerde<T> implements Serde<T> {
private final JsonbDeserializer<T> deserializer;

public JsonbSerde(Class<T> type) {
this(type, JsonbBuilder.create(), true);
this(type, JsonbProducer.get(), true);
}

public JsonbSerde(Class<T> type, Jsonb jsonb) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import java.util.Map;

import javax.json.bind.Jsonb;
import javax.json.bind.JsonbBuilder;

import org.apache.kafka.common.serialization.Serializer;

Expand All @@ -18,7 +17,7 @@ public class JsonbSerializer<T> implements Serializer<T> {
private final boolean jsonbNeedsClosing;

public JsonbSerializer() {
this(JsonbBuilder.create(), true);
this(JsonbProducer.get(), true);
}

public JsonbSerializer(Jsonb jsonb) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package io.quarkus.kafka.client.serialization;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;

import org.apache.kafka.common.serialization.Deserializer;

import com.fasterxml.jackson.databind.ObjectMapper;

public class ObjectMapperDeserializer<T> implements Deserializer<T> {

private final Class<T> type;
private final ObjectMapper objectMapper;

public ObjectMapperDeserializer(Class<T> type) {
this(type, ObjectMapperProducer.get());
}

public ObjectMapperDeserializer(Class<T> type, ObjectMapper objectMapper) {
this.type = type;
this.objectMapper = objectMapper;
}

@Override
public void configure(Map<String, ?> configs, boolean isKey) {
}

@Override
public T deserialize(String topic, byte[] data) {
if (data == null) {
return null;
}

try (InputStream is = new ByteArrayInputStream(data)) {
return objectMapper.readValue(is, type);
} catch (IOException e) {
throw new RuntimeException(e);
}
}

@Override
public void close() {
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package io.quarkus.kafka.client.serialization;

import com.fasterxml.jackson.databind.ObjectMapper;

import io.quarkus.arc.Arc;
import io.quarkus.arc.ArcContainer;

final class ObjectMapperProducer {

private ObjectMapperProducer() {
}

// Try to get JSON-B from Arc but fallback to regular ObjectMapper creation
// The fallback could be used for example in unit tests where Arc has not been initialized
static ObjectMapper get() {
ObjectMapper objectMapper = null;
ArcContainer container = Arc.container();
if (container != null) {
objectMapper = container.instance(ObjectMapper.class).get();
}
return objectMapper != null ? objectMapper : new ObjectMapper();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package io.quarkus.kafka.client.serialization;

import java.util.Map;

import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.Serde;
import org.apache.kafka.common.serialization.Serializer;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
* A {@link Serde} that (de-)serializes JSON using Jackson's ObjectMapper.
*/
public class ObjectMapperSerde<T> implements Serde<T> {

private final ObjectMapperSerializer<T> serializer;
private final ObjectMapperDeserializer<T> deserializer;

public ObjectMapperSerde(Class<T> type) {
this(type, ObjectMapperProducer.get());
}

public ObjectMapperSerde(Class<T> type, ObjectMapper objectMapper) {
this.serializer = new ObjectMapperSerializer<T>(objectMapper);
this.deserializer = new ObjectMapperDeserializer<T>(type, objectMapper);
}

@Override
public void configure(Map<String, ?> configs, boolean isKey) {

}

@Override
public void close() {
serializer.close();
deserializer.close();
}

@Override
public Serializer<T> serializer() {
return serializer;
}

@Override
public Deserializer<T> deserializer() {
return deserializer;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package io.quarkus.kafka.client.serialization;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Map;

import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.Serializer;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
* A {@link Deserializer} that deserializes JSON using Jackson's ObjectMapper.
*/
public class ObjectMapperSerializer<T> implements Serializer<T> {

private final ObjectMapper objectMapper;

public ObjectMapperSerializer() {
this(ObjectMapperProducer.get());
}

public ObjectMapperSerializer(ObjectMapper objectMapper) {
this.objectMapper = objectMapper;
}

@Override
public void configure(Map<String, ?> configs, boolean isKey) {
}

@Override
public byte[] serialize(String topic, T data) {
try (ByteArrayOutputStream output = new ByteArrayOutputStream()) {
objectMapper.writeValue(output, data);
return output.toByteArray();
} catch (IOException e) {
throw new RuntimeException(e);
}
}

@Override
public void close() {
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package io.quarkus.kafka.client.serde;

import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.Test;

import com.fasterxml.jackson.databind.ObjectMapper;

import io.quarkus.kafka.client.serialization.ObjectMapperSerde;

public class ObjectMapperSerdeTest {

@Test
public void shouldSerializeAndDeserializeEntity() {
MyEntity entity = new MyEntity();
entity.id = 42L;
entity.name = "Bob";

try (ObjectMapperSerde<MyEntity> serde = new ObjectMapperSerde<>(MyEntity.class)) {
byte[] serialized = serde.serializer().serialize("my-topic", entity);
MyEntity deserialized = serde.deserializer().deserialize("my-topic", serialized);

assertThat(deserialized.id).isEqualTo(42L);
assertThat(deserialized.name).isEqualTo("Bob");
}
}

@Test
public void shouldSerializeAndDeserializeEntityWithGivenObjectMapper() throws Exception {
MyEntity entity = new MyEntity();
entity.id = 42L;
entity.name = "Bob";

ObjectMapper objectMapper = new ObjectMapper();
try (ObjectMapperSerde<MyEntity> serde = new ObjectMapperSerde<>(MyEntity.class, objectMapper)) {
byte[] serialized = serde.serializer().serialize("my-topic", entity);
MyEntity deserialized = serde.deserializer().deserialize("my-topic", serialized);

assertThat(deserialized.id).isEqualTo(42L);
assertThat(deserialized.name).isEqualTo("Bob");
}
}

public static class MyEntity {
public long id;
public String name;
}
}
Loading

0 comments on commit 500d24f

Please sign in to comment.