sofastack · HzjNeverStop · Feb 17, 2023 · Feb 17, 2023
diff --git a/...re/src/main/java/com/alipay/sofa/boot/autoconfigure/condition/ConditionalOnMasterBiz.java b/...re/src/main/java/com/alipay/sofa/boot/autoconfigure/condition/ConditionalOnMasterBiz.java
@@ -25,20 +25,20 @@
 import java.lang.annotation.Target;
 
 /**
- * 只在非 ark 环境或者 ark 环境的 master biz 生效，非 master biz 不生效
+ * {@link Conditional @Conditional} that checks if the running environment is not ark module biz.
  *
  * @author caojie.cj@antfin.com
  * @since 2019/10/29
  */
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
-@Conditional(OnMasterBiz.class)
+@Conditional(OnMasterBizCondition.class)
 public @interface ConditionalOnMasterBiz {
 
     /**
-     * 额外的条件，用于处理某些配置在基座
-     * @return
+     * Extension condition used in master biz.
+     *
      */
     String extensionCondition() default "";
 }
diff --git a/...gure/src/main/java/com/alipay/sofa/boot/autoconfigure/condition/ConditionalOnNotTest.java b/...gure/src/main/java/com/alipay/sofa/boot/autoconfigure/condition/ConditionalOnNotTest.java
@@ -25,7 +25,8 @@
 import java.lang.annotation.Target;
 
 /**
- * 只能在非测试环境下生效
+ * {@link Conditional @Conditional} that checks if the running environment is not test.
+ *
  * @author huzijie
  * @version ConditionalOnNotTest.java, v 0.1 2022年10月17日 2:54 PM huzijie Exp $
  */

diff --git a/...tation/condition/ConditionalOnSwitch.java → ...figure/condition/ConditionalOnSwitch.java b/...tation/condition/ConditionalOnSwitch.java → ...figure/condition/ConditionalOnSwitch.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.boot.annotation.condition;
+package com.alipay.sofa.boot.autoconfigure.condition;
 
 import org.springframework.context.annotation.Conditional;
 
@@ -25,6 +25,8 @@
 import java.lang.annotation.Target;
 
 /**
+ * {@link Conditional @Conditional} that checks if the switch is enabled in environment.
+ *
  * @author yuanxuan
  * @version : ConditionalOnSwitch.java, v 0.1 2023年02月09日 09:48 yuanxuan Exp $
  */
