jackson: support raw string as json response fix #618

Author: jknack

coverage-report/src/test/java/org/jooby/issues/Issue618.java

@@ -0,0 +1,31 @@
+package org.jooby.issues;
+
+import org.jooby.json.Jackson;
+import org.jooby.test.ServerFeature;
+import org.junit.Test;
+
+import com.google.common.collect.ImmutableMap;
+
+public class Issue618 extends ServerFeature {
+
+  {
+    use(new Jackson().raw());
+
+    get("/618", () -> "{\"raw\":\"json\"}");
+
+    get("/618/obj", () -> ImmutableMap.of("raw", "json"));
+  }
+
+  @Test
+  public void rawJsonString() throws Exception {
+    request()
+        .get("/618")
+        .expect("{\"raw\":\"json\"}")
+        .header("content-type", "application/json;charset=utf-8");
+
+    request()
+        .get("/618/obj")
+        .expect("{\"raw\":\"json\"}")
+        .header("content-type", "application/json;charset=utf-8");
+  }
+}

jooby-jackson/src/main/java/org/jooby/json/Jackson.java

@@ -137,6 +137,8 @@ public PostConfigurer(final ObjectMapper mapper, final Set<Module> jacksonModule
 
   private List<Consumer<Multibinder<Module>>> modules = new ArrayList<>();
 
+  private boolean raw;
+
   /**
    * Creates a new {@link Jackson} module and use the provided {@link ObjectMapper} instance.
    *
@@ -209,6 +211,24 @@ public Jackson module(final Class<? extends Module> module) {
     return this;
   }
 
+  /**
+   * Add support raw string json responses:
+   *
+   * <pre>{@code
+   * {
+   *   get("/raw", () -> {
+   *     return "{\"raw\": \"json\"}";
+   *   });
+   * }
+   * }</pre>
+   *
+   * @return This module.
+   */
+  public Jackson raw() {
+    raw = true;
+    return this;
+  }
+
   @Override
   public void configure(final Env env, final Config config, final Binder binder) {
     // provided or default mapper.
@@ -242,7 +262,9 @@ public void configure(final Env env, final Config config, final Binder binder) {
 
     // json parser & renderer
     JacksonParser parser = new JacksonParser(mapper, type);
-    JacksonRenderer renderer = new JacksonRenderer(mapper, type);
+    JacksonRenderer renderer = raw
+        ? new JacksonRawRenderer(mapper, type)
+        : new JacksonRenderer(mapper, type);
 
     Multibinder.newSetBinder(binder, Renderer.class)
         .addBinding()

jooby-jackson/src/main/java/org/jooby/json/JacksonBaseRenderer.java

@@ -0,0 +1,57 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.jooby.json;
+
+import org.jooby.MediaType;
+import org.jooby.Renderer;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+abstract class JacksonBaseRenderer implements Renderer {
+
+  protected final ObjectMapper mapper;
+
+  protected final MediaType type;
+
+  public JacksonBaseRenderer(final ObjectMapper mapper, final MediaType type) {
+    this.mapper = mapper;
+    this.type = type;
+  }
+
+  @Override
+  public void render(final Object value, final Context ctx) throws Exception {
+    if (ctx.accepts(type) && mapper.canSerialize(value.getClass())) {
+      ctx.type(type);
+      renderValue(value, ctx);
+    }
+  }
+
+  protected abstract void renderValue(Object value, Context ctx) throws Exception;
+
+  @Override
+  public String name() {
+    return "json";
+  }
+
+  @Override
+  public String toString() {
+    return name();
+  }
+
+}

jooby-jackson/src/main/java/org/jooby/json/JacksonRawRenderer.java

@@ -0,0 +1,40 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.jooby.json;
+
+import org.jooby.MediaType;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+class JacksonRawRenderer extends JacksonRenderer {
+
+  public JacksonRawRenderer(final ObjectMapper mapper, final MediaType type) {
+    super(mapper, type);
+  }
+
+  @Override
+  protected void renderValue(final Object value, final Context ctx) throws Exception {
+    if (value instanceof CharSequence) {
+      ctx.send(value.toString());
+    } else {
+      super.renderValue(value, ctx);
+    }
+  }
+
+}

jooby-jackson/src/main/java/org/jooby/json/JacksonRenderer.java

@@ -19,40 +19,21 @@
 package org.jooby.json;
 
 import org.jooby.MediaType;
-import org.jooby.Renderer;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
-class JacksonRenderer implements Renderer {
-
-  private ObjectMapper mapper;
-
-  private MediaType type;
+class JacksonRenderer extends JacksonBaseRenderer {
 
   public JacksonRenderer(final ObjectMapper mapper, final MediaType type) {
-    this.mapper = mapper;
-    this.type = type;
-  }
-
-  @Override
-  public void render(final Object value, final Context ctx) throws Exception {
-    if (ctx.accepts(type) && mapper.canSerialize(value.getClass())) {
-      ctx.type(type);
-      // use UTF-8 and get byte version
-      byte[] bytes = mapper.writeValueAsBytes(value);
-      ctx.length(bytes.length)
-          .send(bytes);
-    }
-  }
-
-  @Override
-  public String name() {
-    return "json";
+    super(mapper, type);
   }
 
   @Override
-  public String toString() {
-    return name();
+  protected void renderValue(final Object value, final Context ctx) throws Exception {
+    // use UTF-8 and get byte version
+    byte[] bytes = mapper.writeValueAsBytes(value);
+    ctx.length(bytes.length)
+        .send(bytes);
   }
 
 }

jooby-spec/src/main/java/org/jooby/internal/spec/TypeFromDoc.java

@@ -1,3 +1,21 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.jooby.internal.spec;
 
 import java.lang.reflect.Type;