#188 - ENH: Add support for prototype scope (add @prototype)

rbygrave · rbygrave · commit bafc16a73bab · 2022-03-15T13:41:40.000+13:00
diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/BeanReader.java b/inject-generator/src/main/java/io/avaje/inject/generator/BeanReader.java
@@ -1,6 +1,7 @@
 package io.avaje.inject.generator;
 
 import io.avaje.inject.Primary;
+import io.avaje.inject.Prototype;
 import io.avaje.inject.Secondary;
 import io.avaje.inject.spi.Proxy;
 
@@ -25,6 +26,7 @@ class BeanReader {
   private final Set<String> importTypes = new TreeSet<>();
   private final BeanRequestParams requestParams;
   private final TypeReader typeReader;
+  private final boolean prototype;
   private final boolean primary;
   private final boolean secondary;
   private final boolean proxy;
@@ -35,6 +37,7 @@ class BeanReader {
     this.beanType = beanType;
     this.type = beanType.getQualifiedName().toString();
     this.shortName = shortName(beanType);
+    this.prototype = (beanType.getAnnotation(Prototype.class) != null);
     this.primary = (beanType.getAnnotation(Primary.class) != null);
     this.secondary = !primary && (beanType.getAnnotation(Secondary.class) != null);
     this.proxy = (beanType.getAnnotation(Proxy.class) != null);
@@ -65,6 +68,10 @@ BeanAspects aspects() {
     return aspects;
   }
 
+  boolean prototype() {
+    return prototype;
+  }
+
   BeanReader read() {
     if (constructor != null) {
       constructor.addImports(importTypes);
@@ -167,6 +174,9 @@ void buildAddFor(Append writer) {
   }
 
   void buildRegister(Append writer) {
+    if (prototype) {
+      return;
+    }
     writer.append("      ");
     if (isExtraInjectionRequired() || hasLifecycleMethods()) {
       writer.append("%s $bean = ", shortName);
@@ -175,14 +185,14 @@ void buildRegister(Append writer) {
     writer.append("builder.register%s(bean);", flags).eol();
   }
 
-  void addLifecycleCallbacks(Append writer) {
+  void addLifecycleCallbacks(Append writer, String indent) {
     if (postConstructMethod != null) {
-      writer.append("      builder.addPostConstruct($bean::%s);", postConstructMethod.getSimpleName()).eol();
+      writer.append("%s builder.addPostConstruct($bean::%s);", indent, postConstructMethod.getSimpleName()).eol();
     }
     if (preDestroyMethod != null) {
-      writer.append("      builder.addPreDestroy($bean::%s);", preDestroyMethod.getSimpleName()).eol();
+      writer.append("%s builder.addPreDestroy($bean::%s);", indent, preDestroyMethod.getSimpleName()).eol();
     } else if (typeReader.isClosable()) {
-      writer.append("      builder.addPreDestroy($bean);").eol();
+      writer.append("%s builder.addPreDestroy($bean);", indent).eol();
     }
   }
 
diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/Processor.java b/inject-generator/src/main/java/io/avaje/inject/generator/Processor.java
@@ -2,6 +2,7 @@
 
 import io.avaje.inject.Factory;
 import io.avaje.inject.InjectModule;
+import io.avaje.inject.Prototype;
 import io.avaje.inject.spi.Proxy;
 import jakarta.inject.Scope;
 import jakarta.inject.Singleton;
@@ -45,6 +46,7 @@ public Set<String> getSupportedAnnotationTypes() {
     annotations.add(InjectModule.class.getCanonicalName());
     annotations.add(Factory.class.getCanonicalName());
     annotations.add(Singleton.class.getCanonicalName());
+    annotations.add(Prototype.class.getCanonicalName());
     annotations.add(Scope.class.getCanonicalName());
     annotations.add(Constants.TESTSCOPE);
     annotations.add(Constants.CONTROLLER);
@@ -61,12 +63,14 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
 
     Set<? extends Element> factoryBeans = roundEnv.getElementsAnnotatedWith(Factory.class);
     Set<? extends Element> beans = roundEnv.getElementsAnnotatedWith(Singleton.class);
+    Set<? extends Element> prototypes = roundEnv.getElementsAnnotatedWith(Prototype.class);
     Set<? extends Element> scopes = roundEnv.getElementsAnnotatedWith(Scope.class);
     Set<? extends Element> proxies = roundEnv.getElementsAnnotatedWith(Proxy.class);
     readScopes(scopes);
     readModule(roundEnv);
     readChangedBeans(factoryBeans, true);
     readChangedBeans(beans, false);
+    readChangedBeans(prototypes, false);
     readChangedBeans(controllers, false);
     readChangedBeans(proxies, false);
     allScopes.readBeans(roundEnv);
diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/SimpleBeanWriter.java b/inject-generator/src/main/java/io/avaje/inject/generator/SimpleBeanWriter.java
@@ -144,12 +144,20 @@ private void writeStaticFactoryMethod() {
 
   private void writeAddFor(MethodReader constructor) {
     beanReader.buildAddFor(writer);
+    if (beanReader.prototype()) {
+      indent += "  ";
+      writer.append("      builder.registerProvider(() -> {", shortName, shortName).eol();
+    }
     writeCreateBean(constructor);
     beanReader.buildRegister(writer);
-    beanReader.addLifecycleCallbacks(writer);
+    beanReader.addLifecycleCallbacks(writer, indent);
     if (beanReader.isExtraInjectionRequired()) {
       writeExtraInjection();
     }
+    if (beanReader.prototype()) {
+      writer.append("        return bean;").eol();
+      writer.append("      });", shortName, shortName).eol();
+    }
     writer.append("    }").eol();
   }
 
@@ -172,8 +180,9 @@ private void writeBuildMethodStart(MethodReader constructor) {
     writer.append(") {").eol();
   }
 
+  String indent = "     ";
   private void writeCreateBean(MethodReader constructor) {
-    writer.append("      %s bean = new %s(", shortName, shortName);
+    writer.append("%s %s bean = new %s(", indent, shortName, shortName);
     // add constructor dependencies
     writeMethodParams("builder", constructor);
   }
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/MyProto.java b/inject-test/src/test/java/org/example/coffee/prototype/MyProto.java
@@ -0,0 +1,18 @@
+package org.example.coffee.prototype;
+
+import io.avaje.inject.Prototype;
+import org.example.coffee.Pump;
+
+@Prototype
+public class MyProto {
+
+  final Pump pump;
+
+  public MyProto(Pump pump) {
+    this.pump = pump;
+  }
+
+  public Pump pump() {
+    return pump;
+  }
+}
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/MyProtoTest.java b/inject-test/src/test/java/org/example/coffee/prototype/MyProtoTest.java
@@ -0,0 +1,29 @@
+package org.example.coffee.prototype;
+
+import io.avaje.inject.BeanScope;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class MyProtoTest {
+
+  @Test
+  void test_prototype_differentInstance() {
+    try (BeanScope scope = BeanScope.newBuilder()
+      .build()) {
+
+      MyProto one = scope.get(MyProto.class);
+      MyProto two = scope.get(MyProto.class);
+      assertThat(one).isNotSameAs(two);
+      // singleton dependency is same instance
+      assertThat(one.pump()).isSameAs(two.pump());
+
+      OtherProto otherOne = scope.get(OtherProto.class);
+      OtherProto otherTwo = scope.get(OtherProto.class);
+
+      assertThat(otherOne).isNotSameAs(otherTwo);
+      assertThat(otherOne.myProto).isNotSameAs(otherTwo.myProto);
+    }
+  }
+
+}
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/OtherProto.java b/inject-test/src/test/java/org/example/coffee/prototype/OtherProto.java
@@ -0,0 +1,13 @@
+package org.example.coffee.prototype;
+
+import io.avaje.inject.Prototype;
+
+@Prototype
+public class OtherProto {
+
+  final MyProto myProto;
+
+  public OtherProto(MyProto myProto) {
+    this.myProto = myProto;
+  }
+}
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/UseProto.java b/inject-test/src/test/java/org/example/coffee/prototype/UseProto.java
@@ -0,0 +1,24 @@
+package org.example.coffee.prototype;
+
+import jakarta.inject.Provider;
+import jakarta.inject.Singleton;
+
+@Singleton
+public class UseProto {
+
+  final Provider<MyProto> myProto;
+  final OtherProto otherProto;
+
+  public UseProto(Provider<MyProto> myProto, OtherProto otherProto) {
+    this.myProto = myProto;
+    this.otherProto = otherProto;
+  }
+
+  MyProto myProto() {
+    return myProto.get();
+  }
+
+  public OtherProto otherProto() {
+    return otherProto;
+  }
+}
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/UseProto2.java b/inject-test/src/test/java/org/example/coffee/prototype/UseProto2.java
@@ -0,0 +1,23 @@
+package org.example.coffee.prototype;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class UseProto2 {
+
+  final MyProto myProto;
+  final OtherProto otherProto;
+
+  public UseProto2(MyProto myProto, OtherProto otherProto) {
+    this.myProto = myProto;
+    this.otherProto = otherProto;
+  }
+
+  MyProto myProto() {
+    return myProto;
+  }
+
+  public OtherProto otherProto() {
+    return otherProto;
+  }
+}
diff --git a/inject-test/src/test/java/org/example/coffee/prototype/UseProtoTest.java b/inject-test/src/test/java/org/example/coffee/prototype/UseProtoTest.java
@@ -0,0 +1,30 @@
+package org.example.coffee.prototype;
+
+import io.avaje.inject.BeanScope;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class UseProtoTest {
+
+  @Test
+  void test_injectProvider() {
+    try (BeanScope scope = BeanScope.newBuilder()
+      .build()) {
+      UseProto useProto = scope.get(UseProto.class);
+
+      MyProto one = useProto.myProto();
+      MyProto two = useProto.myProto();
+      assertThat(one).isNotSameAs(two);
+      // singleton dependency is same instance
+      assertThat(one.pump()).isSameAs(two.pump());
+
+
+      UseProto2 useProto2 = scope.get(UseProto2.class);
+      assertThat(useProto2.myProto()).isNotSameAs(two);
+      assertThat(useProto2.otherProto()).isNotSameAs(useProto.otherProto());
+
+    }
+  }
+
+}
diff --git a/inject/src/main/java/io/avaje/inject/Prototype.java b/inject/src/main/java/io/avaje/inject/Prototype.java
@@ -0,0 +1,28 @@
+package io.avaje.inject;
+
+import jakarta.inject.Scope;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Specify a bean that has prototype scope.
+ * <p>
+ * A new instance of this bean will be created each time it is requested or wired.
+ *
+ * <pre>{@code
+ *
+ * @Prototype
+ * class EmailSendHandler {
+ *
+ *   ...
+ * }
+ * }</pre>
+ */
+@Target({ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Scope
+public @interface Prototype {
+}
diff --git a/inject/src/main/java/io/avaje/inject/spi/Builder.java b/inject/src/main/java/io/avaje/inject/spi/Builder.java
@@ -52,6 +52,11 @@ static Builder newBuilder(List<SuppliedBean> suppliedBeans, List<EnrichBean> enr
    */
   boolean isAddBeanFor(Type... types);
 
+  /**
+   * Register the provider into the context.
+   */
+  <T> void registerProvider(Provider<T> provider);
+
   /**
    * Register the bean instance into the context.
    *
diff --git a/inject/src/main/java/io/avaje/inject/spi/DBeanMap.java b/inject/src/main/java/io/avaje/inject/spi/DBeanMap.java
@@ -1,5 +1,7 @@
 package io.avaje.inject.spi;
 
+import jakarta.inject.Provider;
+
 import java.lang.reflect.Type;
 import java.util.Collections;
 import java.util.LinkedHashMap;
@@ -64,6 +66,13 @@ void register(int flag, Object bean) {
     }
   }
 
+  void register(int flag, Provider<?> provider) {
+    DContextEntryBean entryBean = DContextEntryBean.prototype(provider, nextBean.name, flag);
+    for (Type type : nextBean.types) {
+      beans.computeIfAbsent(type.getTypeName(), s -> new DContextEntry()).add(entryBean);
+    }
+  }
+
   @SuppressWarnings("unchecked")
   <T> T get(Type type, String name) {
     DContextEntry entry = beans.get(type.getTypeName());
@@ -73,6 +82,15 @@ <T> T get(Type type, String name) {
     return (T) entry.get(KeyUtil.lower(name));
   }
 
+  @SuppressWarnings("unchecked")
+  <T> Provider<T> provider(Type type, String name) {
+    DContextEntry entry = beans.get(type.getTypeName());
+    if (entry == null) {
+      return null;
+    }
+    return (Provider<T>) entry.provider(KeyUtil.lower(name));
+  }
+
   /**
    * Return all bean instances matching the given type.
    */
diff --git a/inject/src/main/java/io/avaje/inject/spi/DBuilder.java b/inject/src/main/java/io/avaje/inject/spi/DBuilder.java
@@ -129,6 +129,12 @@ private <T> T register(int flag, T bean) {
     return bean;
   }
 
+  @Override
+  public <T> void registerProvider(Provider<T> provider) {
+    // no enrichment
+    beanMap.register(BeanEntry.NORMAL, provider);
+  }
+
   @Override
   public <T> void withBean(Class<T> type, T bean) {
     next(null, type);
@@ -179,13 +185,22 @@ public <T> Provider<T> getProvider(Class<T> cls) {
   @Override
   public <T> Provider<T> getProvider(Class<T> cls, String name) {
     if (runningPostConstruct) {
-      return new ProviderWrapper<>(get(cls, name));
+      return obtainProvider(cls, name);
     }
-    ProviderPromise<T> promise = new ProviderPromise<>(cls, name);
+    // use injectors to delay obtaining the provider until end of build
+    ProviderPromise<T> promise = new ProviderPromise<>(cls, name, this);
     injectors.add(promise);
     return promise;
   }
 
+  <T> Provider<T> obtainProvider(Class<T> type, String name) {
+    Provider<T> provider = beanMap.provider(type, name);
+    if (provider != null) {
+      return provider;
+    }
+    return ()-> this.get(type, name);
+  }
+
   @Override
   public <T> Provider<T> getProviderFor(Class<?> cls, Type type) {
     return () -> {
diff --git a/inject/src/main/java/io/avaje/inject/spi/DContextEntry.java b/inject/src/main/java/io/avaje/inject/spi/DContextEntry.java
diff --git a/inject/src/main/java/io/avaje/inject/spi/DContextEntryBean.java b/inject/src/main/java/io/avaje/inject/spi/DContextEntryBean.java
diff --git a/inject/src/main/java/io/avaje/inject/spi/ProviderPromise.java b/inject/src/main/java/io/avaje/inject/spi/ProviderPromise.java
diff --git a/inject/src/main/java/io/avaje/inject/spi/ProviderWrapper.java b/inject/src/main/java/io/avaje/inject/spi/ProviderWrapper.java