@@ -35,7 +37,7 @@
 public @interface ConditionalOnSwitch {
 
     /**
-     * switch key
+     * switch key.
      *
      * @return the switch key in config
      */

diff --git a/.../autoconfigure/condition/OnMasterBiz.java → ...igure/condition/OnMasterBizCondition.java b/.../autoconfigure/condition/OnMasterBiz.java → ...igure/condition/OnMasterBizCondition.java
@@ -23,6 +23,7 @@
 import com.alipay.sofa.boot.util.SofaBootEnvUtils;
 import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
 import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.context.annotation.Condition;
 import org.springframework.context.annotation.ConditionContext;
 import org.springframework.core.annotation.AnnotationAttributes;
 import org.springframework.core.type.AnnotatedTypeMetadata;
@@ -35,10 +36,12 @@
 import java.util.Map;
 
 /**
+ * {@link Condition} that checks if running in ark master biz environment.
+ *
  * @author caojie.cj@antfin.com
  * @since 2019/10/29
  */
-public class OnMasterBiz extends SpringBootCondition {
+public class OnMasterBizCondition extends SpringBootCondition {
 
     private static Object masterBiz;
 

@@ -14,11 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.boot.annotation.condition;
+package com.alipay.sofa.boot.autoconfigure.condition;
 
 import org.springframework.boot.autoconfigure.condition.ConditionMessage;
 import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
 import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.context.annotation.Condition;
 import org.springframework.context.annotation.ConditionContext;
 import org.springframework.core.annotation.MergedAnnotation;
 import org.springframework.core.env.Environment;
@@ -28,12 +29,14 @@
 import org.springframework.util.StringUtils;
 
 /**
+ * {@link Condition} that checks if switch properties are defined in environment.
+ *
  * @author yuanxuan
  * @version : OnSwitchCondition.java, v 0.1 2023年02月09日 09:53 yuanxuan Exp $
  */
 public class OnSwitchCondition extends SpringBootCondition {
 
-    private static final String CONFIG_KEY_PREFIX = "sofa.boot.bean.switch";
+    private static final String CONFIG_KEY_PREFIX = "sofa.boot.switch.bean";
 
     @Override
     public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {

@@ -20,10 +20,13 @@
 import org.springframework.boot.autoconfigure.condition.ConditionMessage;
 import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
 import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.context.annotation.Condition;
 import org.springframework.context.annotation.ConditionContext;
 import org.springframework.core.type.AnnotatedTypeMetadata;
 
 /**
+ * {@link Condition} that checks if running in test environment.
+ *
  * @author huzijie
  * @version OnTestCondition.java, v 0.1 2022年10月17日 2:54 PM huzijie Exp $
  */

@@ -16,7 +16,7 @@
  */
 package com.alipay.sofa.boot.autoconfigure.rpc;
 
-import com.alipay.sofa.boot.annotation.condition.ConditionalOnSwitch;
+import com.alipay.sofa.boot.autoconfigure.condition.ConditionalOnSwitch;
 import com.alipay.sofa.rpc.boot.swagger.BoltSwaggerServiceApplicationListener;
 import com.alipay.sofa.rpc.boot.swagger.SwaggerServiceApplicationListener;
 import com.alipay.sofa.runtime.spi.component.SofaRuntimeManager;

@@ -16,7 +16,7 @@
 */
 package com.alipay.sofa.boot.autoconfigure.rpc;
 
-import com.alipay.sofa.boot.annotation.condition.ConditionalOnSwitch;
+import com.alipay.sofa.boot.autoconfigure.condition.ConditionalOnSwitch;
 import com.alipay.sofa.boot.autoconfigure.runtime.SofaRuntimeAutoConfiguration;
 import com.alipay.sofa.rpc.boot.config.RegistryConfigureProcessor;
 import com.alipay.sofa.rpc.boot.container.ProviderConfigContainer;

@@ -17,10 +17,6 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-autoconfigure</artifactId>
-        </dependency>
 
         <dependency>
             <groupId>org.slf4j</groupId>
@@ -43,7 +39,6 @@
             <artifactId>logback-classic</artifactId>
             <scope>test</scope>
         </dependency>
-
     </dependencies>
 
     <build>

@@ -21,13 +21,16 @@
 import org.springframework.util.StringUtils;
 
 /**
+ *  An {@link ApplicationContextInitializer} that could use property to dynamic enable initializer.
+ *
  * @author yuanxuan
  * @version : SwitchableApplicationContextInitializer.java, v 0.1 2023年02月09日 11:57 yuanxuan Exp $
  */
 public abstract class SwitchableApplicationContextInitializer
                                                              implements
                                                              ApplicationContextInitializer<ConfigurableApplicationContext> {
-    protected static final String CONFIG_KEY_PREFIX = "sofa.boot.initializer.switch";
+
+    protected static final String CONFIG_KEY_PREFIX = "sofa.boot.switch.initializer";
 
     @Override
     public void initialize(ConfigurableApplicationContext applicationContext) {

@@ -30,16 +30,19 @@
 import org.springframework.util.StringUtils;
 
 /**
+ * An {@link ApplicationListener} that could use property to dynamic enable listener.
+ *
  * @author yuanxuan
  * @version : SwitchableApplicationListener.java, v 0.1 2023年02月09日 17:40 yuanxuan Exp $
  */
-public abstract class SwitchableApplicationListener<EVENT extends ApplicationEvent>
+public abstract class SwitchableApplicationListener<E extends ApplicationEvent>
                                                                                     implements
-                                                                                    ApplicationListener<EVENT> {
-    protected static final String CONFIG_KEY_PREFIX = "sofa.boot.listener.switch";
+                                                                                    ApplicationListener<E> {
+
+    protected static final String CONFIG_KEY_PREFIX = "sofa.boot.switch.initializer";
 
     @Override
-    public void onApplicationEvent(EVENT event) {
+    public void onApplicationEvent(E event) {
         ApplicationContext applicationContext = null;
         Environment environment = null;
         if (event instanceof ApplicationContextEvent applicationContextEvent) {
@@ -62,14 +65,14 @@ public void onApplicationEvent(EVENT event) {
         }
         if (environment != null) {
             if (isEnable(environment)) {
-                doApplicationEvent(event);
+                doOnApplicationEvent(event);
             }
         } else {
-            doApplicationEvent(event);
+            doOnApplicationEvent(event);
         }
     }
 
-    protected abstract void doApplicationEvent(EVENT event);
+    protected abstract void doOnApplicationEvent(E event);
 
     /**
      * sofa.boot.switch.listener