Merge pull request #368 from SentryMan/post

BeanScope PostContruct

Author: rob-bygrave

blackbox-test-inject/src/main/java/org/example/myapp/HelloService.java

@@ -1,5 +1,6 @@
 package org.example.myapp;
 
+import io.avaje.inject.BeanScope;
 import io.avaje.inject.PostConstruct;
 import io.avaje.inject.PreDestroy;
 import jakarta.inject.Singleton;
@@ -86,7 +87,7 @@ public String justRunResult() {
   }
 
   @PostConstruct
-  void postCon() {
+  void postCon(BeanScope scope) {
 
   }
 

inject/src/main/java/io/avaje/inject/BeanScopeBuilder.java

@@ -220,6 +220,13 @@ default <D> BeanScopeBuilder provideDefault(Type type, Supplier<D> provider) {
    */
   BeanScopeBuilder addPostConstructHooks(Runnable... runnables);
 
+  /**
+   * Adds hook that will execute after this scope is built.
+   *
+   * @param consumer the PostConstruct hook to add to the bean scope
+   */
+  BeanScopeBuilder addPostConstructConsumerHook(Consumer<BeanScope> consumer);
+
   /**
    * Adds hooks that will execute before this scope is destroyed.
    *
@@ -429,5 +436,4 @@ interface ForTesting extends BeanScopeBuilder {
      */
     <D> BeanScopeBuilder.ForTesting spy(Class<D> type, Consumer<D> consumer);
   }
-
 }

inject/src/main/java/io/avaje/inject/DBeanScopeBuilder.java

