Merge pull request #262 from mercyblitz/dev-1.x

Enhance auto-registration and bean management in Spring context

Author: mercyblitz

README.md

@@ -91,8 +91,8 @@ Choose the version that matches your Spring Framework line:
 
 | Branch | Spring Framework compatibility | Latest version |
 |--------|--------------------------------|----------------|
-| `main` | 6.0.x – 7.0.x                  | `0.2.30`       |
-| `1.x`  | 4.3.x – 5.3.x                  | `0.1.30`       |
+| `main` | 6.0.x – 7.0.x                  | `0.2.31`       |
+| `1.x`  | 4.3.x – 5.3.x                  | `0.1.31`       |
 
 ### 2. Add individual modules
 

microsphere-spring-context/src/main/java/io/microsphere/spring/beans/factory/support/BeanRegistrar.java

@@ -19,14 +19,11 @@
 import io.microsphere.annotation.ConfigurationProperty;
 import io.microsphere.constants.PropertyConstants;
 import io.microsphere.spring.context.ConfigurableApplicationContextInitializer;
-import io.microsphere.spring.core.env.ListenableConfigurableEnvironment;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.context.ApplicationContextInitializer;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.core.env.ConfigurableEnvironment;
 
-import static io.microsphere.spring.beans.factory.BeanFactoryUtils.asBeanDefinitionRegistry;
 import static io.microsphere.spring.beans.factory.support.BeanRegistrar.registerBeanDefinition;
 import static io.microsphere.spring.constants.PropertyConstants.MICROSPHERE_SPRING_PROPERTY_NAME_PREFIX;
 import static java.lang.Boolean.parseBoolean;
