Merge pull request #118 from SentryMan/master

Use @singleton again

Author: rbygrave

README.md

@@ -68,6 +68,7 @@ If there are other annotation processors and they are specified via <i>maven-com
   </configuration>
 </plugin>
 ```
+
 ## Define a Controller (These APT processors work with both Java and Kotlin.)
 ```java
 package org.example.hello;
@@ -98,11 +99,23 @@ public class WidgetController {
   record Widget(int id, String name){};
 }
 ```
+## DI Usage
+The annotation processor will generate controller adapters that can register routes to Javalin/Helidon. The natural way to use the generated adapters is to get a DI library to find and wire them. This is what the below examples do and they use [Avaje-Inject](https://avaje.io/inject/) to do this. The AP will automatically detect the presence of avaje-inject and generate the class to use avaje-inject's `@Component` as the DI annotation.
 
-## Usage
-The annotation processor will generate controller adapters that can register routes to Javalin/Helidon. The natural way to use the generated adapters is to get a DI library to find and wire them. This is what the below examples do and they use [Avaje-Inject](https://avaje.io/inject/) to do this.
+There isn't a hard requirement to use Avaje for dependency injection. In the absence of avaje-inject the generated class will use `@jakarta.inject.Singleton` or `@javax.inject.Singleton` depending on what's on the classpath. Any DI library that can find and wire the generated @Singleton beans can be used. You can even use Dagger2 or Guice to wire the controllers if you so desire. 
 
-Note that there isn't a requirement to use Avaje for dependency injection. Any DI library that can find and wire the generated @Singleton beans can be used. You can even use Dagger2 or Guice to wire the controllers if you so desire.
+To force the AP to generate with `@javax.inject.Singleton`(in the case where you have both jakarta and javax on the classpath), use the compiler arg `-AuseJavax=true` 
+```
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<configuration>
+					<compilerArgs>
+						<arg>-AuseJavax=true</arg>
+					</compilerArgs>
+				</configuration>
+			</plugin> 
+```
 
 ### Usage with Javalin
 
@@ -156,7 +169,7 @@ WebServer.builder()
 
 ```java
 @Generated("avaje-javalin-generator")
