Jackson module: Add XML support and remove BlackBird

jknack · jknack · commit 3189fd725b4b · 2021-09-22T19:13:57.000-03:00
- Added JacksonModule.create(Module...) to customize defaults setup - Added JacksonModule(ObjectMapper, MediaType) for custom object mapper or content types - Removed BlackBirdModule from JacksonModule.create - Fixes #2428 - Fixes #2413
diff --git a/docs/asciidoc/modules/jackson.adoc b/docs/asciidoc/modules/jackson.adoc
@@ -111,6 +111,52 @@ import io.jooby.json.JacksonModule
 }
 ----
 
+This allows to configure JacksonModule for doing `xml` processing:
+
+.XmlMapper
+[source, java, role="primary"]
+----
+import io.jooby.json.JacksonModule;
+
+{
+  install(new JacksonModule(new XmlMapper()));
+}
+----
+
+.Kotlin
+[source, kt, role="secondary"]
+----
+import io.jooby.json.JacksonModule
+
+{
+  install(JacksonModule(XmlMapper()))
+}
+----
+
+If you want `json` and `xml` processing then install twice:
+
+.XmlMapper
+[source, java, role="primary"]
+----
+import io.jooby.json.JacksonModule;
+
+{
+  install(new JacksonModule(new ObjectMapper()));
+  install(new JacksonModule(new XmlMapper()));
+}
+----
+
+.Kotlin
+[source, kt, role="secondary"]
+----
+import io.jooby.json.JacksonModule
+
+{
+  install(JacksonModule(ObjectMapper()))
+  install(JacksonModule(XmlMapper()))
+}
+----
+
 === Provisioning Jackson Modules
 
 Jackson module can be provided by a link:/#dependency-injection[dependency injection] framework.
@@ -135,4 +181,4 @@ import io.jooby.json.JacksonModule
 }
 ----
 
-At startup time Jooby ask to the dependency injection framework to provide a `MyModule` instance.
+At startup time Jooby ask to dependency injection framework to provide a `MyModule` instance.
diff --git a/modules/jooby-jackson/pom.xml b/modules/jooby-jackson/pom.xml
@@ -46,11 +46,6 @@
       <artifactId>jackson-module-parameter-names</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>com.fasterxml.jackson.module</groupId>
-      <artifactId>jackson-module-blackbird</artifactId>
-    </dependency>
-
     <!-- Test dependencies -->
     <dependency>
       <groupId>org.junit.jupiter</groupId>
@@ -70,5 +65,12 @@
       <artifactId>mockito-core</artifactId>
       <scope>test</scope>
     </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.dataformat</groupId>
+      <artifactId>jackson-dataformat-xml</artifactId>
+      <scope>test</scope>
+    </dependency>
+
   </dependencies>
 </project>
diff --git a/modules/jooby-jackson/src/main/java/io/jooby/json/JacksonModule.java b/modules/jooby-jackson/src/main/java/io/jooby/json/JacksonModule.java
@@ -13,7 +13,6 @@
 import com.fasterxml.jackson.databind.type.TypeFactory;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
-import com.fasterxml.jackson.module.blackbird.BlackbirdModule;
 import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
 import io.jooby.Body;
 import io.jooby.Context;
@@ -28,8 +27,11 @@
 import javax.annotation.Nonnull;
 import java.io.InputStream;
 import java.lang.reflect.Type;
+import java.util.HashMap;
 import java.util.HashSet;
+import java.util.Map;
 import java.util.Set;