@@ -27,6 +27,7 @@ final class DBeanScopeBuilder implements BeanScopeBuilder.ForTesting {
   private final List<EnrichBean> enrichBeans = new ArrayList<>();
   private final Set<Module> includeModules = new LinkedHashSet<>();
   private final List<Runnable> postConstructList = new ArrayList<>();
+  private final List<Consumer<BeanScope>> postConstructConsumerList = new ArrayList<>();
   private final List<AutoCloseable> preDestroyList = new ArrayList<>();
   private BeanScope parent;
   private boolean parentOverride = true;
@@ -73,7 +74,7 @@ public PropertyRequiresPlugin propertyPlugin() {
 
   @Override
   public BeanScopeBuilder beans(Object... beans) {
-    for (Object bean : beans) {
+    for (final Object bean : beans) {
       suppliedBeans.add(SuppliedBean.of(superOf(bean.getClass()), bean));
     }
     return this;
@@ -114,6 +115,12 @@ public BeanScopeBuilder addPostConstructHooks(Runnable... postConstructRunnable)
     return this;
   }
 
+  @Override
+  public BeanScopeBuilder addPostConstructConsumerHook(Consumer<BeanScope> postConstructConsumer) {
+    this.postConstructConsumerList.add(postConstructConsumer);
+    return this;
+  }
+
   @Override
   public BeanScopeBuilder addPreDestroyHooks(AutoCloseable... closables) {
     Collections.addAll(this.preDestroyList, closables);
@@ -200,14 +207,14 @@ private boolean detectAvajeConfig() {
     try {
       Class.forName("io.avaje.config.Configuration", false, classLoader);
       return true;
-    } catch (ClassNotFoundException e) {
+    } catch (final ClassNotFoundException e) {
       return false;
     }
   }
 
   @Override
   public BeanScope build() {
-    var start = System.currentTimeMillis();
+    final var start = System.currentTimeMillis();
     // load and apply plugins first
     initClassLoader();
     if (propertyRequiresPlugin == null) {
@@ -216,12 +223,12 @@ public BeanScope build() {
 
     ServiceLoader.load(Plugin.class, classLoader).forEach(plugin -> plugin.apply(this));
     // sort factories by dependsOn
-    FactoryOrder factoryOrder = new FactoryOrder(parent, includeModules, !suppliedBeans.isEmpty());
+    final FactoryOrder factoryOrder = new FactoryOrder(parent, includeModules, !suppliedBeans.isEmpty());
     if (factoryOrder.isEmpty()) {
       ServiceLoader.load(Module.class, classLoader).forEach(factoryOrder::add);
     }
 
-    Set<String> moduleNames = factoryOrder.orderFactories();
+    final Set<String> moduleNames = factoryOrder.orderFactories();
     if (moduleNames.isEmpty()) {
       throw new IllegalStateException("No modules found. When using java module system we need an explicit provides clause in module-info like:\n\n" +
         " provides io.avaje.inject.spi.Module with org.example.ExampleModule;\n\n" +
@@ -231,12 +238,13 @@ public BeanScope build() {
     }
     log.log(DEBUG, "building with modules {0}", moduleNames);
 
-    Builder builder = Builder.newBuilder(propertyRequiresPlugin, suppliedBeans, enrichBeans, parent, parentOverride);
-    for (Module factory : factoryOrder.factories()) {
+    final Builder builder = Builder.newBuilder(propertyRequiresPlugin, suppliedBeans, enrichBeans, parent, parentOverride);
+    for (final Module factory : factoryOrder.factories()) {
       factory.build(builder);
     }
 
     postConstructList.forEach(builder::addPostConstruct);
+    postConstructConsumerList.forEach(builder::addPostConstruct);
     preDestroyList.forEach(builder::addPreDestroy);
     return builder.build(shutdownHook, start);
   }
@@ -245,7 +253,7 @@ public BeanScope build() {
    * Return the type that we map the supplied bean to.
    */
   private static Class<?> superOf(Class<?> suppliedClass) {
-    Class<?> suppliedSuper = suppliedClass.getSuperclass();
+    final Class<?> suppliedSuper = suppliedClass.getSuperclass();
     if (Object.class.equals(suppliedSuper)) {
       return suppliedClass;
     } else {
@@ -272,13 +280,13 @@ static class FactoryOrder {
       this.parent = parent;
       this.factories.addAll(includeModules);
       this.suppliedBeans = suppliedBeans;
-      for (Module includeModule : includeModules) {
+      for (final Module includeModule : includeModules) {
         moduleNames.add(includeModule.getClass().getName());
       }
     }
 
     void add(Module module) {
-      FactoryState factoryState = new FactoryState(module);
+      final FactoryState factoryState = new FactoryState(module);
       providesMap.computeIfAbsent(module.getClass().getTypeName(), s -> new FactoryList()).add(factoryState);
       addFactoryProvides(factoryState, module.provides());
       addFactoryProvides(factoryState, module.autoProvides());
@@ -299,7 +307,7 @@ void add(Module module) {
     }
 
     private void addFactoryProvides(FactoryState factoryState, Class<?>[] provides) {
-      for (Class<?> feature : provides) {
+      for (final Class<?> feature : provides) {
         providesMap.computeIfAbsent(feature.getTypeName(), s -> new FactoryList()).add(factoryState);
       }
     }
@@ -319,7 +327,7 @@ private void push(FactoryState factory) {
     Set<String> orderFactories() {
       // push the 'no dependency' modules after the 'provides only' ones
       // as this is more intuitive for the simple (only provides modules case)
-      for (FactoryState factoryState : queueNoDependencies) {
+      for (final FactoryState factoryState : queueNoDependencies) {
         push(factoryState);
       }
       processQueue();
@@ -345,12 +353,12 @@ private void processQueue() {
       if (suppliedBeans) {
         // just push everything left assuming supplied beans
         // will satisfy the required dependencies
-        for (FactoryState factoryState : queue) {
+        for (final FactoryState factoryState : queue) {
           push(factoryState);
         }
       } else if (!queue.isEmpty()) {
-        StringBuilder sb = new StringBuilder();
-        for (FactoryState factory : queue) {
+        final StringBuilder sb = new StringBuilder();
+        for (final FactoryState factory : queue) {
           sb.append("Module [").append(factory).append("] has unsatisfied");
           unsatisfiedRequires(sb, factory.requires(), "requires");
           unsatisfiedRequires(sb, factory.requiresPackages(), "requiresPackages");
@@ -366,7 +374,7 @@ private void processQueue() {
     }
 
     private void unsatisfiedRequires(StringBuilder sb, Class<?>[] requiredType, String requires) {
-      for (Class<?> depModuleName : requiredType) {
+      for (final Class<?> depModuleName : requiredType) {
         if (notProvided(depModuleName.getTypeName())) {
           sb.append(String.format(" %s [%s]", requires, depModuleName.getTypeName()));
         }
@@ -377,7 +385,7 @@ private boolean notProvided(String dependency) {
       if (parent != null && parent.contains(dependency)) {
         return false;
       }
-      FactoryList factories = providesMap.get(dependency);
+      final FactoryList factories = providesMap.get(dependency);
       return (factories == null || !factories.allPushed());
     }
 
@@ -389,9 +397,9 @@ private boolean notProvided(String dependency) {
      */
     private int processQueuedFactories() {
       int count = 0;
-      Iterator<FactoryState> it = queue.iterator();
+      final Iterator<FactoryState> it = queue.iterator();
       while (it.hasNext()) {
-        FactoryState factory = it.next();
+        final FactoryState factory = it.next();
         if (satisfiedDependencies(factory)) {
           // push the factory onto the build order
           it.remove();
@@ -503,7 +511,7 @@ void add(FactoryState factory) {
      * Return true if all factories here have been pushed onto the build order.
      */
     boolean allPushed() {
-      for (FactoryState factory : factories) {
+      for (final FactoryState factory : factories) {
         if (!factory.isPushed()) {
           return false;
         }

inject/src/main/java/io/avaje/inject/spi/Builder.java

@@ -95,6 +95,11 @@ static Builder newBuilder(PropertyRequiresPlugin plugin, List<SuppliedBean> supp
    */
   void addPostConstruct(Runnable runnable);
 
+  /**
+   * Add lifecycle PostConstruct method.
+   */
+  void addPostConstruct(Consumer<BeanScope> consumer);
+
   /**
    * Add lifecycle PreDestroy method.
    */

inject/src/main/java/io/avaje/inject/spi/DBeanScope.java

@@ -12,6 +12,7 @@
 import java.lang.reflect.Type;
 import java.util.*;
 import java.util.concurrent.locks.ReentrantLock;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
 import static java.lang.System.Logger.Level.INFO;
@@ -24,16 +25,24 @@ final class DBeanScope implements BeanScope {
 
   private final ReentrantLock lock = new ReentrantLock();
   private final List<Runnable> postConstruct;
+  private final List<Consumer<BeanScope>> postConstructConsumers;
   private final List<AutoCloseable> preDestroy;
   private final DBeanMap beans;
   private final ShutdownHook shutdownHook;
   private final BeanScope parent;
   private boolean shutdown;
   private boolean closed;
 
-  DBeanScope(boolean withShutdownHook, List<AutoCloseable> preDestroy, List<Runnable> postConstruct, DBeanMap beans, BeanScope parent) {
+  DBeanScope(
+      boolean withShutdownHook,
+      List<AutoCloseable> preDestroy,
+      List<Runnable> postConstruct,
+      List<Consumer<BeanScope>> postConstructConsumers,
+      DBeanMap beans,
+      BeanScope parent) {
     this.preDestroy = preDestroy;
     this.postConstruct = postConstruct;
+    this.postConstructConsumers = postConstructConsumers;
     this.beans = beans;
     this.parent = parent;
     if (withShutdownHook) {
@@ -51,7 +60,7 @@ public String toString() {
 
   @Override
   public List<BeanEntry> all() {
-    IdentityHashMap<DContextEntryBean, DEntry> map = new IdentityHashMap<>();
+    final IdentityHashMap<DContextEntryBean, DEntry> map = new IdentityHashMap<>();
     if (parent != null) {
       ((DBeanScope) parent).addAll(map);
     }
@@ -224,9 +233,12 @@ DBeanScope start(long start) {
     lock.lock();
     try {
       log.log(TRACE, "firing postConstruct");
-      for (Runnable invoke : postConstruct) {
+      for (final var invoke : postConstruct) {
         invoke.run();
       }
+      for (final var consumer : postConstructConsumers) {
+        consumer.accept(this);
+      }
     } finally {
       lock.unlock();
     }
@@ -245,10 +257,10 @@ public void close() {
         // we only allow one call to preDestroy
         closed = true;
         log.log(TRACE, "firing preDestroy");
-        for (AutoCloseable closeable : preDestroy) {
+        for (final AutoCloseable closeable : preDestroy) {
           try {
             closeable.close();
-          } catch (Exception e) {
+          } catch (final Exception e) {
             log.log(Level.ERROR, "Error during PreDestroy lifecycle method", e);
           }
         }
@@ -297,9 +309,9 @@ private static class SortBean<T> implements Comparable<SortBean<T>> {
     int initPriority(Class<? extends Annotation> priorityAnnotation) {
       // Avoid adding hard dependency on javax.annotation-api by using reflection
       try {
-        Annotation ann = bean.getClass().getDeclaredAnnotation(priorityAnnotation);
+        final Annotation ann = bean.getClass().getDeclaredAnnotation(priorityAnnotation);
         if (ann != null) {
-          int priority = (Integer) priorityAnnotation.getMethod("value").invoke(ann);
+          final int priority = (Integer) priorityAnnotation.getMethod("value").invoke(ann);
           priorityDefined = true;
           return priority;
         }

inject/src/main/java/io/avaje/inject/spi/DBuilder.java

@@ -17,6 +17,7 @@ class DBuilder implements Builder {
    * List of Lifecycle methods.
    */
   private final List<Runnable> postConstruct = new ArrayList<>();
+  private final List<Consumer<BeanScope>> postConstructConsumers = new ArrayList<>();
   private final List<AutoCloseable> preDestroy = new ArrayList<>();
   /**
    * List of field injection closures.
@@ -62,7 +63,7 @@ public boolean isAddBeanFor(String name, Type... types) {
     }
     if (parent instanceof DBeanScope) {
       // effectively looking for a match in the test scope
-      DBeanScope dParent = (DBeanScope) parent;
+      final DBeanScope dParent = (DBeanScope) parent;
       parentMatch = dParent.getStrict(name, removeAnnotations(types));
       return parentMatch == null;
     }
@@ -120,7 +121,7 @@ public final <T> List<T> list(Type type) {
 
   @SuppressWarnings({"unchecked"})
   private <T> List<T> listOf(Type type) {
-    List<T> values = (List<T>) beanMap.all(type);
+    final List<T> values = (List<T>) beanMap.all(type);
     if (parent == null) {
       return values;
     }
@@ -201,6 +202,11 @@ public final void addPostConstruct(Runnable invoke) {
     postConstruct.add(invoke);
   }
 
+  @Override
+  public void addPostConstruct(Consumer<BeanScope> consumer) {
+    postConstructConsumers.add(consumer);
+  }
+
   @Override
   public final void addPreDestroy(AutoCloseable invoke) {
     preDestroy.add(invoke);
@@ -399,7 +405,9 @@ private void runInjectors() {
   @Override
   public final BeanScope build(boolean withShutdownHook, long start) {
     runInjectors();
-    var scope = new DBeanScope(withShutdownHook, preDestroy, postConstruct, beanMap, parent);
+    final var scope =
+        new DBeanScope(
+            withShutdownHook, preDestroy, postConstruct, postConstructConsumers, beanMap, parent);
     if (beanScopeProxy != null) {
       beanScopeProxy.inject(scope);
     }