-@Component
+@Singleton
 public class WidgetController$Route implements WebRoutes {
 
   private final WidgetController controller;
@@ -188,7 +201,7 @@ public class WidgetController$Route implements WebRoutes {
 
 ### (Helidon SE) The generated WidgetController$Route.java is:
 ```java
-@Generated("io.dinject.helidon-generator")
+@Generated("avaje-helidon-generator")
 @Singleton
 public class WidgetController$Route implements Service {
 
@@ -221,7 +234,7 @@ public class WidgetController$Route implements Service {
 
 ```java
 @Generated("avaje-helidon-nima-generator")
-@Component
+@Singleton
 public class WidgetController$Route implements HttpService {
 
   private final WidgetController controller;

http-generator-core/src/main/java/io/avaje/http/generator/core/BaseProcessor.java

@@ -1,20 +1,23 @@
 package io.avaje.http.generator.core;
 
-import io.avaje.http.api.Controller;
-import io.swagger.v3.oas.annotations.OpenAPIDefinition;
-import io.swagger.v3.oas.annotations.tags.Tag;
-import io.swagger.v3.oas.annotations.tags.Tags;
+import java.io.IOException;
+import java.util.LinkedHashSet;
+import java.util.Set;
 
 import javax.annotation.processing.AbstractProcessor;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedOptions;
 import javax.lang.model.SourceVersion;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
-import java.io.IOException;
-import java.util.LinkedHashSet;
-import java.util.Set;
 
+import io.avaje.http.api.Controller;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import io.swagger.v3.oas.annotations.tags.Tags;
+
+@SupportedOptions({"useJavax"})
 public abstract class BaseProcessor extends AbstractProcessor {
 
   protected ProcessingContext ctx;

http-generator-core/src/main/java/io/avaje/http/generator/core/Constants.java

@@ -9,9 +9,11 @@ public class Constants {
   public static final String FACTORY_SUFFIX = "$Factory";
 
   static final String OPENAPIDEFINITION = "io.swagger.v3.oas.annotations.OpenAPIDefinition";
-
   static final String COMPONENT = "io.avaje.inject.Component";
 
+  static final String SINGLETON_JAKARTA = "jakarta.inject.Singleton";
+  static final String SINGLETON_JAVAX = "javax.inject.Singleton";
+
   static final String IMPORT_PATH_TYPE_CONVERT = "import static io.avaje.http.api.PathTypeConversion.*;";
 
   static final String IMPORT_HTTP_API = "io.avaje.http.api.*";

http-generator-core/src/main/java/io/avaje/http/generator/core/ControllerReader.java

@@ -67,7 +67,11 @@ protected void addImports(boolean withSingleton) {
       importTypes.add(Constants.VALIDATOR);
     }
     if (withSingleton) {
-      importTypes.add(Constants.COMPONENT);
+      if (ctx.useComponent()) {
+        importTypes.add(Constants.COMPONENT);
+      } else {
+        importTypes.add(ctx.useJavax() ? Constants.SINGLETON_JAVAX : Constants.SINGLETON_JAKARTA);
+      }
     }
   }
 

http-generator-core/src/main/java/io/avaje/http/generator/core/ProcessingContext.java

@@ -1,6 +1,6 @@
 package io.avaje.http.generator.core;
 
-import io.avaje.http.generator.core.openapi.DocContext;
+import java.io.IOException;
 
 import javax.annotation.processing.Filer;
 import javax.annotation.processing.Messager;
@@ -15,7 +15,8 @@
 import javax.tools.FileObject;
 import javax.tools.JavaFileObject;
 import javax.tools.StandardLocation;
-import java.io.IOException;
+
+import io.avaje.http.generator.core.openapi.DocContext;
 
 public class ProcessingContext {
 
@@ -26,6 +27,9 @@ public class ProcessingContext {
   private final Types types;
   private final boolean openApiAvailable;
   private final DocContext docContext;
+  private final boolean useComponent;
+  private final boolean useJavax;
+  private final String diAnnotation;
 
   public ProcessingContext(ProcessingEnvironment env, PlatformAdapter readAdapter) {
     this.readAdapter = readAdapter;
@@ -35,6 +39,20 @@ public ProcessingContext(ProcessingEnvironment env, PlatformAdapter readAdapter)
     this.types = env.getTypeUtils();
     this.openApiAvailable = isTypeAvailable(Constants.OPENAPIDEFINITION);
     this.docContext = new DocContext(env, openApiAvailable);
+    this.useComponent = isTypeAvailable(Constants.COMPONENT);
+    this.diAnnotation = useComponent ? "@Component" : "@Singleton";
+    
+    final var javax = isTypeAvailable(Constants.SINGLETON_JAVAX);
+    final var jakarta = isTypeAvailable(Constants.SINGLETON_JAKARTA);
+    final var override = Boolean.getBoolean(env.getOptions().get("useJavax"));
+
+    if (override || (javax && jakarta)) {
+      this.useJavax = override;
+    } else if (javax) {
+      this.useJavax = true;
+    } else {
+      useJavax = false;
+    }
   }
 
   private boolean isTypeAvailable(String canonicalName) {
@@ -49,6 +67,14 @@ public boolean isOpenApiAvailable() {
     return openApiAvailable;
   }
 
+  public boolean useJavax() {
+    return useJavax;
+  }
+
+  public boolean useComponent() {
+    return useComponent;
+  }
+
   public void logError(Element e, String msg, Object... args) {
     messager.printMessage(Diagnostic.Kind.ERROR, String.format(msg, args), e);
   }
@@ -86,4 +112,8 @@ public TypeMirror asMemberOf(DeclaredType declaredType, Element element) {
   public PlatformAdapter platform() {
     return readAdapter;
   }
+
+  public String getDIAnnotation() {
+    return diAnnotation;
+  }
 }

http-generator-helidon/src/main/java/io/avaje/http/generator/helidon/ControllerWriter.java

@@ -60,7 +60,7 @@ private void writeRoutes(List<ControllerMethodWriter> methods) {
 
   private void writeClassStart() {
     writer.append(AT_GENERATED).eol();
-    writer.append("@Component").eol();
+    writer.append(ctx.getDIAnnotation()).eol();
     writer.append("public class ").append(shortName).append("$Route implements Service {").eol().eol();
 
     String controllerName = "controller";

http-generator-javalin/src/main/java/io/avaje/http/generator/javalin/ControllerWriter.java

@@ -67,7 +67,7 @@ private void writeForMethod(MethodReader method) {
 
   private void writeClassStart() {
     writer.append(AT_GENERATED).eol();
-    writer.append("@Component").eol();
+    writer.append(ctx.getDIAnnotation()).eol();
     writer
       .append("public class ")
       .append(shortName)

http-generator-jex/src/main/java/io/avaje/http/generator/jex/ControllerWriter.java

@@ -47,7 +47,7 @@ private void writeForMethod(MethodReader method) {
 
   private void writeClassStart() {
     writer.append(AT_GENERATED).eol();
-    writer.append("@Component").eol();
+    writer.append(ctx.getDIAnnotation()).eol();
     writer.append("public class ").append(shortName).append("$Route implements Routing.Service {").eol().eol();
 
     String controllerName = "controller";

http-generator-nima/src/main/java/io/avaje/http/generator/helidon/nima/ControllerWriter.java

@@ -77,7 +77,7 @@ private void writeRoutes(List<ControllerMethodWriter> methods) {
 
   private void writeClassStart() {
     writer.append(AT_GENERATED).eol();
-    writer.append("@Component").eol();
+    writer.append(ctx.getDIAnnotation()).eol();
     writer.append("public class %s$Route implements HttpService {", shortName).eol().eol();
 
     var controllerName = "controller";