Merge pull request #1205 from rainboyan

* pr/1205: Refactor GrailsApplicationLifeCycle

Closes gh-1205

Author: rainboyan

grace-api/src/main/groovy/grails/core/GrailsApplicationClass.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2022 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,40 +15,16 @@
  */
 package grails.core
 
+import groovy.transform.CompileStatic
+
 /**
  * Marker interface for the GrailsApplicationClass
  *
  * @author Graeme Rocher
+ * @author Michael Yan
  * @since 3.0.10
  */
-trait GrailsApplicationClass implements GrailsApplicationLifeCycle {
-
-    @Override
-    Closure doWithSpring() { null }
-
-    @Override
-    void doWithDynamicMethods() {
-        // no-op
-    }
-
-    @Override
-    void doWithApplicationContext() {
-        // no-op
-    }
-
-    @Override
-    void onConfigChange(Map<String, Object> event) {
-        // no-op
-    }
-
-    @Override
-    void onStartup(Map<String, Object> event) {
-        // no-op
-    }
-
-    @Override
-    void onShutdown(Map<String, Object> event) {
-        // no-op
-    }
+@CompileStatic
+trait GrailsApplicationClass implements GrailsApplicationLifecycle {
 
 }

grace-api/src/main/groovy/grails/core/GrailsApplicationLifeCycleAdapter.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,57 +13,69 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package grails.core
+package grails.core;
+
+import java.util.Map;
+
+import groovy.lang.Closure;
 
 /**
  * API which plugins implement to provide behavior in defined application lifecycle hooks.
  *
- * The {@link GrailsApplicationLifeCycle#doWithSpring()} method can be used register Spring beans.
+ * The {@link GrailsApplicationLifecycle#doWithSpring()} method can be used register Spring beans.
  *
+ * @author Graeme Rocher
+ * @author Michael Yan
  * @since 3.0
- * @see {@link grails.plugins.Plugin}
  */
-interface GrailsApplicationLifeCycle {
+public interface GrailsApplicationLifecycle {
 
     /**
-     * Sub classes should override to provide implementations
+     * Subclasses should override to provide implementations
      *
      * @return A closure that defines beans to be registered by Spring
      */
-    Closure doWithSpring()
+    default Closure<?> doWithSpring() {
+        return null;
+    }
 
     /**
      * Invoked once the {@link org.springframework.context.ApplicationContext} has been refreshed in a phase
      * where plugins can add dynamic methods. Subclasses should override
      */
-    void doWithDynamicMethods()
+    default void doWithDynamicMethods() {
+    }
 
     /**
      * Invoked once the {@link org.springframework.context.ApplicationContext} has been refreshed
      * and after {#doWithDynamicMethods()} is invoked. Subclasses should override
      */
-    void doWithApplicationContext()
+    default void doWithApplicationContext() {
+    }
 
     /**
      * Invoked when the application configuration changes
      *
      * @param event The event
      */
-    void onConfigChange(Map<String, Object> event)
+    default void onConfigChange(Map<String, Object> event) {
+    }
 
     /**
-     * Invoked once all prior initialization hooks: {@link GrailsApplicationLifeCycle#doWithSpring()},
-     * {@link GrailsApplicationLifeCycle#doWithDynamicMethods()} and {@link GrailsApplicationLifeCycle#doWithApplicationContext()}
+     * Invoked once all prior initialization hooks: {@link GrailsApplicationLifecycle#doWithSpring()},
+     * {@link GrailsApplicationLifecycle#doWithDynamicMethods()} and {@link GrailsApplicationLifecycle#doWithApplicationContext()}
      *
      * @param event The event
      */
-    void onStartup(Map<String, Object> event)
+    default void onStartup(Map<String, Object> event) {
+    }
 
     /**
      * Invoked when the {@link org.springframework.context.ApplicationContext} is closed
      *
      * @param event The event
      */
-    void onShutdown(Map<String, Object> event)
+    default void onShutdown(Map<String, Object> event) {
+    }
 
 }

…s/core/GrailsApplicationLifeCycle.groovy …ils/core/GrailsApplicationLifecycle.javagrace-api/src/main/groovy/grails/core/GrailsApplicationLifeCycle.groovy renamed to grace-api/src/main/groovy/grails/core/GrailsApplicationLifecycle.java grace-api/src/main/groovy/grails/core/GrailsApplicationLifeCycle.groovy renamed to grace-api/src/main/groovy/grails/core/GrailsApplicationLifecycle.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2023 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@
 import org.springframework.util.Assert;
 
 import grails.core.GrailsApplication;
-import grails.core.GrailsApplicationLifeCycle;
+import grails.core.GrailsApplicationLifecycle;
 import grails.plugins.GrailsPluginManager;
 import grails.util.Environment;
 import grails.util.Holders;
@@ -42,7 +42,7 @@
 import org.grails.datastore.mapping.model.MappingContext;
 
 /**
- * A {@link ApplicationListener} to initialize Grails with Plugins and GrailsApplicationLifeCycles
+ * A {@link ApplicationListener} to initialize Grails with Plugins and GrailsApplicationLifecycles
  * when an {@link ApplicationContext} gets refreshed or closed.
  *
  * @author Graeme Rocher
@@ -67,8 +67,8 @@ public void onApplicationEvent(ApplicationContextEvent event) {
         GrailsApplication grailsApplication = applicationContext.getBean(GrailsApplication.APPLICATION_ID, GrailsApplication.class);
         GrailsPluginManager pluginManager = applicationContext.getBean(GrailsPluginManager.BEAN_NAME, GrailsPluginManager.class);
 
-        List<GrailsApplicationLifeCycle> lifeCycleBeans =
-                applicationContext.getBeansOfType(GrailsApplicationLifeCycle.class)
+        List<GrailsApplicationLifecycle> lifecycleBeans =
+                applicationContext.getBeansOfType(GrailsApplicationLifecycle.class)
                         .values()
                         .stream().sorted(OrderComparator.INSTANCE)
                         .collect(Collectors.toList());
@@ -84,15 +84,15 @@ public void onApplicationEvent(ApplicationContextEvent event) {
             StartupStep dynamicMethods = this.applicationStartup.start("grails.application.context.dynamic-methods");
             pluginManager.setApplicationContext(applicationContext);
             pluginManager.doDynamicMethods();
-            for (GrailsApplicationLifeCycle lifeCycle : lifeCycleBeans) {
-                lifeCycle.doWithDynamicMethods();
+            for (GrailsApplicationLifecycle lifecycle : lifecycleBeans) {
+                lifecycle.doWithDynamicMethods();
             }
             dynamicMethods.end();
 
             StartupStep postProcessing = this.applicationStartup.start("grails.application.context.post-processing");
             pluginManager.doPostProcessing(applicationContext);
-            for (GrailsApplicationLifeCycle lifeCycle : lifeCycleBeans) {
-                lifeCycle.doWithApplicationContext();
+            for (GrailsApplicationLifecycle lifecycle : lifecycleBeans) {
+                lifecycle.doWithApplicationContext();
             }
             postProcessing.end();
 
@@ -102,8 +102,8 @@ public void onApplicationEvent(ApplicationContextEvent event) {
             Map<String, Object> eventMap = new HashMap<>();
             eventMap.put("source", pluginManager);
             pluginManager.onStartup(eventMap);
-            for (GrailsApplicationLifeCycle lifeCycle : lifeCycleBeans) {
-                lifeCycle.onStartup(eventMap);
+            for (GrailsApplicationLifecycle lifecycle : lifecycleBeans) {
+                lifecycle.onStartup(eventMap);
             }
             startupStep.end();
         }
@@ -112,10 +112,10 @@ else if (event instanceof ContextClosedEvent) {
             Map<String, Object> eventMap = new HashMap<>();
             eventMap.put("source", pluginManager);
 
-            List<GrailsApplicationLifeCycle> reversedLifeCycleBeans = new ArrayList<>(lifeCycleBeans);
-            Collections.reverse(reversedLifeCycleBeans);
-            for (GrailsApplicationLifeCycle lifeCycle : reversedLifeCycleBeans) {
-                lifeCycle.onShutdown(eventMap);
+            List<GrailsApplicationLifecycle> reversedLifecycleBeans = new ArrayList<>(lifecycleBeans);
+            Collections.reverse(reversedLifecycleBeans);
+            for (GrailsApplicationLifecycle lifecycle : reversedLifecycleBeans) {
+                lifecycle.onShutdown(eventMap);
             }
 
             pluginManager.shutdown();

grace-boot/src/main/groovy/grails/boot/config/GrailsApplicationEventListener.java

@@ -55,7 +55,7 @@
 import grails.config.Settings;
 import grails.core.DefaultGrailsApplication;
 import grails.core.GrailsApplication;
-import grails.core.GrailsApplicationLifeCycle;
+import grails.core.GrailsApplicationLifecycle;
 import grails.plugins.GrailsPlugin;
 import grails.plugins.GrailsPluginManager;
 import grails.spring.BeanBuilder;
@@ -101,7 +101,7 @@ public class GrailsApplicationPostProcessor
 
     protected ApplicationContext applicationContext;
 
-    protected GrailsApplicationLifeCycle lifeCycle;
+    protected GrailsApplicationLifecycle lifecycle;
 
     protected Set<Class<?>> classes;
 
@@ -116,8 +116,8 @@ public GrailsApplicationPostProcessor() {
         this.grailsApplicationEventListener = new GrailsApplicationEventListener();
     }
 
-    public void setGrailsApplicationLifeCycle(GrailsApplicationLifeCycle lifeCycle) {
-        this.lifeCycle = lifeCycle;
+    public void setGrailsApplicationLifecycle(GrailsApplicationLifecycle lifecycle) {
+        this.lifecycle = lifecycle;
     }
 
     public void setLoadExternalBeans(boolean loadExternalBeans) {
@@ -315,26 +315,26 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) t
         b.setVariable(GrailsApplication.APPLICATION_ID, this.grailsApplication);
         b.setVariable("application", this.grailsApplication);
         b.setVariable("manager", this.pluginManager);
-        if (this.lifeCycle != null) {
-            Closure<?> withSpring = this.lifeCycle.doWithSpring();
+        if (this.lifecycle != null) {
+            Closure<?> withSpring = this.lifecycle.doWithSpring();
             if (withSpring != null) {
                 BeanBuilder bb = new BeanBuilder(null, springConfig, application.getClassLoader());
-                bb.setBeanBuildResource(new DescriptiveResource(this.lifeCycle.getClass().getName()));
+                bb.setBeanBuildResource(new DescriptiveResource(this.lifecycle.getClass().getName()));
                 bb.setBinding(b);
                 bb.beans(withSpring);
             }
         }
 
-        Collection<GrailsApplicationLifeCycle> lifeCycles = this.applicationContext.getBeansOfType(GrailsApplicationLifeCycle.class)
+        Collection<GrailsApplicationLifecycle> lifecycles = this.applicationContext.getBeansOfType(GrailsApplicationLifecycle.class)
                 .values()
                 .stream()
                 .sorted(OrderComparator.INSTANCE)
                 .collect(Collectors.toList());
-        for (GrailsApplicationLifeCycle lifeCycle : lifeCycles) {
-            Closure<?> withSpring = lifeCycle.doWithSpring();
+        for (GrailsApplicationLifecycle lifecycle : lifecycles) {
+            Closure<?> withSpring = lifecycle.doWithSpring();
             if (withSpring != null) {
                 BeanBuilder bb = new BeanBuilder(null, springConfig, application.getClassLoader());
-                bb.setBeanBuildResource(new DescriptiveResource(lifeCycle.getClass().getName()));
+                bb.setBeanBuildResource(new DescriptiveResource(lifecycle.getClass().getName()));
                 bb.setBinding(b);
                 bb.beans(withSpring);
             }

grace-boot/src/main/groovy/grails/boot/config/GrailsApplicationPostProcessor.java

@@ -29,7 +29,7 @@
 import grails.artefact.ArtefactTypes;
 import grails.boot.web.servlet.GrailsBootstrapClass;
 import grails.core.GrailsApplication;
-import grails.core.GrailsApplicationLifeCycleAdapter;
+import grails.core.GrailsApplicationLifecycle;
 import grails.core.GrailsClass;
 import grails.core.support.GrailsApplicationAware;
 import grails.plugins.GrailsPluginManager;
@@ -41,8 +41,8 @@
  * @author Michael Yan
  * @since 2024.0.0
  */
-public class GrailsBootstrapClassRunner extends GrailsApplicationLifeCycleAdapter
-        implements GrailsApplicationAware, ServletContextAware, ApplicationContextAware, PluginManagerAware {
+public class GrailsBootstrapClassRunner
+        implements GrailsApplicationLifecycle, GrailsApplicationAware, ServletContextAware, ApplicationContextAware, PluginManagerAware {
 
     private static final Logger log = LoggerFactory.getLogger(GrailsBootstrapClassRunner.class);