Refactor dependency organization and naming in Sentinel POMs

microsphere-alibaba-sentinel-commons/pom.xml

@@ -26,6 +26,13 @@
             <artifactId>microsphere-java-core</artifactId>
         </dependency>
 
+        <!-- Microsphere Annotation Processor -->
+        <dependency>
+            <groupId>io.github.microsphere-projects</groupId>
+            <artifactId>microsphere-annotation-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
         <!-- Alibaba Sentinel -->
         <dependency>
             <groupId>com.alibaba.csp</groupId>

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/common/SentinelPlugin.java

@@ -19,9 +19,9 @@
 
 import com.alibaba.csp.sentinel.EntryType;
 import com.alibaba.csp.sentinel.ResourceTypeConstants;
-import io.microsphere.annotation.Nonnull;
 import io.microsphere.alibaba.sentinel.common.constants.SentinelConstants;
 import io.microsphere.alibaba.sentinel.common.util.SentinelUtils;
+import io.microsphere.annotation.Nonnull;
 
 import static io.microsphere.alibaba.sentinel.common.SentinelPluginRepository.INSTANCE;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.getDefaultContextName;

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/common/SentinelTemplate.java

@@ -27,9 +27,9 @@
 import static com.alibaba.csp.sentinel.Tracer.traceEntry;
 import static com.alibaba.csp.sentinel.context.ContextUtil.enter;
 import static com.alibaba.csp.sentinel.context.ContextUtil.exit;
-import static io.microsphere.logging.LoggerFactory.getLogger;
 import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_CONTEXT_NAME;
 import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_ORIGIN;
+import static io.microsphere.logging.LoggerFactory.getLogger;
 import static io.microsphere.util.StringUtils.isBlank;
 
 /**

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/common/SimpleSentinelPlugin.java

@@ -48,7 +48,8 @@ public SimpleSentinelPlugin(String name, String contextName, String origin, int
         super(name, contextName, origin, resourceType, trafficType);
     }
 
-    public SimpleSentinelPlugin(String name, String contextName, String origin, int resourceType, EntryType trafficType, boolean autoRegisterMBean) {
-        super(name, contextName, origin, resourceType, trafficType, autoRegisterMBean);
+    public SimpleSentinelPlugin(String name, String contextName, String origin, int resourceType, EntryType trafficType,
+                                boolean autoInstalled) {
+        super(name, contextName, origin, resourceType, trafficType, autoInstalled);
     }
 }

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/common/constants/SentinelConstants.java

@@ -18,6 +18,11 @@
 package io.microsphere.alibaba.sentinel.common.constants;
 
 import io.microsphere.alibaba.sentinel.common.SentinelContext;
+import io.microsphere.annotation.ConfigurationProperty;
+import io.microsphere.constants.PropertyConstants;
+
+import static io.microsphere.annotation.ConfigurationProperty.APPLICATION_SOURCE;
+import static io.microsphere.annotation.ConfigurationProperty.SYSTEM_PROPERTIES_SOURCE;
 
 /**
  * The constants of Sentinel
@@ -52,6 +57,24 @@ public interface SentinelConstants {
      */
     String PROPERTY_NAME_PREFIX = "microsphere.sentinel.";
 