+import java.util.stream.Stream;
 
 /**
  * JSON module using Jackson: https://jooby.io/modules/jackson.
@@ -75,24 +77,43 @@
  * @since 2.0.0
  */
 public class JacksonModule implements Extension, MessageDecoder, MessageEncoder {
+  private final MediaType mediaType;
+
   private final ObjectMapper mapper;
 
   private final TypeFactory typeFactory;
 
   private final Set<Class<? extends Module>> modules = new HashSet<>();
 
+  private static final Map<String, MediaType> defaultTypes = new HashMap<>();
+
+  static {
+    defaultTypes.put("XmlMapper", MediaType.xml);
+  }
+
   /**
    * Creates a Jackson module.
    *
    * @param mapper Object mapper to use.
+   * @param contentType Content type.
    */
-  public JacksonModule(@Nonnull ObjectMapper mapper) {
+  public JacksonModule(@Nonnull ObjectMapper mapper, @Nonnull MediaType contentType) {
     this.mapper = mapper;
     this.typeFactory = mapper.getTypeFactory();
+    this.mediaType = contentType;
+  }
+
+  /**
+   * Creates a Jackson module.
+   *
+   * @param mapper Object mapper to use.
+   */
+  public JacksonModule(@Nonnull ObjectMapper mapper) {
+    this(mapper, defaultTypes.getOrDefault(mapper.getClass().getSimpleName(), MediaType.json));
   }
 
   /**
-   * Creates a Jackson module using the default object mapper from {@link #create()}.
+   * Creates a Jackson module using the default object mapper from {@link #create(Module...)}.
    */
   public JacksonModule() {
     this(create());
@@ -111,11 +132,12 @@ public JacksonModule module(Class<? extends Module> module) {
   }
 
   @Override public void install(@Nonnull Jooby application) {
-    application.decoder(MediaType.json, this);
-    application.encoder(MediaType.json, this);
+    application.decoder(mediaType, this);
+    application.encoder(mediaType, this);
 
     ServiceRegistry services = application.getServices();
-    services.put(ObjectMapper.class, mapper);
+    Class mapperType = mapper.getClass();
+    services.put(mapperType, mapper);
 
     // Parsing exception as 400
     application.errorCode(JsonParseException.class, StatusCode.BAD_REQUEST);
@@ -129,7 +151,7 @@ public JacksonModule module(Class<? extends Module> module) {
   }
 
   @Override public byte[] encode(@Nonnull Context ctx, @Nonnull Object value) throws Exception {
-    ctx.setDefaultResponseType(MediaType.json);
+    ctx.setDefaultResponseType(mediaType);
     return mapper.writer().writeValueAsBytes(value);
   }
 
@@ -152,18 +174,19 @@ public JacksonModule module(Class<? extends Module> module) {
 
   /**
    * Default object mapper. Install {@link Jdk8Module}, {@link JavaTimeModule},
-   * {@link ParameterNamesModule} and {@link BlackbirdModule}.
+   * {@link ParameterNamesModule}.
    *
+   * @param modules Extra/additional modules to install.
    * @return Object mapper instance.
    */
-  public static @Nonnull ObjectMapper create() {
-    ObjectMapper mapper = JsonMapper.builder()
+  public static @Nonnull ObjectMapper create(Module... modules) {
+    JsonMapper.Builder builder = JsonMapper.builder()
         .addModule(new ParameterNamesModule())
         .addModule(new Jdk8Module())
-        .addModule(new JavaTimeModule())
-        .addModule(new BlackbirdModule())
-        .build();
+        .addModule(new JavaTimeModule());
+
+    Stream.of(modules).forEach(builder::addModule);
 
-    return mapper;
+    return builder.build();
   }
 }
diff --git a/modules/jooby-jackson/src/test/java/io/jooby/json/JacksonJsonModuleTest.java b/modules/jooby-jackson/src/test/java/io/jooby/json/JacksonJsonModuleTest.java
@@ -1,5 +1,7 @@
 package io.jooby.json;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
 import io.jooby.Body;
 import io.jooby.Context;
 import io.jooby.MediaType;
@@ -14,13 +16,13 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-public class JacksonModuleTest {
+public class JacksonJsonModuleTest {
 
   @Test
-  public void render() throws Exception {
+  public void renderJson() throws Exception {
     Context ctx = mock(Context.class);
 
-    JacksonModule jackson = new JacksonModule();
+    JacksonModule jackson = new JacksonModule(new ObjectMapper());
 
     byte[] bytes = jackson.encode(ctx, mapOf("k", "v"));
     assertEquals("{\"k\":\"v\"}", new String(bytes, StandardCharsets.UTF_8));
@@ -29,7 +31,7 @@ public void render() throws Exception {
   }
 
   @Test
-  public void parse() throws Exception {
+  public void parseJson() throws Exception {
     byte[] bytes = "{\"k\":\"v\"}".getBytes(StandardCharsets.UTF_8);
     Body body = mock(Body.class);
     when(body.isInMemory()).thenReturn(true);
@@ -38,7 +40,35 @@ public void parse() throws Exception {
     Context ctx = mock(Context.class);
     when(ctx.body()).thenReturn(body);
 
-    JacksonModule jackson = new JacksonModule();
+    JacksonModule jackson = new JacksonModule(new ObjectMapper());
+
+    Map<String, String> result = (Map<String, String>) jackson.decode(ctx, Map.class);
+    assertEquals(mapOf("k", "v"), result);
+  }
+
+  @Test
+  public void renderXml() throws Exception {
+    Context ctx = mock(Context.class);
+
+    JacksonModule jackson = new JacksonModule(new XmlMapper());
+
+    byte[] bytes = jackson.encode(ctx, mapOf("k", "v"));
+    assertEquals("<HashMap><k>v</k></HashMap>", new String(bytes, StandardCharsets.UTF_8));
+
+    verify(ctx).setDefaultResponseType(MediaType.xml);
+  }
+
+  @Test
+  public void parseXml() throws Exception {
+    byte[] bytes = "<HashMap><k>v</k></HashMap>".getBytes(StandardCharsets.UTF_8);
+    Body body = mock(Body.class);
+    when(body.isInMemory()).thenReturn(true);
+    when(body.bytes()).thenReturn(bytes);
+
+    Context ctx = mock(Context.class);
+    when(ctx.body()).thenReturn(body);
+
+    JacksonModule jackson = new JacksonModule(new XmlMapper());
 
     Map<String, String> result = (Map<String, String>) jackson.decode(ctx, Map.class);
     assertEquals(mapOf("k", "v"), result);
diff --git a/pom.xml b/pom.xml
@@ -600,6 +600,12 @@
         <version>${jackson.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>com.fasterxml.jackson.dataformat</groupId>
+        <artifactId>jackson-dataformat-xml</artifactId>
+        <version>${jackson.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>com.fasterxml.jackson.datatype</groupId>
         <artifactId>jackson-datatype-jdk8</artifactId>
diff --git a/tests/pom.xml b/tests/pom.xml
@@ -172,6 +172,12 @@
       <version>${jetty.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.fasterxml.jackson.dataformat</groupId>
+      <artifactId>jackson-dataformat-xml</artifactId>
+      <scope>test</scope>
+    </dependency>
+
   </dependencies>
 
   <build>
diff --git a/tests/src/test/java/io/jooby/i2413/B2413.java b/tests/src/test/java/io/jooby/i2413/B2413.java
@@ -0,0 +1,28 @@
+package io.jooby.i2413;
+
+public class B2413 {
+  private String id;
+
+  private String name;
+
+  public B2413(String id, String name) {
+    this.id = id;
+    this.name = name;
+  }
+
+  public String getId() {
+    return id;
+  }
+
+  public void setId(String id) {
+    this.id = id;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+}
diff --git a/tests/src/test/java/io/jooby/i2413/Issue2413.java b/tests/src/test/java/io/jooby/i2413/Issue2413.java