@@ -75,7 +72,7 @@
 public class ListenableAutowireCandidateResolverInitializer extends ConfigurableApplicationContextInitializer {
 
     /**
-     * The prefix of the property name of {@link ListenableConfigurableEnvironment} : "microsphere.spring.listenable-autowire-candidate-resolver."
+     * The prefix of the property name of {@link ListenableAutowireCandidateResolver} : "microsphere.spring.listenable-autowire-candidate-resolver."
      */
     public static final String PROPERTY_NAME_PREFIX = MICROSPHERE_SPRING_PROPERTY_NAME_PREFIX + "listenable-autowire-candidate-resolver.";
 
@@ -99,8 +96,7 @@ public class ListenableAutowireCandidateResolverInitializer extends Configurable
     @Override
     protected void initialize(ConfigurableApplicationContext context, ConfigurableEnvironment environment) {
         ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
-        BeanDefinitionRegistry beanDefinitionRegistry = asBeanDefinitionRegistry(beanFactory);
-        registerBeanDefinition(beanDefinitionRegistry, ListenableAutowireCandidateResolver.class);
+        registerBeanDefinition(beanFactory, ListenableAutowireCandidateResolver.class);
     }
 
     @Override

microsphere-spring-context/src/main/java/io/microsphere/spring/beans/factory/support/ListenableAutowireCandidateResolverInitializer.java

@@ -25,7 +25,6 @@
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.core.env.ConfigurablePropertyResolver;
 
-import static io.microsphere.spring.beans.factory.BeanFactoryUtils.asBeanDefinitionRegistry;
 import static io.microsphere.spring.beans.factory.support.BeanRegistrar.registerBean;
 import static io.microsphere.spring.beans.factory.support.BeanRegistrar.registerBeanDefinition;
 import static org.springframework.util.SystemPropertyUtils.PLACEHOLDER_PREFIX;
@@ -221,9 +220,8 @@ public void afterSetPlaceholderSuffix(ConfigurablePropertyResolver propertyResol
     @Override
     public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
         this.beanFactory = beanFactory;
-        BeanDefinitionRegistry registry = asBeanDefinitionRegistry(beanFactory);
-        registerBeanDefinition(registry, ConfigurationPropertyRepository.BEAN_NAME, ConfigurationPropertyRepository.class);
-        registerBean(registry, BEAN_NAME, this);
+        registerBeanDefinition(beanFactory, ConfigurationPropertyRepository.BEAN_NAME, ConfigurationPropertyRepository.class);
+        registerBean(beanFactory, BEAN_NAME, this);
     }
 
     /**

microsphere-spring-context/src/main/java/io/microsphere/spring/config/CollectingConfigurationPropertyListener.java

@@ -18,18 +18,39 @@
 package io.microsphere.spring.context;
 
 import io.microsphere.logging.Logger;
+import io.microsphere.spring.beans.BeanUtils;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.context.ApplicationContextInitializer;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.core.env.ConfigurableEnvironment;
 
 import static io.microsphere.constants.PropertyConstants.ENABLED_PROPERTY_NAME;
 import static io.microsphere.constants.SymbolConstants.DOT;
 import static io.microsphere.logging.LoggerFactory.getLogger;
+import static io.microsphere.spring.beans.BeanUtils.generateBeanName;
+import static io.microsphere.spring.beans.factory.support.BeanRegistrar.registerBean;
 import static io.microsphere.spring.constants.PropertyConstants.APPLICATION_CONTEXT_INITIALIZER_PROPERTY_NAME_PREFIX;
 
 /**
- * Abstract class of {@link ApplicationContextInitializer}  for {@link ConfigurableApplicationContext}, which can be
- * enabled or disabled by configuration properties.
+ * An abstract base class for {@link ApplicationContextInitializer} implementations targeting {@link ConfigurableApplicationContext}.
+ * It provides built-in support for enabling or disabling the initializer via configuration properties,
+ * as well as automatic self-registration into the Spring context.
+ *
+ * <h3>Example Usage</h3>
+ * <pre>{@code
+ * public class MyCustomInitializer extends ConfigurableApplicationContextInitializer {
+ *
+ *     @Override
+ *     protected void initialize(ConfigurableApplicationContext context, ConfigurableEnvironment environment) {
+ *         // Perform custom initialization logic here
+ *     }
+ * }
+ * }</pre>
+ *
+ * <p>By default, this initializer is enabled. To disable it, set the corresponding property to {@code false}:
+ * <pre>
+ * microsphere.spring.context-initializer.myCustomInitializer.enabled=false
+ * </pre>
  *
  * @author <a href="mailto:mercyblitz@gmail.com">Mercy</a>
  * @see ApplicationContextInitializer
@@ -41,15 +62,23 @@ public abstract class ConfigurableApplicationContextInitializer implements Appli
 
     protected final Logger logger = getLogger(getClass());
 
+    private String beanName;
+
     @Override
     public final void initialize(ConfigurableApplicationContext context) {
         ConfigurableEnvironment environment = context.getEnvironment();
-        if (isEnabled(context, environment)) {
-            initialize(context, environment);
+        if (!isEnabled(context, environment)) {
+            logger.info("The {} was disabled, if it needs to be enabled, please set the property '{}' to 'true' .",
+                    getClass(), getEnabledPropertyName());
+            return;
+        }
+        if (isRegistered(context)) {
+            logger.info("Current {} Bean[name : '{}'] is already registered to the Spring Context[id : '{}'] , so it will not be initialized.",
+                    getClass(), getBeanName(), context.getId());
             return;
         }
-        logger.info("The {} was disabled, if it needs to be enabled, please set the property '{}' to 'true' .",
-                getClass(), getEnabledPropertyName());
+        initialize(context, environment);
+        registerSelf(context);
     }
 
     /**
@@ -66,6 +95,8 @@ public final void initialize(ConfigurableApplicationContext context) {
      * @param context     the {@link ConfigurableApplicationContext}
      * @param environment the {@link ConfigurableEnvironment}
      * @return if enabled, return <code>true</code>, or <code>false</code>
+     * @see #getEnabledPropertyName()
+     * @see #getDefaultEnabled()
      */
     protected boolean isEnabled(ConfigurableApplicationContext context, ConfigurableEnvironment environment) {
         String propertyName = getEnabledPropertyName();
@@ -76,10 +107,10 @@ protected boolean isEnabled(ConfigurableApplicationContext context, Configurable
      * Get the property name of the enabled
      *
      * @return the property name of the enabled
+     * @see #getBeanName()
      */
     protected String getEnabledPropertyName() {
-        String simpleClassName = getClass().getSimpleName();
-        return APPLICATION_CONTEXT_INITIALIZER_PROPERTY_NAME_PREFIX + simpleClassName + DOT + ENABLED_PROPERTY_NAME;
+        return APPLICATION_CONTEXT_INITIALIZER_PROPERTY_NAME_PREFIX + getBeanName() + DOT + ENABLED_PROPERTY_NAME;
     }
 
     /**
@@ -91,4 +122,39 @@ protected String getEnabledPropertyName() {
     protected boolean getDefaultEnabled() {
         return true;
     }
+
+    /**
+     * Get the bean name of this {@link ConfigurableApplicationContextInitializer}
+     *
+     * @return the bean name of this {@link ConfigurableApplicationContextInitializer}
+     * @see BeanUtils#generateBeanName(Class)
+     */
+    protected String getBeanName() {
+        String beanName = this.beanName;
+        if (beanName == null) {
+            beanName = generateBeanName(getClass());
+            this.beanName = beanName;
+        }
+        return beanName;
+    }
+
+    /**
+     * Is registered or not
+     *
+     * @param context the {@link ConfigurableApplicationContext}
+     * @return if registered, return <code>true</code>, or <code>false</code>
+     */
+    protected boolean isRegistered(ConfigurableApplicationContext context) {
+        return context.containsBean(getBeanName());
+    }
+
+    /**
+     * Register self to the {@link ConfigurableApplicationContext}
+     *
+     * @param context the {@link ConfigurableApplicationContext}
+     */
+    protected void registerSelf(ConfigurableApplicationContext context) {
+        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+        registerBean(beanFactory, getBeanName(), this);
+    }
 }

microsphere-spring-context/src/main/java/io/microsphere/spring/context/ConfigurableApplicationContextInitializer.java

@@ -0,0 +1,58 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.microsphere.spring.context.annotation;
+
+import io.microsphere.spring.context.ConfigurableApplicationContextInitializer;
+import io.microsphere.spring.context.config.AutoRegistrationBean;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.core.env.ConfigurableEnvironment;
+
+import static io.microsphere.spring.beans.factory.support.BeanRegistrar.registerBeanDefinition;
+import static io.microsphere.spring.constants.PropertyConstants.DEFAULT_AUTO_REGISTERED_VALUE;
+import static io.microsphere.spring.context.annotation.EnableAutoRegistrationBean.BEANS_AUTO_REGISTERED_PROEPRTY_NAME;
+
+/**
+ * {@link ApplicationContextInitializer} class for {@link AutoRegistrationBean}
+ *
+ * @author <a href="mailto:mercyblitz@gmail.com">Mercy</a>
+ * @see EnableAutoRegistrationBean
+ * @see AutoRegistrationBean
+ * @since 1.0.0
+ */
+public class AutoRegistrationBeanInitializer extends ConfigurableApplicationContextInitializer {
+
+    @Override
+    protected void initialize(ConfigurableApplicationContext context, ConfigurableEnvironment environment) {
+        registerBeanDefinition(context.getBeanFactory(), Config.class);
+    }
+
+    @EnableAutoRegistrationBean
+    static class Config {
+    }
+
+    @Override
+    protected String getEnabledPropertyName() {
+        return BEANS_AUTO_REGISTERED_PROEPRTY_NAME;
+    }
+
+    @Override
+    protected boolean getDefaultEnabled() {
+        return DEFAULT_AUTO_REGISTERED_VALUE;
+    }
+}

microsphere-spring-context/src/main/java/io/microsphere/spring/context/annotation/AutoRegistrationBeanInitializer.java

@@ -6,6 +6,7 @@ io.microsphere.spring.beans.factory.annotation.ResourceInjectionPointDependencyR
 
 # ApplicationContextInitializer
 org.springframework.context.ApplicationContextInitializer=\
+io.microsphere.spring.context.annotation.AutoRegistrationBeanInitializer,\
 io.microsphere.spring.context.event.EventPublishingBeanInitializer,\
 io.microsphere.spring.beans.factory.support.ListenableAutowireCandidateResolverInitializer,\
 io.microsphere.spring.core.env.ListenableConfigurableEnvironmentInitializer

microsphere-spring-context/src/main/resources/META-INF/spring.factories

@@ -92,17 +92,16 @@ public void testRegisterBeansOnStatic() {
 
         testInSpringContainer(context -> {
             ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
-            BeanDefinitionRegistry registry = asBeanDefinitionRegistry(beanFactory);
-            Map<Class<?>, String> beanTypesAndNames = registerBeans(registry, ofArray(BEAN_FACTORY), User.class);
+            Map<Class<?>, String> beanTypesAndNames = registerBeans(beanFactory, ofArray(BEAN_FACTORY), User.class);
             assertBeans(beanTypesAndNames);
 
-            beanTypesAndNames = registerBeans(registry, ofArray(BEAN_FACTORY, SPRING_FACTORIES), User.class);
+            beanTypesAndNames = registerBeans(beanFactory, ofArray(BEAN_FACTORY, SPRING_FACTORIES), User.class);
             assertBeans(beanTypesAndNames);
 
-            beanTypesAndNames = registerBeans(registry, ofArray(BEAN_FACTORY, SPRING_FACTORIES, JAVA_SERVICE_PROVIDER), User.class);
+            beanTypesAndNames = registerBeans(beanFactory, ofArray(BEAN_FACTORY, SPRING_FACTORIES, JAVA_SERVICE_PROVIDER), User.class);
             assertBeans(beanTypesAndNames);
 
-            beanTypesAndNames = registerBeans(registry, values());
+            beanTypesAndNames = registerBeans(beanFactory, values());
             assertSame(emptyMap(), beanTypesAndNames);
         }, User.class);
     }