+    /**
+     * The default value of enabled : "true"
+     */
+    String ENABLED_PROPERTY_VALUE = "true";
+
+    /**
+     * The Property Name of enabled : "microsphere.sentinel.enabled"
+     */
+    @ConfigurationProperty(
+            type = boolean.class,
+            defaultValue = ENABLED_PROPERTY_VALUE,
+            source = {
+                    SYSTEM_PROPERTIES_SOURCE,
+                    APPLICATION_SOURCE
+            }
+    )
+    String ENABLED_PROPERTY_NAME = PROPERTY_NAME_PREFIX + PropertyConstants.ENABLED_PROPERTY_NAME;
+
     /**
      * The attribute name of {@link SentinelContext}
      *

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/common/util/SentinelUtils.java

@@ -2,9 +2,11 @@
 
 import com.alibaba.csp.sentinel.ResourceTypeConstants;
 import com.alibaba.csp.sentinel.concurrent.NamedThreadFactory;
+import com.alibaba.csp.sentinel.context.ContextUtil;
 import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
 import io.microsphere.annotation.Nonnull;
 
+import java.lang.invoke.MethodHandle;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.util.Map;
@@ -13,16 +15,20 @@
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.ThreadFactory;
 
+import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_CONTEXT_NAME_PATTERN;
+import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.FLOW_DATA_ID_PATTERN;
+import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.PROPERTY_NAME_PREFIX;
 import static io.microsphere.collection.MapUtils.newFixedHashMap;
+import static io.microsphere.concurrent.ExecutorUtils.shutdownOnExit;
 import static io.microsphere.constants.PropertyConstants.ENABLED_PROPERTY_NAME;
 import static io.microsphere.constants.SymbolConstants.DOT;
+import static io.microsphere.invoke.MethodHandleUtils.findStatic;
+import static io.microsphere.lang.function.ThrowableAction.execute;
 import static io.microsphere.reflect.FieldUtils.getFieldValue;
 import static io.microsphere.reflect.FieldUtils.getStaticFieldValue;
-import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_CONTEXT_NAME_PATTERN;
-import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.FLOW_DATA_ID_PATTERN;
-import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.PROPERTY_NAME_PREFIX;
 import static io.microsphere.text.FormatUtils.format;
 import static io.microsphere.util.ClassUtils.getSimpleName;
+import static io.microsphere.util.ShutdownHookUtils.addShutdownHookCallback;
 import static io.microsphere.util.SystemUtils.getSystemProperty;
 import static java.lang.reflect.Modifier.isStatic;
 import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor;
@@ -37,8 +43,20 @@ public abstract class SentinelUtils {
 
     private static final Map<Integer, String> resourceTypeToLabelMapping = initResourceTypeToLabelMapping();
 
+    /**
+     * The {@link MethodHandle} of {@link ContextUtil#resetContextMap()}
+     *
+     * @see ContextUtil#resetContextMap()
+     */
+    private static final MethodHandle resetContextMapMethodHandle = findStatic(ContextUtil.class, "resetContextMap");
+
     private static volatile ScheduledExecutorService sentinelMetricsTaskExecutor;
 
