Support @produces for json() html(), plain text and custom

Author: rbygrave

pom.xml

@@ -20,6 +20,7 @@
 
   <properties>
     <swagger.version>2.0.8</swagger.version>
+    <jackson-databind.version>2.9.8</jackson-databind.version>
   </properties>
 
   <dependencies>
@@ -33,13 +34,13 @@
     <dependency>
       <groupId>io.dinject</groupId>
       <artifactId>dinject-controller</artifactId>
-      <version>1.6</version>
+      <version>1.7-SNAPSHOT</version>
     </dependency>
 
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
-      <version>2.9.8</version>
+      <version>${jackson-databind.version}</version>
     </dependency>
 
     <dependency>

src/main/java/io/dinject/javalin/generator/ControllerReader.java

@@ -1,6 +1,7 @@
 package io.dinject.javalin.generator;
 
 import io.dinject.controller.Path;
+import io.dinject.controller.Produces;
 import io.swagger.v3.oas.annotations.Hidden;
 
 import javax.lang.model.element.Element;
@@ -31,12 +32,18 @@ class ControllerReader {
 
   private final Set<String> importTypes = new TreeSet<>();
 
+  /**
+   * The produces media type for the controller. Null implies JSON.
+   */
+  private final String produces;
+
   private boolean docHidden;
 
   ControllerReader(TypeElement beanType, ProcessingContext ctx) {
     this.beanType = beanType;
     this.ctx = ctx;
     this.roles = Util.findRoles(beanType);
+    this.produces = produces(beanType);
     if (ctx.isGeneratedAvailable()) {
       importTypes.add(Constants.GENERATED);
     }
@@ -49,10 +56,19 @@ class ControllerReader {
     importTypes.add(beanType.getQualifiedName().toString());
   }
 
+  private String produces(TypeElement beanType) {
+    final Produces produces = beanType.getAnnotation(Produces.class);
+    return (produces == null) ? null : produces.value();
+  }
+
   private boolean isDocHidden(TypeElement beanType) {
     return beanType.getAnnotation(Hidden.class) != null;
   }
 
+  String getProduces() {
+    return produces;
+  }
+
   TypeElement getBeanType() {
     return beanType;
   }

src/main/java/io/dinject/javalin/generator/MethodReader.java

@@ -3,8 +3,10 @@
 import io.dinject.controller.Delete;
 import io.dinject.controller.Form;
 import io.dinject.controller.Get;
+import io.dinject.controller.MediaType;
 import io.dinject.controller.Patch;
 import io.dinject.controller.Post;
+import io.dinject.controller.Produces;
 import io.dinject.controller.Put;
 import io.dinject.javalin.generator.javadoc.Javadoc;
 import io.swagger.v3.oas.annotations.Hidden;
@@ -45,6 +47,8 @@ class MethodReader {
    */
   private final List<String> methodRoles;
 
+  private final String produces;
+
   private String fullPath;
 
   private PathSegments segments;
@@ -57,10 +61,16 @@ class MethodReader {
     this.isVoid = element.getReturnType().toString().equals("void");
     this.methodRoles = Util.findRoles(element);
     this.javadoc = Javadoc.parse(ctx.getDocComment(element));
+    this.produces = produces(element, bean);
 
     readMethodAnnotation();
   }
 
+  private String produces(ExecutableElement element, ControllerReader bean) {
+    final Produces produces = element.getAnnotation(Produces.class);
+    return (produces != null) ? produces.value() : bean.getProduces();
+  }
+
   void read() {
     if (!methodRoles.isEmpty()) {
       bean.addStaticImportType(JAVALIN_ROLES);
@@ -129,7 +139,8 @@ void addMeta(ProcessingContext ctx) {
         responses.addApiResponse("204", response);
       } else {
         responses.addApiResponse(ApiResponses.DEFAULT, response);
-        response.setContent(ctx.createContent(returnType, "application/json"));
+        String contentMediaType = (produces == null) ? MediaType.APPLICATION_JSON : produces;
+        response.setContent(ctx.createContent(returnType, contentMediaType));
       }
     }
   }
@@ -169,8 +180,8 @@ void addRoute(Append writer) {
       }
       writer.append("      ");
 
-      if (isReturnJson()) {
-        writer.append("ctx.json(");
+      if (isReturnContent()) {
+        writeContextReturn(writer);
       }
       writer.append("controller.");
       writer.append(element.getSimpleName().toString()).append("(");
@@ -181,7 +192,7 @@ void addRoute(Append writer) {
         params.get(i).buildParamName(writer);
       }
       writer.append(")");
-      if (isReturnJson()) {
+      if (isReturnContent()) {
         writer.append(")");
       }
       writer.append(";").eol();
@@ -203,6 +214,18 @@ void addRoute(Append writer) {
     }
   }
 
+  private void writeContextReturn(Append writer) {
+    if (produces == null || produces.equalsIgnoreCase(MediaType.APPLICATION_JSON)) {
+      writer.append("ctx.json(");
+    } else if (produces.equalsIgnoreCase(MediaType.TEXT_HTML)) {
+      writer.append("ctx.html(");
+    } else if (produces.equalsIgnoreCase(MediaType.TEXT_PLAIN)) {
+      writer.append("ctx.contentType(\"text/plain\").result(");
+    } else {
+      writer.append("ctx.contentType(\"%s\").result(", produces);
+    }
+  }
+
   private List<String> roles() {
     return methodRoles.isEmpty() ? bean.getRoles() : methodRoles;
   }
@@ -211,12 +234,10 @@ private int httpStatusCode() {
     return webMethod.statusCode();
   }
 
-  private boolean isReturnJson() {
-    // TODO: ... returning non-object types?
+  private boolean isReturnContent() {
     return !isVoid;
   }
 
-
   private boolean readMethodAnnotation() {
 
     Form form = element.getAnnotation(Form.class);

src/main/java/io/dinject/javalin/generator/ProcessingContext.java

@@ -12,7 +12,6 @@
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.type.TypeMirror;
 import javax.lang.model.util.Elements;
-import javax.lang.model.util.Types;
 import javax.tools.Diagnostic;
 import javax.tools.FileObject;
 import javax.tools.JavaFileObject;
@@ -22,11 +21,10 @@
 import static io.dinject.javalin.generator.Constants.GENERATED;
 import static io.dinject.javalin.generator.Constants.OPENAPIDEFINITION;
 
-public class ProcessingContext {
+class ProcessingContext {
 
   private final Messager messager;
   private final Filer filer;
-  private final Types types;
   private final Elements elements;
   private final SchemaBuilder schemaBuilder;
   private final boolean generatedAvailable;
@@ -38,8 +36,7 @@ public class ProcessingContext {
     this.messager = env.getMessager();
     this.filer = env.getFiler();
     this.elements = env.getElementUtils();
-    this.types = env.getTypeUtils();
-    this.schemaBuilder = new SchemaBuilder(types, elements);//, this);
+    this.schemaBuilder = new SchemaBuilder(env.getTypeUtils(), elements);
     this.generatedAvailable = isTypeAvailable(GENERATED);
     this.openApiAvailable = isTypeAvailable(OPENAPIDEFINITION);
   }