+    static {
+        shutdownOnExit(sentinelMetricsTaskExecutor);
+        addShutdownHookCallback(() -> execute(SentinelUtils::resetContextMap));
+    }
+
     private static Map<Integer, String> initResourceTypeToLabelMapping() {
         Field[] fields = ResourceTypeConstants.class.getFields();
         Map<Integer, String> resourceTypeToLabelMapping = newFixedHashMap(fields.length);
@@ -153,6 +171,16 @@ public static ScheduledExecutorService getSentinelMetricsTaskExecutor() {
         return scheduledExecutorService;
     }
 
+    /**
+     * Reset the {@link ContextUtil#resetContextMap() context map} of Sentinel
+     *
+     * @throws Throwable if any exception occurred
+     * @see ContextUtil#resetContextMap()
+     */
+    public static void resetContextMap() throws Throwable {
+        resetContextMapMethodHandle.invokeExact();
+    }
+
     static ScheduledExecutorService getSentinelMetricsTaskExecutor(ScheduledExecutorService defaultScheduledExecutorService) {
         return defaultScheduledExecutorService == null ?
                 newSingleThreadScheduledExecutor(new NamedThreadFactory("sentinel-metrics-task", true)) :

microsphere-alibaba-sentinel-commons/src/main/java/io/microsphere/alibaba/sentinel/jmx/JMXSentinelPluginRepository.java

@@ -17,20 +17,20 @@
 
 package io.microsphere.alibaba.sentinel.jmx;
 
-import io.microsphere.lang.Prioritized;
-import io.microsphere.lang.function.ThrowableBiFunction;
 import io.microsphere.alibaba.sentinel.common.SentinelPlugin;
 import io.microsphere.alibaba.sentinel.common.SentinelPluginRepository;
 import io.microsphere.alibaba.sentinel.common.SimpleSentinelPluginRepository;
+import io.microsphere.lang.Prioritized;
+import io.microsphere.lang.function.ThrowableBiFunction;
 
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 import javax.management.StandardMBean;
 import java.util.Collection;
 import java.util.Set;
 
-import static io.microsphere.lang.function.ThrowableSupplier.execute;
 import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_PRIORITY;
+import static io.microsphere.lang.function.ThrowableSupplier.execute;
 import static io.microsphere.text.FormatUtils.format;
 import static java.lang.management.ManagementFactory.getPlatformMBeanServer;
 import static java.util.Collections.emptyList;

microsphere-alibaba-sentinel-commons/src/test/java/io/microsphere/alibaba/sentinel/common/util/SentinelUtilsTest.java

@@ -9,7 +9,6 @@
 import static com.alibaba.csp.sentinel.ResourceTypeConstants.COMMON_DB_SQL;
 import static com.alibaba.csp.sentinel.ResourceTypeConstants.COMMON_RPC;
 import static com.alibaba.csp.sentinel.ResourceTypeConstants.COMMON_WEB;
-import static io.microsphere.reflect.MethodUtils.findMethod;
 import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.DEFAULT_CONTEXT_NAME;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.buildResourceName;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.findSentinelMetricsTaskExecutor;
@@ -19,6 +18,8 @@
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.getResourceTypeAsString;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.getSentinelMetricsTaskExecutor;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.isPluginEnabled;
+import static io.microsphere.reflect.MethodUtils.findMethod;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -82,4 +83,9 @@ void testGetSentinelMetricsTaskExecutor() {
         assertSame(findSentinelMetricsTaskExecutor(), getSentinelMetricsTaskExecutor());
         assertNotEquals(findSentinelMetricsTaskExecutor(), getSentinelMetricsTaskExecutor(null));
     }
+
+    @Test
+    void testResetContextMap() {
+        assertDoesNotThrow(SentinelUtils::resetContextMap);
+    }
 }

microsphere-alibaba-sentinel-parent/pom.xml

@@ -20,11 +20,11 @@
 
     <properties>
         <!-- BOM versions -->
-        <microsphere-spring-cloud.version>0.1.16</microsphere-spring-cloud.version>
-        <microsphere-alibaba-druid.version>0.1.16</microsphere-alibaba-druid.version>
-        <microsphere-mybatis.version>0.1.9</microsphere-mybatis.version>
-        <microsphere-hibernate.version>0.1.5</microsphere-hibernate.version>
-        <microsphere-redis.version>0.1.8</microsphere-redis.version>
+        <microsphere-spring-cloud.version>0.1.23</microsphere-spring-cloud.version>
+        <microsphere-alibaba-druid.version>0.1.18</microsphere-alibaba-druid.version>
+        <microsphere-mybatis.version>0.1.13</microsphere-mybatis.version>
+        <microsphere-hibernate.version>0.1.7</microsphere-hibernate.version>
+        <microsphere-redis.version>0.1.11</microsphere-redis.version>
         <!-- Third-party versions -->
         <sentinel.version>1.8.10</sentinel.version>
         <fastjson.version>2.0.62</fastjson.version>

microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/pom.xml

@@ -20,6 +20,13 @@
 
     <dependencies>
 
+        <!-- Microsphere Annotation Processor -->
+        <dependency>
+            <groupId>io.github.microsphere-projects</groupId>
+            <artifactId>microsphere-annotation-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
         <!-- Microsphere Sentinel Commons -->
         <dependency>
             <groupId>io.github.microsphere-projects</groupId>
@@ -34,10 +41,12 @@
             <optional>true</optional>
         </dependency>
 
-        <!-- Microsphere Annotation Processor -->
+        <!-- Third-Party Dependencies -->
+
+        <!-- Alibaba Sentinel -->
         <dependency>
-            <groupId>io.github.microsphere-projects</groupId>
-            <artifactId>microsphere-annotation-processor</artifactId>
+            <groupId>com.alibaba.csp</groupId>
+            <artifactId>sentinel-core</artifactId>
             <optional>true</optional>
         </dependency>
 
@@ -48,13 +57,6 @@
             <optional>true</optional>
         </dependency>
 
-        <!-- Alibaba Sentinel -->
-        <dependency>
-            <groupId>com.alibaba.csp</groupId>
-            <artifactId>sentinel-core</artifactId>
-            <optional>true</optional>
-        </dependency>
-
         <!-- Testing -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>

microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/main/java/io/microsphere/alibaba/sentinel/alibaba/druid/Constants.java → microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/main/java/io/microsphere/alibaba/sentinel/alibaba/druid/SentinelAlibabaDruidConstants.java

@@ -20,17 +20,18 @@
 import io.microsphere.annotation.ConfigurationProperty;
 import io.microsphere.constants.PropertyConstants;
 
+import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.ENABLED_PROPERTY_VALUE;
+import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.PROPERTY_NAME_PREFIX;
 import static io.microsphere.annotation.ConfigurationProperty.SYSTEM_PROPERTIES_SOURCE;
 import static io.microsphere.constants.SymbolConstants.DOT;
-import static io.microsphere.alibaba.sentinel.common.constants.SentinelConstants.PROPERTY_NAME_PREFIX;
 
 /**
- * The interface to declare the constants of Alibaba Druid
+ * The interface to declare the constants of Sentinel x Alibaba Druid
  *
  * @author <a href="mailto:mercyblitz@gmail.com">Mercy</a>
  * @since 1.0.0
  */
-public interface Constants {
+public interface SentinelAlibabaDruidConstants {
 
     /**
      * The plugin name of Sentinel x Alibaba Druid
@@ -48,11 +49,11 @@ public interface Constants {
     String DEFAULT_ORIGIN = "Filter";
 
     /**
-     * The property name of the plugin of Sentinel x Alibaba Druid enabled
+     * The property name of the plugin of Sentinel x Alibaba Druid enabled : "microsphere.sentinel.alibaba-druid.enabled"
      */
     @ConfigurationProperty(
             type = boolean.class,
-            defaultValue = "true",
+            defaultValue = ENABLED_PROPERTY_VALUE,
             source = SYSTEM_PROPERTIES_SOURCE
     )
     String ENABLED_PROPERTY_NAME = PROPERTY_NAME_PREFIX + PLUGIN_NAME + DOT + PropertyConstants.ENABLED_PROPERTY_NAME;

microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/main/java/io/microsphere/alibaba/sentinel/alibaba/druid/SentinelDruidFilter.java → microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/main/java/io/microsphere/alibaba/sentinel/alibaba/druid/SentinelAlibabaDruidFilter.java

@@ -17,7 +17,6 @@
 package io.microsphere.alibaba.sentinel.alibaba.druid;
 
 import com.alibaba.csp.sentinel.EntryType;
-import com.alibaba.druid.filter.AutoLoad;
 import com.alibaba.druid.filter.Filter;
 import com.alibaba.druid.filter.FilterAdapter;
 import com.alibaba.druid.proxy.jdbc.StatementProxy;
@@ -30,9 +29,9 @@
 
 import static com.alibaba.csp.sentinel.EntryType.IN;
 import static com.alibaba.csp.sentinel.ResourceTypeConstants.COMMON_DB_SQL;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.DEFAULT_CONTEXT_NAME;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.DEFAULT_ORIGIN;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.PLUGIN_NAME;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.DEFAULT_CONTEXT_NAME;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.DEFAULT_ORIGIN;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.PLUGIN_NAME;
 import static io.microsphere.alibaba.sentinel.common.SentinelContext.doInContext;
 import static io.microsphere.alibaba.sentinel.common.SentinelPlugin.install;
 
@@ -44,18 +43,17 @@
  * @see FilterAdapter
  * @since 1.0.0
  */
-@AutoLoad
-public class SentinelDruidFilter extends AbstractStatementFilter implements SentinelPlugin {
+public class SentinelAlibabaDruidFilter extends AbstractStatementFilter implements SentinelPlugin {
 
     private final SentinelPlugin delegate;
 
     private final SentinelOperations sentinelOperations;
 
-    public SentinelDruidFilter() {
+    public SentinelAlibabaDruidFilter() {
         this(DEFAULT_CONTEXT_NAME, DEFAULT_ORIGIN);
     }
 
-    public SentinelDruidFilter(String contextName, String origin) {
+    public SentinelAlibabaDruidFilter(String contextName, String origin) {
         this.delegate = new SimpleSentinelPlugin(PLUGIN_NAME, contextName, origin, COMMON_DB_SQL, IN, false);
         this.sentinelOperations = new SentinelTemplate(getResourceType(), getTrafficType());
         install(this);

microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/main/resources/META-INF/services/com.alibaba.druid.filter.Filter

@@ -1 +1 @@
-io.microsphere.alibaba.sentinel.alibaba.druid.SentinelDruidFilter
+io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidFilter

microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/test/java/io/microsphere/alibaba/sentinel/alibaba/druid/ConstantsTest.java → microsphere-alibaba-sentinel-plugins/microsphere-alibaba-sentinel-alibaba-druid/src/test/java/io/microsphere/alibaba/sentinel/alibaba/druid/SentinelAlibabaDruidConstantsTest.java

@@ -19,21 +19,21 @@
 
 import org.junit.jupiter.api.Test;
 
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.DEFAULT_CONTEXT_NAME;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.DEFAULT_ORIGIN;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.ENABLED_PROPERTY_NAME;
-import static io.microsphere.alibaba.sentinel.alibaba.druid.Constants.PLUGIN_NAME;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.DEFAULT_CONTEXT_NAME;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.DEFAULT_ORIGIN;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.ENABLED_PROPERTY_NAME;
+import static io.microsphere.alibaba.sentinel.alibaba.druid.SentinelAlibabaDruidConstants.PLUGIN_NAME;
 import static io.microsphere.alibaba.sentinel.common.util.SentinelUtils.getPluginEnabledPropertyName;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
- * {@link Constants} Test
+ * {@link SentinelAlibabaDruidConstants} Test
  *
  * @author <a href="mailto:mercyblitz@gmail.com">Mercy</a>
- * @see Constants
+ * @see SentinelAlibabaDruidConstants
  * @since 1.0.0
  */
-class ConstantsTest {
+class SentinelAlibabaDruidConstantsTest {
 
     @Test
     void testConstants() {