diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/BaseSentinelDubboFilter.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/BaseSentinelDubboFilter.java
new file mode 100644
index 0000000000..9ea01e59da
--- /dev/null
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/BaseSentinelDubboFilter.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.dubbo;
+
+
+import com.alibaba.csp.sentinel.Entry;
+import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.context.ContextUtil;
+import org.apache.dubbo.common.URL;
+import org.apache.dubbo.common.constants.CommonConstants;
+import org.apache.dubbo.rpc.Invocation;
+import org.apache.dubbo.rpc.Invoker;
+import org.apache.dubbo.rpc.ListenableFilter;
+import org.apache.dubbo.rpc.Result;
+import org.apache.dubbo.rpc.RpcContext;
+
+/**
+ * Base Class of the {@link SentinelDubboProviderFilter} and {@link SentinelDubboConsumerFilter}.
+ *
+ * @author Zechao Zheng
+ */
+
+public abstract class BaseSentinelDubboFilter extends ListenableFilter {
+ public BaseSentinelDubboFilter() {
+ this.listener = new SentinelDubboListener();
+ }
+
+ static class SentinelDubboListener implements Listener {
+
+ @Override
+ public void onResponse(Result appResponse, Invoker invoker, Invocation invocation) {
+ if (DubboConfig.getDubboBizExceptionTraceEnabled()) {
+ traceAndExit(appResponse.getException(), invoker.getUrl());
+ } else {
+ traceAndExit(null, invoker.getUrl());
+ }
+ }
+
+ @Override
+ public void onError(Throwable t, Invoker invoker, Invocation invocation) {
+ traceAndExit(t, invoker.getUrl());
+ }
+
+ }
+
+ static void traceAndExit(Throwable throwable, URL url) {
+ Entry interfaceEntry = (Entry) RpcContext.getContext().get(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY);
+ Entry methodEntry = (Entry) RpcContext.getContext().get(DubboUtils.DUBBO_METHOD_ENTRY_KEY);
+ if (methodEntry != null) {
+ Tracer.traceEntry(throwable, methodEntry);
+ methodEntry.exit();
+ RpcContext.getContext().remove(DubboUtils.DUBBO_METHOD_ENTRY_KEY);
+ }
+ if (interfaceEntry != null) {
+ Tracer.traceEntry(throwable, interfaceEntry);
+ interfaceEntry.exit();
+ RpcContext.getContext().remove(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY);
+ }
+ if (CommonConstants.PROVIDER_SIDE.equals(url.getParameter(CommonConstants.SIDE_KEY))) {
+ ContextUtil.exit();
+ }
+ }
+}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
index 97ae51bac3..b73542931b 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
@@ -15,7 +15,7 @@
*/
package com.alibaba.csp.sentinel.adapter.dubbo;
-import org.apache.dubbo.common.Constants;
+import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.Filter;
import org.apache.dubbo.rpc.Invocation;
@@ -24,17 +24,19 @@
import org.apache.dubbo.rpc.RpcContext;
import org.apache.dubbo.rpc.RpcException;
+import static org.apache.dubbo.common.constants.CommonConstants.CONSUMER;
+
/**
* Puts current consumer's application name in the attachment of each invocation.
*
* @author Eric Zhao
*/
-@Activate(group = "consumer")
+@Activate(group = CONSUMER)
public class DubboAppContextFilter implements Filter {
@Override
public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
- String application = invoker.getUrl().getParameter(Constants.APPLICATION_KEY);
+ String application = invoker.getUrl().getParameter(CommonConstants.APPLICATION_KEY);
if (application != null) {
RpcContext.getContext().setAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY, application);
}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtils.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtils.java
index 03a494f585..d2c325fafd 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtils.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtils.java
@@ -15,6 +15,8 @@
*/
package com.alibaba.csp.sentinel.adapter.dubbo;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.util.StringUtil;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
@@ -24,6 +26,8 @@
public final class DubboUtils {
public static final String SENTINEL_DUBBO_APPLICATION_KEY = "dubboApplication";
+ public static final String DUBBO_METHOD_ENTRY_KEY = "dubboMethodEntry";
+ public static final String DUBBO_INTERFACE_ENTRY_KEY = "dubboInterfaceEntry";
public static String getApplication(Invocation invocation, String defaultValue) {
if (invocation == null || invocation.getAttachments() == null) {
@@ -32,9 +36,14 @@ public static String getApplication(Invocation invocation, String defaultValue)
return invocation.getAttachment(SENTINEL_DUBBO_APPLICATION_KEY, defaultValue);
}
- public static String getResourceName(Invoker invoker, Invocation invocation) {
+ public static String getResourceName(Invoker invoker, Invocation invocation){
+ return getResourceName(invoker, invocation, false);
+ }
+
+ public static String getResourceName(Invoker invoker, Invocation invocation, Boolean useGroupAndVersion) {
StringBuilder buf = new StringBuilder(64);
- buf.append(invoker.getInterface().getName())
+ String interfaceResource = useGroupAndVersion ? invoker.getUrl().getColonSeparatedKey() : invoker.getInterface().getName();
+ buf.append(interfaceResource)
.append(":")
.append(invocation.getMethodName())
.append("(");
@@ -50,5 +59,16 @@ public static String getResourceName(Invoker invoker, Invocation invocation)
return buf.toString();
}
- private DubboUtils() {}
+ public static String getResourceName(Invoker invoker, Invocation invocation, String prefix) {
+ if (StringUtil.isNotBlank(prefix)) {
+ return new StringBuilder(64)
+ .append(prefix)
+ .append(getResourceName(invoker, invocation, DubboConfig.getDubboInterfaceGroupAndVersionEnabled()))
+ .toString();
+ } else {
+ return getResourceName(invoker, invocation, DubboConfig.getDubboInterfaceGroupAndVersionEnabled());
+ }
+ }
+ private DubboUtils() {
+ }
}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
old mode 100755
new mode 100644
index 2dcbaa79cb..ffa9fba9cf
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
@@ -17,22 +17,26 @@
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
-import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.slots.block.BlockException;
-
-import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
import org.apache.dubbo.common.extension.Activate;
-import org.apache.dubbo.rpc.Filter;
import org.apache.dubbo.rpc.Invocation;
+import org.apache.dubbo.rpc.InvokeMode;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
+import org.apache.dubbo.rpc.RpcContext;
import org.apache.dubbo.rpc.RpcException;
+import org.apache.dubbo.rpc.support.RpcUtils;
+
+import static org.apache.dubbo.common.constants.CommonConstants.CONSUMER;
/**
* Dubbo service consumer filter for Sentinel. Auto activated by default.
- *
+ *
* If you want to disable the consumer filter, you can configure:
*
* <dubbo:consumer filter="-sentinel.dubbo.consumer.filter"/>
@@ -41,8 +45,8 @@
* @author Carpenter Lee
* @author Eric Zhao
*/
-@Activate(group = "consumer")
-public class SentinelDubboConsumerFilter implements Filter {
+@Activate(group = CONSUMER)
+public class SentinelDubboConsumerFilter extends BaseSentinelDubboFilter {
public SentinelDubboConsumerFilter() {
RecordLog.info("Sentinel Apache Dubbo consumer filter initialized");
@@ -52,32 +56,29 @@ public SentinelDubboConsumerFilter() {
public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
Entry interfaceEntry = null;
Entry methodEntry = null;
+ RpcContext rpcContext = RpcContext.getContext();
try {
- String resourceName = DubboUtils.getResourceName(invoker, invocation);
- interfaceEntry = SphU.entry(invoker.getInterface().getName(), EntryType.OUT);
- methodEntry = SphU.entry(resourceName, EntryType.OUT);
+ String methodResourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ String interfaceResourceName = DubboConfig.getDubboInterfaceGroupAndVersionEnabled() ? invoker.getUrl().getColonSeparatedKey()
+ : invoker.getInterface().getName();
+ InvokeMode invokeMode = RpcUtils.getInvokeMode(invoker.getUrl(), invocation);
- Result result = invoker.invoke(invocation);
- if (result.hasException()) {
- Throwable e = result.getException();
- // Record common exception.
- Tracer.traceEntry(e, interfaceEntry);
- Tracer.traceEntry(e, methodEntry);
+ if (InvokeMode.SYNC == invokeMode) {
+ interfaceEntry = SphU.entry(interfaceResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT);
+ rpcContext.set(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY, interfaceEntry);
+ methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT, invocation.getArguments());
+ } else {
+ // should generate the AsyncEntry when the invoke model in future or async
+ interfaceEntry = SphU.asyncEntry(interfaceResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT);
+ rpcContext.set(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY, interfaceEntry);
+ methodEntry = SphU.asyncEntry(methodResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT, 1, invocation.getArguments());
}
- return result;
+ rpcContext.set(DubboUtils.DUBBO_METHOD_ENTRY_KEY, methodEntry);
+ return invoker.invoke(invocation);
} catch (BlockException e) {
return DubboFallbackRegistry.getConsumerFallback().handle(invoker, invocation, e);
- } catch (RpcException e) {
- Tracer.traceEntry(e, interfaceEntry);
- Tracer.traceEntry(e, methodEntry);
- throw e;
- } finally {
- if (methodEntry != null) {
- methodEntry.exit();
- }
- if (interfaceEntry != null) {
- interfaceEntry.exit();
- }
}
}
}
+
+
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
old mode 100755
new mode 100644
index 2020832a0b..c919978694
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
@@ -17,24 +17,26 @@
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
-import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.slots.block.BlockException;
-
import org.apache.dubbo.common.extension.Activate;
-import org.apache.dubbo.rpc.Filter;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
+import org.apache.dubbo.rpc.RpcContext;
import org.apache.dubbo.rpc.RpcException;
+import static org.apache.dubbo.common.constants.CommonConstants.PROVIDER;
+
/**
* Apache Dubbo service provider filter that enables integration with Sentinel. Auto activated by default.
* Note: this only works for Apache Dubbo 2.7.x or above version.
- *
+ *
* If you want to disable the provider filter, you can configure:
*
* <dubbo:provider filter="-sentinel.dubbo.provider.filter"/>
@@ -43,8 +45,8 @@
* @author Carpenter Lee
* @author Eric Zhao
*/
-@Activate(group = "provider")
-public class SentinelDubboProviderFilter implements Filter {
+@Activate(group = PROVIDER)
+public class SentinelDubboProviderFilter extends BaseSentinelDubboFilter {
public SentinelDubboProviderFilter() {
RecordLog.info("Sentinel Apache Dubbo provider filter initialized");
@@ -54,40 +56,26 @@ public SentinelDubboProviderFilter() {
public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
// Get origin caller.
String application = DubboUtils.getApplication(invocation, "");
-
+ RpcContext rpcContext = RpcContext.getContext();
Entry interfaceEntry = null;
Entry methodEntry = null;
try {
- String resourceName = DubboUtils.getResourceName(invoker, invocation);
- String interfaceName = invoker.getInterface().getName();
+ String methodResourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
+ String interfaceResourceName = DubboConfig.getDubboInterfaceGroupAndVersionEnabled() ? invoker.getUrl().getColonSeparatedKey()
+ : invoker.getInterface().getName();
// Only need to create entrance context at provider side, as context will take effect
// at entrance of invocation chain only (for inbound traffic).
- ContextUtil.enter(resourceName, application);
- interfaceEntry = SphU.entry(interfaceName, EntryType.IN);
- methodEntry = SphU.entry(resourceName, EntryType.IN, 1, invocation.getArguments());
-
- Result result = invoker.invoke(invocation);
- if (result.hasException()) {
- Throwable e = result.getException();
- // Record common exception.
- Tracer.traceEntry(e, interfaceEntry);
- Tracer.traceEntry(e, methodEntry);
- }
- return result;
+ ContextUtil.enter(methodResourceName, application);
+ interfaceEntry = SphU.entry(interfaceResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.IN);
+ rpcContext.set(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY, interfaceEntry);
+ methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.IN, invocation.getArguments());
+ rpcContext.set(DubboUtils.DUBBO_METHOD_ENTRY_KEY, methodEntry);
+ return invoker.invoke(invocation);
} catch (BlockException e) {
return DubboFallbackRegistry.getProviderFallback().handle(invoker, invocation, e);
- } catch (RpcException e) {
- Tracer.traceEntry(e, interfaceEntry);
- Tracer.traceEntry(e, methodEntry);
- throw e;
- } finally {
- if (methodEntry != null) {
- methodEntry.exit(1, invocation.getArguments());
- }
- if (interfaceEntry != null) {
- interfaceEntry.exit();
- }
- ContextUtil.exit();
}
}
+
+
}
+
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java
new file mode 100644
index 0000000000..9b2b021828
--- /dev/null
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.dubbo.config;
+
+import com.alibaba.csp.sentinel.config.SentinelConfig;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+/**
+ *
+ * Responsible for dubbo service provider, consumer attribute configuration
+ *
+ *
+ * @author lianglin
+ * @since 1.7.0
+ */
+public final class DubboConfig {
+
+ public static final String DUBBO_USE_PREFIX = "csp.sentinel.dubbo.resource.use.prefix";
+ private static final String TRUE_STR = "true";
+
+ public static final String DUBBO_PROVIDER_PREFIX = "csp.sentinel.dubbo.resource.provider.prefix";
+ public static final String DUBBO_CONSUMER_PREFIX = "csp.sentinel.dubbo.resource.consumer.prefix";
+
+ private static final String DEFAULT_DUBBO_PROVIDER_PREFIX = "dubbo:provider:";
+ private static final String DEFAULT_DUBBO_CONSUMER_PREFIX = "dubbo:consumer:";
+
+ public static final String DUBBO_INTERFACE_GROUP_VERSION_ENABLED = "csp.sentinel.dubbo.interface.group.version.enabled";
+
+ public static final String TRACE_BIZ_EXCEPTION_ENABLED = "csp.sentinel.dubbo.trace.biz.exception.enabled";
+
+
+ public static boolean isUsePrefix() {
+ return TRUE_STR.equalsIgnoreCase(SentinelConfig.getConfig(DUBBO_USE_PREFIX));
+ }
+
+ public static String getDubboProviderPrefix() {
+ if (isUsePrefix()) {
+ String config = SentinelConfig.getConfig(DUBBO_PROVIDER_PREFIX);
+ return StringUtil.isNotBlank(config) ? config : DEFAULT_DUBBO_PROVIDER_PREFIX;
+ }
+ return null;
+ }
+
+ public static String getDubboConsumerPrefix() {
+ if (isUsePrefix()) {
+ String config = SentinelConfig.getConfig(DUBBO_CONSUMER_PREFIX);
+ return StringUtil.isNotBlank(config) ? config : DEFAULT_DUBBO_CONSUMER_PREFIX;
+ }
+ return null;
+ }
+
+ public static Boolean getDubboInterfaceGroupAndVersionEnabled() {
+ return TRUE_STR.equalsIgnoreCase(SentinelConfig.getConfig(DUBBO_INTERFACE_GROUP_VERSION_ENABLED));
+ }
+
+ public static Boolean getDubboBizExceptionTraceEnabled() {
+ String traceBizExceptionEnabled = SentinelConfig.getConfig(TRACE_BIZ_EXCEPTION_ENABLED);
+ if (StringUtil.isNotBlank(traceBizExceptionEnabled)) {
+ return TRUE_STR.equalsIgnoreCase(traceBizExceptionEnabled);
+ }
+ return true;
+ }
+
+}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/BaseTest.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/BaseTest.java
index a61f3b4c80..7793a6567e 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/BaseTest.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/BaseTest.java
@@ -15,26 +15,73 @@
*/
package com.alibaba.csp.sentinel;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService;
+import com.alibaba.csp.sentinel.config.SentinelConfig;
+import com.alibaba.csp.sentinel.context.ContextUtil;
+import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import com.alibaba.csp.sentinel.slots.clusterbuilder.ClusterBuilderSlot;
-
+import org.apache.dubbo.common.URL;
+import org.apache.dubbo.common.constants.CommonConstants;
+import org.apache.dubbo.rpc.Invocation;
+import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.RpcContext;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
/**
* Base test class, provide common methods for subClass
* The package is same as CtSph, to call CtSph.resetChainMap() method for test
- *
+ *
* Note: Only for test. DO NOT USE IN PRODUCTION!
*
* @author cdfive
*/
public class BaseTest {
+
+ protected Invoker invoker;
+ protected Invocation invocation;
+
+ public void constructInvokerAndInvocation() {
+ invoker = mock(Invoker.class);
+ URL url = URL.valueOf("dubbo://127.0.0.1:2181")
+ .addParameter(CommonConstants.VERSION_KEY, "1.0.0")
+ .addParameter(CommonConstants.GROUP_KEY, "grp1")
+ .addParameter(CommonConstants.INTERFACE_KEY, DemoService.class.getName());
+ when(invoker.getUrl()).thenReturn(url);
+ when(invoker.getInterface()).thenReturn(DemoService.class);
+
+ invocation = mock(Invocation.class);
+ Method method = DemoService.class.getMethods()[0];
+ when(invocation.getMethodName()).thenReturn(method.getName());
+ when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
+
+ }
+
/**
* Clean up resources for context, clusterNodeMap, processorSlotChainMap
*/
protected static void cleanUpAll() {
- RpcContext.removeContext();
- ClusterBuilderSlot.getClusterNodeMap().clear();
- CtSph.resetChainMap();
+ try {
+ RpcContext.removeContext();
+ ClusterBuilderSlot.getClusterNodeMap().clear();
+ CtSph.resetChainMap();
+ Method method = ContextUtil.class.getDeclaredMethod("resetContextMap");
+ method.setAccessible(true);
+ method.invoke(null, null);
+ ContextUtil.exit();
+ SentinelConfig.setConfig(DubboConfig.DUBBO_INTERFACE_GROUP_VERSION_ENABLED, "true");
+ FlowRuleManager.loadRules(new ArrayList<>());
+ DegradeRuleManager.loadRules(new ArrayList<>());
+ } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
+ e.printStackTrace();
+ }
}
}
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtilsTest.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtilsTest.java
index 8d3636f180..ece46fde3d 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtilsTest.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboUtilsTest.java
@@ -15,30 +15,55 @@
*/
package com.alibaba.csp.sentinel.adapter.dubbo;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService;
+import com.alibaba.csp.sentinel.config.SentinelConfig;
+import org.apache.dubbo.common.URL;
+import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
+import org.junit.After;
+import org.junit.Before;
import org.junit.Test;
import java.lang.reflect.Method;
import java.util.HashMap;
-import com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService;
-
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
-import static org.mockito.Mockito.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
/**
* @author cdfive
*/
public class DubboUtilsTest {
+ @Before
+ public void setUp() {
+ SentinelConfig.setConfig("csp.sentinel.dubbo.resource.use.prefix", "true");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_INTERFACE_GROUP_VERSION_ENABLED, "false");
+ }
+
+
+ @After
+ public void tearDown() {
+ SentinelConfig.setConfig("csp.sentinel.dubbo.resource.use.prefix", "false");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_INTERFACE_GROUP_VERSION_ENABLED, "false");
+ }
+
+
@Test
public void testGetApplication() {
Invocation invocation = mock(Invocation.class);
when(invocation.getAttachments()).thenReturn(new HashMap<>());
when(invocation.getAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY, ""))
- .thenReturn("consumerA");
+ .thenReturn("consumerA");
String application = DubboUtils.getApplication(invocation, "");
verify(invocation).getAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY, "");
@@ -51,7 +76,7 @@ public void testGetApplicationNoAttachments() {
Invocation invocation = mock(Invocation.class);
when(invocation.getAttachments()).thenReturn(null);
when(invocation.getAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY, ""))
- .thenReturn("consumerA");
+ .thenReturn("consumerA");
DubboUtils.getApplication(invocation, "");
@@ -59,17 +84,66 @@ public void testGetApplicationNoAttachments() {
}
@Test
- public void testGetResourceName() {
+ public void testGetResourceName() throws NoSuchMethodException {
Invoker invoker = mock(Invoker.class);
when(invoker.getInterface()).thenReturn(DemoService.class);
Invocation invocation = mock(Invocation.class);
- Method method = DemoService.class.getMethods()[0];
+ Method method = DemoService.class.getDeclaredMethod("sayHello", String.class, int.class);
when(invocation.getMethodName()).thenReturn(method.getName());
when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
String resourceName = DubboUtils.getResourceName(invoker, invocation);
assertEquals("com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+
+ }
+
+ @Test
+ public void testGetResourceNameWithGroupAndVersion() throws NoSuchMethodException {
+ Invoker invoker = mock(Invoker.class);
+ URL url = URL.valueOf("dubbo://127.0.0.1:2181")
+ .addParameter(CommonConstants.VERSION_KEY, "1.0.0")
+ .addParameter(CommonConstants.GROUP_KEY, "grp1")
+ .addParameter(CommonConstants.INTERFACE_KEY, DemoService.class.getName());
+ when(invoker.getUrl()).thenReturn(url);
+ when(invoker.getInterface()).thenReturn(DemoService.class);
+
+ Invocation invocation = mock(Invocation.class);
+ Method method = DemoService.class.getDeclaredMethod("sayHello", String.class, int.class);
+ when(invocation.getMethodName()).thenReturn(method.getName());
+ when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
+
+ String resourceNameUseGroupAndVersion = DubboUtils.getResourceName(invoker, invocation, true);
+
+ assertEquals("com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:1.0.0:grp1:sayHello(java.lang.String,int)", resourceNameUseGroupAndVersion);
+ }
+
+
+ @Test
+ public void testGetResourceNameWithPrefix() throws NoSuchMethodException {
+ Invoker invoker = mock(Invoker.class);
+ when(invoker.getInterface()).thenReturn(DemoService.class);
+
+ Invocation invocation = mock(Invocation.class);
+ Method method = DemoService.class.getDeclaredMethod("sayHello", String.class, int.class);
+ when(invocation.getMethodName()).thenReturn(method.getName());
+ when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
+
+ //test with default prefix
+ String resourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
+ assertEquals("dubbo:provider:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+ resourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ assertEquals("dubbo:consumer:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+
+
+ //test with custom prefix
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "my:dubbo:provider:");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "my:dubbo:consumer:");
+ resourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
+ assertEquals("my:dubbo:provider:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+ resourceName = DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ assertEquals("my:dubbo:consumer:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+
}
-}
+}
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
index e4b30b95e0..f949231bc3 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
@@ -16,9 +16,12 @@
package com.alibaba.csp.sentinel.adapter.dubbo;
import com.alibaba.csp.sentinel.BaseTest;
-import com.alibaba.csp.sentinel.Constants;
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
+import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DefaultDubboFallback;
+import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallback;
+import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
import com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService;
import com.alibaba.csp.sentinel.context.Context;
import com.alibaba.csp.sentinel.context.ContextUtil;
@@ -27,20 +30,40 @@
import com.alibaba.csp.sentinel.node.Node;
import com.alibaba.csp.sentinel.node.StatisticNode;
import com.alibaba.csp.sentinel.slotchain.ResourceWrapper;
-
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import com.alibaba.csp.sentinel.slots.block.RuleConstant;
+import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule;
+import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
+import org.apache.dubbo.rpc.AsyncRpcResult;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
+import org.apache.dubbo.rpc.RpcContext;
+import org.apache.dubbo.rpc.support.RpcUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.LinkedList;
+import java.util.List;
import java.util.Map;
+import java.util.Queue;
import java.util.Set;
-import static org.junit.Assert.*;
-import static org.mockito.Mockito.*;
+import static com.alibaba.csp.sentinel.slots.block.RuleConstant.DEGRADE_GRADE_EXCEPTION_RATIO;
+import static org.apache.dubbo.rpc.Constants.ASYNC_KEY;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNotSame;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertSame;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
/**
* @author cdfive
@@ -49,28 +72,191 @@ public class SentinelDubboConsumerFilterTest extends BaseTest {
private SentinelDubboConsumerFilter filter = new SentinelDubboConsumerFilter();
+
@Before
public void setUp() {
cleanUpAll();
+ initFallback();
+ constructInvokerAndInvocation();
}
@After
public void cleanUp() {
cleanUpAll();
+ DubboFallbackRegistry.setConsumerFallback(new DefaultDubboFallback());
+ }
+
+ public void initFlowRule(String resource) {
+ FlowRule flowRule = new FlowRule(resource);
+ flowRule.setCount(1);
+ flowRule.setGrade(RuleConstant.FLOW_GRADE_QPS);
+ List flowRules = new ArrayList<>();
+ flowRules.add(flowRule);
+ FlowRuleManager.loadRules(flowRules);
+ }
+
+ public void initDegradeRule(String resource) {
+ DegradeRule degradeRule = new DegradeRule(resource)
+ .setCount(0.5)
+ .setGrade(DEGRADE_GRADE_EXCEPTION_RATIO);
+ List degradeRules = new ArrayList<>();
+ degradeRules.add(degradeRule);
+ degradeRule.setTimeWindow(1);
+ DegradeRuleManager.loadRules(degradeRules);
+ }
+
+
+ public void initFallback() {
+ DubboFallbackRegistry.setConsumerFallback(new DubboFallback() {
+ @Override
+ public Result handle(Invoker invoker, Invocation invocation, BlockException ex) {
+ boolean async = RpcUtils.isAsync(invoker.getUrl(), invocation);
+ Result fallbackResult = null;
+ fallbackResult = AsyncRpcResult.newDefaultAsyncResult("fallback", invocation);
+ return fallbackResult;
+ }
+ });
+ }
+
+ @Test
+ public void testInterfaceLevelFollowControlAsync() throws InterruptedException {
+ when(invocation.getAttachment(ASYNC_KEY)).thenReturn(Boolean.TRUE.toString());
+ initFlowRule(invoker.getUrl().getColonSeparatedKey());
+ Result result1 = responseBack(requestGo(false, invocation));
+ assertEquals("normal", result1.getValue());
+ // should fallback because the qps > 1
+ Result result2 = responseBack(requestGo(false, invocation));
+ assertEquals("fallback", result2.getValue());
+ // sleeping 1000 ms to reset qps
+ Thread.sleep(1000);
+ Result result3 = responseBack(requestGo(false, invocation));
+ assertEquals("normal", result3.getValue());
+
+ verifyInvocationStructureForCallFinish();
}
@Test
- public void testInvoke() {
- final Invoker invoker = mock(Invoker.class);
- when(invoker.getInterface()).thenReturn(DemoService.class);
+ public void testDegradeAsync() throws InterruptedException {
+ when(invocation.getAttachment(ASYNC_KEY)).thenReturn(Boolean.TRUE.toString());
+
+ initDegradeRule(invoker.getUrl().getColonSeparatedKey());
+ Result result = requestGo(false, invocation);
+ verifyInvocationStructureForAsyncCall(invoker, invocation);
+ responseBack(result);
+ assertEquals("normal", result.getValue());
+ // inc the clusterNode's exception to trigger the fallback
+ for (int i = 0; i < 5; i++) {
+ responseBack(requestGo(true, invocation));
+ verifyInvocationStructureForCallFinish();
+ }
+ Result result2 = responseBack(requestGo(false, invocation));
+ assertEquals("fallback", result2.getValue());
+ // sleeping 1000 ms to reset exception
+ Thread.sleep(1000);
+
+ Result result3 = responseBack(requestGo(false, invocation));
+ assertEquals("normal", result3.getValue());
+
+ Context context = ContextUtil.getContext();
+ assertNull(context);
+ }
+
+ @Test
+ public void testDegradeSync() throws InterruptedException {
+
+ initDegradeRule(invoker.getUrl().getColonSeparatedKey());
+ Result result = requestGo(false, invocation);
+ verifyInvocationStructure(invoker, invocation);
+ responseBack(result);
+ assertEquals("normal", result.getValue());
+ // inc the clusterNode's exception to trigger the fallback
+ for (int i = 0; i < 5; i++) {
+ responseBack(requestGo(true, invocation));
+ verifyInvocationStructureForCallFinish();
+ }
+ Result result2 = responseBack(requestGo(false, invocation));
+ assertEquals("fallback", result2.getValue());
+ // sleeping 1000 ms to reset exception
+ Thread.sleep(1000);
+
+ Result result3 = responseBack(requestGo(false, invocation));
+ assertEquals("normal", result3.getValue());
+
+ Context context = ContextUtil.getContext();
+ assertNull(context);
+ }
- final Invocation invocation = mock(Invocation.class);
- Method method = DemoService.class.getMethods()[0];
- when(invocation.getMethodName()).thenReturn(method.getName());
- when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
+
+ @Test
+ public void testMethodFlowControlAsync() {
+ when(invocation.getAttachment(ASYNC_KEY)).thenReturn(Boolean.TRUE.toString());
+ initFlowRule(DubboUtils.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix()));
+ responseBack(requestGo(false, invocation));
+
+ responseBack(requestGo(false, invocation));
+
+ Invocation invocation2 = mock(Invocation.class);
+ Method method = DemoService.class.getMethods()[1];
+ when(invocation2.getMethodName()).thenReturn(method.getName());
+ when(invocation2.getParameterTypes()).thenReturn(method.getParameterTypes());
+ Result result2 = responseBack(requestGo(false, invocation2));
+ verifyInvocationStructureForCallFinish();
+ assertEquals("normal", result2.getValue());
+
+ // the method of invocation should be blocked
+ Result fallback = requestGo(false, invocation);
+ assertNotNull(RpcContext.getContext().get(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY));
+ assertNull(RpcContext.getContext().get(DubboUtils.DUBBO_METHOD_ENTRY_KEY));
+ responseBack(fallback);
+ assertEquals("fallback", fallback.getValue());
+ verifyInvocationStructureForCallFinish();
+
+
+ }
+
+ public Result requestGo(boolean exception, Invocation currentInvocation) {
+ AsyncRpcResult result = null;
+
+ if (exception) {
+ result = AsyncRpcResult.newDefaultAsyncResult(new Exception("error"), currentInvocation);
+ } else {
+ result = AsyncRpcResult.newDefaultAsyncResult("normal", currentInvocation);
+ }
+ when(invoker.invoke(currentInvocation)).thenReturn(result);
+ return filter.invoke(invoker, currentInvocation);
+ }
+
+ public Result responseBack(Result result) {
+ filter.listener().onResponse(result, invoker, invocation);
+ return result;
+ }
+
+
+ @Test
+ public void testInvokeAsync() throws InterruptedException {
+
+ when(invocation.getAttachment(ASYNC_KEY)).thenReturn(Boolean.TRUE.toString());
final Result result = mock(Result.class);
when(result.hasException()).thenReturn(false);
+ when(invoker.invoke(invocation)).thenAnswer(invocationOnMock -> {
+ verifyInvocationStructureForAsyncCall(invoker, invocation);
+ return result;
+ });
+
+ filter.invoke(invoker, invocation);
+ verify(invoker).invoke(invocation);
+
+ Context context = ContextUtil.getContext();
+ assertNotNull(context);
+ }
+
+ @Test
+ public void testInvokeSync() {
+
+ final Result result = mock(Result.class);
+ when(result.hasException()).thenReturn(false);
+ when(result.getException()).thenReturn(new Exception());
when(invoker.invoke(invocation)).thenAnswer(invocationOnMock -> {
verifyInvocationStructure(invoker, invocation);
return result;
@@ -79,6 +265,7 @@ public void testInvoke() {
filter.invoke(invoker, invocation);
verify(invoker).invoke(invocation);
+ filter.listener().onResponse(result, invoker, invocation);
Context context = ContextUtil.getContext();
assertNull(context);
}
@@ -92,34 +279,35 @@ public void testInvoke() {
private void verifyInvocationStructure(Invoker invoker, Invocation invocation) {
Context context = ContextUtil.getContext();
assertNotNull(context);
-
// As not call ContextUtil.enter(resourceName, application) in SentinelDubboConsumerFilter, use default context
// In actual project, a consumer is usually also a provider, the context will be created by SentinelDubboProviderFilter
// If consumer is on the top of Dubbo RPC invocation chain, use default context
- String resourceName = DubboUtils.getResourceName(invoker, invocation);
- assertEquals(Constants.CONTEXT_DEFAULT_NAME, context.getName());
+ String resourceName = DubboUtils.getResourceName(invoker, invocation, true);
+ assertEquals(com.alibaba.csp.sentinel.Constants.CONTEXT_DEFAULT_NAME, context.getName());
assertEquals("", context.getOrigin());
DefaultNode entranceNode = context.getEntranceNode();
ResourceWrapper entranceResource = entranceNode.getId();
- assertEquals(Constants.CONTEXT_DEFAULT_NAME, entranceResource.getName());
- assertSame(EntryType.IN, entranceResource.getType());
+
+ assertEquals(com.alibaba.csp.sentinel.Constants.CONTEXT_DEFAULT_NAME, entranceResource.getName());
+ assertSame(EntryType.IN, entranceResource.getEntryType());
// As SphU.entry(interfaceName, EntryType.OUT);
Set childList = entranceNode.getChildList();
assertEquals(1, childList.size());
- DefaultNode interfaceNode = (DefaultNode) childList.iterator().next();
+ DefaultNode interfaceNode = getNode(invoker.getUrl().getColonSeparatedKey(), entranceNode);
ResourceWrapper interfaceResource = interfaceNode.getId();
- assertEquals(DemoService.class.getName(), interfaceResource.getName());
- assertSame(EntryType.OUT, interfaceResource.getType());
+
+ assertEquals(invoker.getUrl().getColonSeparatedKey(), interfaceResource.getName());
+ assertSame(EntryType.OUT, interfaceResource.getEntryType());
// As SphU.entry(resourceName, EntryType.OUT);
childList = interfaceNode.getChildList();
assertEquals(1, childList.size());
- DefaultNode methodNode = (DefaultNode) childList.iterator().next();
+ DefaultNode methodNode = getNode(resourceName, entranceNode);
ResourceWrapper methodResource = methodNode.getId();
assertEquals(resourceName, methodResource.getName());
- assertSame(EntryType.OUT, methodResource.getType());
+ assertSame(EntryType.OUT, methodResource.getEntryType());
// Verify curEntry
Entry curEntry = context.getCurEntry();
@@ -139,4 +327,82 @@ private void verifyInvocationStructure(Invoker invoker, Invocation invocation) {
Map interfaceOriginCountMap = interfaceClusterNode.getOriginCountMap();
assertEquals(0, interfaceOriginCountMap.size());
}
+
+ private void verifyInvocationStructureForAsyncCall(Invoker invoker, Invocation invocation) {
+ Context context = ContextUtil.getContext();
+ assertNotNull(context);
+
+ // As not call ContextUtil.enter(resourceName, application) in SentinelDubboConsumerFilter, use default context
+ // In actual project, a consumer is usually also a provider, the context will be created by SentinelDubboProviderFilter
+ // If consumer is on the top of Dubbo RPC invocation chain, use default context
+ String resourceName = DubboUtils.getResourceName(invoker, invocation, true);
+ assertEquals(com.alibaba.csp.sentinel.Constants.CONTEXT_DEFAULT_NAME, context.getName());
+ assertEquals("", context.getOrigin());
+
+ DefaultNode entranceNode = context.getEntranceNode();
+ ResourceWrapper entranceResource = entranceNode.getId();
+ assertEquals(com.alibaba.csp.sentinel.Constants.CONTEXT_DEFAULT_NAME, entranceResource.getName());
+ assertSame(EntryType.IN, entranceResource.getEntryType());
+
+ // As SphU.entry(interfaceName, EntryType.OUT);
+ Set childList = entranceNode.getChildList();
+ assertEquals(2, childList.size());
+ DefaultNode interfaceNode = getNode(invoker.getUrl().getColonSeparatedKey(), entranceNode);
+ ResourceWrapper interfaceResource = interfaceNode.getId();
+ assertEquals(invoker.getUrl().getColonSeparatedKey(), interfaceResource.getName());
+ assertSame(EntryType.OUT, interfaceResource.getEntryType());
+
+ // As SphU.entry(resourceName, EntryType.OUT);
+ childList = interfaceNode.getChildList();
+ assertEquals(0, childList.size());
+ DefaultNode methodNode = getNode(resourceName, entranceNode);
+ ResourceWrapper methodResource = methodNode.getId();
+ assertEquals(resourceName, methodResource.getName());
+ assertSame(EntryType.OUT, methodResource.getEntryType());
+
+ // Verify curEntry
+ // nothing will bind to local context when use the AsyncEntry
+ Entry curEntry = context.getCurEntry();
+ assertNull(curEntry);
+
+ // Verify clusterNode
+ ClusterNode methodClusterNode = methodNode.getClusterNode();
+ ClusterNode interfaceClusterNode = interfaceNode.getClusterNode();
+ assertNotSame(methodClusterNode, interfaceClusterNode);// Different resource->Different ProcessorSlot->Different ClusterNode
+
+ // As context origin is "", the StatisticNode should not be created in originCountMap of ClusterNode
+ Map methodOriginCountMap = methodClusterNode.getOriginCountMap();
+ assertEquals(0, methodOriginCountMap.size());
+
+ Map interfaceOriginCountMap = interfaceClusterNode.getOriginCountMap();
+ assertEquals(0, interfaceOriginCountMap.size());
+ }
+
+
+ private void verifyInvocationStructureForCallFinish() {
+ Context context = ContextUtil.getContext();
+ assertNull(context);
+ Entry interfaceEntry = (Entry) RpcContext.getContext().get(DubboUtils.DUBBO_INTERFACE_ENTRY_KEY);
+ Entry methodEntry = (Entry) RpcContext.getContext().get(DubboUtils.DUBBO_METHOD_ENTRY_KEY);
+ assertNull(interfaceEntry);
+ assertNull(methodEntry);
+ }
+
+
+ public DefaultNode getNode(String resourceName, DefaultNode root) {
+
+ Queue queue = new LinkedList<>();
+ queue.offer(root);
+ while (!queue.isEmpty()) {
+ DefaultNode temp = queue.poll();
+ if (temp.getId().getName().equals(resourceName)) {
+ return temp;
+ }
+ for (Node node : temp.getChildList()) {
+ queue.offer((DefaultNode) node);
+ }
+ }
+ return null;
+ }
+
}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
index 8b0ab899a9..1a7000f1d6 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
@@ -26,7 +26,8 @@
import com.alibaba.csp.sentinel.node.Node;
import com.alibaba.csp.sentinel.node.StatisticNode;
import com.alibaba.csp.sentinel.slotchain.ResourceWrapper;
-
+import org.apache.dubbo.common.URL;
+import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Result;
@@ -38,8 +39,15 @@
import java.util.Map;
import java.util.Set;
-import static org.junit.Assert.*;
-import static org.mockito.Mockito.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNotSame;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
/**
* @author cdfive
@@ -50,6 +58,7 @@ public class SentinelDubboProviderFilterTest extends BaseTest {
@Before
public void setUp() {
+ constructInvokerAndInvocation();
cleanUpAll();
}
@@ -62,18 +71,16 @@ public void cleanUp() {
public void testInvoke() {
final String originApplication = "consumerA";
- final Invoker invoker = mock(Invoker.class);
- when(invoker.getInterface()).thenReturn(DemoService.class);
+ URL url = invoker.getUrl()
+ .addParameter(CommonConstants.SIDE_KEY, CommonConstants.PROVIDER_SIDE);
+ when(invoker.getUrl()).thenReturn(url);
- final Invocation invocation = mock(Invocation.class);
- Method method = DemoService.class.getMethods()[0];
- when(invocation.getMethodName()).thenReturn(method.getName());
- when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
when(invocation.getAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY, ""))
- .thenReturn(originApplication);
+ .thenReturn(originApplication);
final Result result = mock(Result.class);
when(result.hasException()).thenReturn(false);
+ when(result.getException()).thenReturn(new Exception());
when(invoker.invoke(invocation)).thenAnswer(invocationOnMock -> {
verifyInvocationStructure(originApplication, invoker, invocation);
return result;
@@ -82,6 +89,7 @@ public void testInvoke() {
filter.invoke(invoker, invocation);
verify(invoker).invoke(invocation);
+ filter.listener().onResponse(result, invoker, invocation);
Context context = ContextUtil.getContext();
assertNull(context);
}
@@ -97,22 +105,23 @@ private void verifyInvocationStructure(String originApplication, Invoker invoker
assertNotNull(context);
// As ContextUtil.enter(resourceName, application) in SentinelDubboProviderFilter
- String resourceName = DubboUtils.getResourceName(invoker, invocation);
+ String resourceName = DubboUtils.getResourceName(invoker, invocation, true);
assertEquals(resourceName, context.getName());
assertEquals(originApplication, context.getOrigin());
DefaultNode entranceNode = context.getEntranceNode();
ResourceWrapper entranceResource = entranceNode.getId();
assertEquals(resourceName, entranceResource.getName());
- assertSame(EntryType.IN, entranceResource.getType());
+ assertSame(EntryType.IN, entranceResource.getEntryType());
// As SphU.entry(interfaceName, EntryType.IN);
Set childList = entranceNode.getChildList();
assertEquals(1, childList.size());
DefaultNode interfaceNode = (DefaultNode) childList.iterator().next();
ResourceWrapper interfaceResource = interfaceNode.getId();
- assertEquals(DemoService.class.getName(), interfaceResource.getName());
- assertSame(EntryType.IN, interfaceResource.getType());
+
+ assertEquals(invoker.getUrl().getColonSeparatedKey(), interfaceResource.getName());
+ assertSame(EntryType.IN, interfaceResource.getEntryType());
// As SphU.entry(resourceName, EntryType.IN, 1, invocation.getArguments());
childList = interfaceNode.getChildList();
@@ -120,7 +129,7 @@ private void verifyInvocationStructure(String originApplication, Invoker invoker
DefaultNode methodNode = (DefaultNode) childList.iterator().next();
ResourceWrapper methodResource = methodNode.getId();
assertEquals(resourceName, methodResource.getName());
- assertSame(EntryType.IN, methodResource.getType());
+ assertSame(EntryType.IN, methodResource.getEntryType());
// Verify curEntry
Entry curEntry = context.getCurEntry();
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/fallback/DubboFallbackRegistryTest.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/fallback/DubboFallbackRegistryTest.java
index bc06ebf179..e1f199b729 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/fallback/DubboFallbackRegistryTest.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/fallback/DubboFallbackRegistryTest.java
@@ -18,10 +18,11 @@
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.SentinelRpcException;
import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
-
+import org.apache.dubbo.rpc.AsyncRpcResult;
import org.apache.dubbo.rpc.Result;
-import org.apache.dubbo.rpc.RpcResult;
+import org.junit.After;
import org.junit.Assert;
+import org.junit.Before;
import org.junit.Test;
/**
@@ -29,6 +30,16 @@
*/
public class DubboFallbackRegistryTest {
+ @Before
+ public void setUp() {
+ DubboFallbackRegistry.setConsumerFallback(new DefaultDubboFallback());
+ }
+
+ @After
+ public void tearDown() {
+ DubboFallbackRegistry.setConsumerFallback(new DefaultDubboFallback());
+ }
+
@Test(expected = SentinelRpcException.class)
public void testDefaultFallback() {
// Test for default.
@@ -41,7 +52,7 @@ public void testDefaultFallback() {
public void testCustomFallback() {
BlockException ex = new FlowException("xxx");
DubboFallbackRegistry.setConsumerFallback(
- (invoker, invocation, e) -> new RpcResult("Error: " + e.getClass().getName()));
+ (invoker, invocation, e) -> AsyncRpcResult.newDefaultAsyncResult("Error: " + e.getClass().getName(), invocation));
Result result = DubboFallbackRegistry.getConsumerFallback()
.handle(null, null, ex);
Assert.assertFalse("The invocation should not fail", result.hasException());
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/DemoService.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/DemoService.java
index 2a024cc9cb..26e8447997 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/DemoService.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/DemoService.java
@@ -20,4 +20,5 @@
*/
public interface DemoService {
String sayHello(String name, int n);
+ String sayHi(String name,int n);
}
diff --git a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/impl/DemoServiceImpl.java b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/impl/DemoServiceImpl.java
index f804c2c42e..b09e08bea9 100644
--- a/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/impl/DemoServiceImpl.java
+++ b/sentinel-adapter/sentinel-apache-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/provider/impl/DemoServiceImpl.java
@@ -24,4 +24,9 @@ public class DemoServiceImpl implements DemoService {
public String sayHello(String name, int n) {
return "Hello " + name + ", " + n;
}
+
+ @Override
+ public String sayHi(String name, int n) {
+ return "Hi " + name + ", " + n;
+ }
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/pom.xml b/sentinel-adapter/sentinel-api-gateway-adapter-common/pom.xml
index 5cc4a43f06..6b2d57dcd3 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/pom.xml
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/SentinelGatewayConstants.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/SentinelGatewayConstants.java
index 2c56e6b7ce..5e8f78e2a7 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/SentinelGatewayConstants.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/SentinelGatewayConstants.java
@@ -30,16 +30,22 @@ public final class SentinelGatewayConstants {
public static final int PARAM_PARSE_STRATEGY_HOST = 1;
public static final int PARAM_PARSE_STRATEGY_HEADER = 2;
public static final int PARAM_PARSE_STRATEGY_URL_PARAM = 3;
+ public static final int PARAM_PARSE_STRATEGY_COOKIE = 4;
+
+ public static final int URL_MATCH_STRATEGY_EXACT = 0;
+ public static final int URL_MATCH_STRATEGY_PREFIX = 1;
+ public static final int URL_MATCH_STRATEGY_REGEX = 2;
public static final int PARAM_MATCH_STRATEGY_EXACT = 0;
public static final int PARAM_MATCH_STRATEGY_PREFIX = 1;
public static final int PARAM_MATCH_STRATEGY_REGEX = 2;
+ public static final int PARAM_MATCH_STRATEGY_CONTAINS = 3;
public static final String GATEWAY_CONTEXT_DEFAULT = "sentinel_gateway_context_default";
public static final String GATEWAY_CONTEXT_PREFIX = "sentinel_gateway_context$$";
public static final String GATEWAY_CONTEXT_ROUTE_PREFIX = "sentinel_gateway_context$$route$$";
- public static final String GATEWAY_NOT_MATCH_PARAM = "$$not_match";
+ public static final String GATEWAY_NOT_MATCH_PARAM = "$NM";
public static final String GATEWAY_DEFAULT_PARAM = "$D";
private SentinelGatewayConstants() {}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/api/ApiPathPredicateItem.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/api/ApiPathPredicateItem.java
index 1cbce589fb..a47b280154 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/api/ApiPathPredicateItem.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/api/ApiPathPredicateItem.java
@@ -17,6 +17,8 @@
import java.util.Objects;
+import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
+
/**
* @author Eric Zhao
* @since 1.6.0
@@ -24,7 +26,7 @@
public class ApiPathPredicateItem implements ApiPredicateItem {
private String pattern;
- private int matchStrategy;
+ private int matchStrategy = SentinelGatewayConstants.URL_MATCH_STRATEGY_EXACT;
public ApiPathPredicateItem setPattern(String pattern) {
this.pattern = pattern;
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayApiDefinitionGroupCommandHandler.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayApiDefinitionGroupCommandHandler.java
index 963561f82a..d480512c28 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayApiDefinitionGroupCommandHandler.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayApiDefinitionGroupCommandHandler.java
@@ -15,19 +15,24 @@
*/
package com.alibaba.csp.sentinel.adapter.gateway.common.command;
-import java.net.URLDecoder;
-import java.util.HashSet;
-import java.util.List;
-
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPathPredicateItem;
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPredicateItem;
import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
import com.alibaba.csp.sentinel.command.CommandHandler;
import com.alibaba.csp.sentinel.command.CommandRequest;
import com.alibaba.csp.sentinel.command.CommandResponse;
import com.alibaba.csp.sentinel.command.annotation.CommandMapping;
+import com.alibaba.csp.sentinel.datasource.WritableDataSource;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.util.StringUtil;
+import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
+import com.alibaba.fastjson.JSONObject;
+
+import java.net.URLDecoder;
+import java.util.HashSet;
+import java.util.Set;
/**
* @author Eric Zhao
@@ -36,6 +41,8 @@
@CommandMapping(name = "gateway/updateApiDefinitions", desc = "")
public class UpdateGatewayApiDefinitionGroupCommandHandler implements CommandHandler {
+ private static WritableDataSource> apiDefinitionWds = null;
+
@Override
public CommandResponse handle(CommandRequest request) {
String data = request.getParam("data");
@@ -52,10 +59,67 @@ public CommandResponse handle(CommandRequest request) {
RecordLog.info("[API Server] Receiving data change (type: gateway API definition): {0}", data);
String result = SUCCESS_MSG;
- List apiDefinitions = JSONArray.parseArray(data, ApiDefinition.class);
- GatewayApiDefinitionManager.loadApiDefinitions(new HashSet<>(apiDefinitions));
+
+ Set apiDefinitions = parseJson(data);
+ GatewayApiDefinitionManager.loadApiDefinitions(apiDefinitions);
+ if (!writeToDataSource(apiDefinitionWds, apiDefinitions)) {
+ result = WRITE_DS_FAILURE_MSG;
+ }
return CommandResponse.ofSuccess(result);
}
private static final String SUCCESS_MSG = "success";
+ private static final String WRITE_DS_FAILURE_MSG = "partial success (write data source failed)";
+
+ /**
+ * Parse json data to set of {@link ApiDefinition}.
+ *
+ * Since the predicateItems of {@link ApiDefinition} is set of interface,
+ * here we parse predicateItems to {@link ApiPathPredicateItem} temporarily.
+ */
+ private Set parseJson(String data) {
+ Set apiDefinitions = new HashSet<>();
+ JSONArray array = JSON.parseArray(data);
+ for (Object obj : array) {
+ JSONObject o = (JSONObject)obj;
+ ApiDefinition apiDefinition = new ApiDefinition((o.getString("apiName")));
+ Set predicateItems = new HashSet<>();
+ JSONArray itemArray = o.getJSONArray("predicateItems");
+ if (itemArray != null) {
+ predicateItems.addAll(itemArray.toJavaList(ApiPathPredicateItem.class));
+ }
+ apiDefinition.setPredicateItems(predicateItems);
+ apiDefinitions.add(apiDefinition);
+ }
+
+ return apiDefinitions;
+ }
+
+ /**
+ * Write target value to given data source.
+ *
+ * @param dataSource writable data source
+ * @param value target value to save
+ * @param value type
+ * @return true if write successful or data source is empty; false if error occurs
+ */
+ private boolean writeToDataSource(WritableDataSource dataSource, T value) {
+ if (dataSource != null) {
+ try {
+ dataSource.write(value);
+ } catch (Exception e) {
+ RecordLog.warn("Write data source failed", e);
+ return false;
+ }
+ }
+ return true;
+ }
+
+ public synchronized static WritableDataSource> getWritableDataSource() {
+ return apiDefinitionWds;
+ }
+
+ public synchronized static void setWritableDataSource(WritableDataSource> apiDefinitionWds) {
+ UpdateGatewayApiDefinitionGroupCommandHandler.apiDefinitionWds = apiDefinitionWds;
+ }
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayRuleCommandHandler.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayRuleCommandHandler.java
index 46e14209b4..b79b78f9cf 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayRuleCommandHandler.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/command/UpdateGatewayRuleCommandHandler.java
@@ -15,19 +15,20 @@
*/
package com.alibaba.csp.sentinel.adapter.gateway.common.command;
-import java.net.URLDecoder;
-import java.util.HashSet;
-import java.util.List;
-
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayRuleManager;
import com.alibaba.csp.sentinel.command.CommandHandler;
import com.alibaba.csp.sentinel.command.CommandRequest;
import com.alibaba.csp.sentinel.command.CommandResponse;
import com.alibaba.csp.sentinel.command.annotation.CommandMapping;
+import com.alibaba.csp.sentinel.datasource.WritableDataSource;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.util.StringUtil;
-import com.alibaba.fastjson.JSONArray;
+import com.alibaba.fastjson.JSON;
+import com.alibaba.fastjson.TypeReference;
+
+import java.net.URLDecoder;
+import java.util.Set;
/**
* @author Eric Zhao
@@ -35,6 +36,7 @@
*/
@CommandMapping(name = "gateway/updateRules", desc = "Update gateway rules")
public class UpdateGatewayRuleCommandHandler implements CommandHandler {
+ private static WritableDataSource> gatewayFlowWds = null;
@Override
public CommandResponse handle(CommandRequest request) {
@@ -52,10 +54,43 @@ public CommandResponse handle(CommandRequest request) {
RecordLog.info(String.format("[API Server] Receiving rule change (type: gateway rule): %s", data));
String result = SUCCESS_MSG;
- List flowRules = JSONArray.parseArray(data, GatewayFlowRule.class);
- GatewayRuleManager.loadRules(new HashSet<>(flowRules));
+ Set flowRules = JSON.parseObject(data, new TypeReference>() {
+ });
+ GatewayRuleManager.loadRules(flowRules);
+ if (!writeToDataSource(gatewayFlowWds, flowRules)) {
+ result = WRITE_DS_FAILURE_MSG;
+ }
return CommandResponse.ofSuccess(result);
}
+ /**
+ * Write target value to given data source.
+ *
+ * @param dataSource writable data source
+ * @param value target value to save
+ * @param value type
+ * @return true if write successful or data source is empty; false if error occurs
+ */
+ private boolean writeToDataSource(WritableDataSource dataSource, T value) {
+ if (dataSource != null) {
+ try {
+ dataSource.write(value);
+ } catch (Exception e) {
+ RecordLog.warn("Write data source failed", e);
+ return false;
+ }
+ }
+ return true;
+ }
+
+ public synchronized static WritableDataSource> getWritableDataSource() {
+ return gatewayFlowWds;
+ }
+
+ public synchronized static void setWritableDataSource(WritableDataSource> gatewayFlowWds) {
+ UpdateGatewayRuleCommandHandler.gatewayFlowWds = gatewayFlowWds;
+ }
+
private static final String SUCCESS_MSG = "success";
+ private static final String WRITE_DS_FAILURE_MSG = "partial success (write data source failed)";
}
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParser.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParser.java
index f326468b68..40bc92d71f 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParser.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParser.java
@@ -17,6 +17,7 @@
import java.util.HashSet;
import java.util.Set;
+import java.util.regex.Pattern;
import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
@@ -42,8 +43,8 @@ public GatewayParamParser(RequestItemParser requestItemParser) {
/**
* Parse parameters for given resource from the request entity on condition of the rule predicate.
*
- * @param resource valid resource name
- * @param request valid request
+ * @param resource valid resource name
+ * @param request valid request
* @param rulePredicate rule predicate indicating the rules to refer
* @return the parameter array
*/
@@ -92,6 +93,8 @@ private String parseInternal(GatewayParamFlowItem item, T request) {
return parseHeader(item, request);
case SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM:
return parseUrlParameter(item, request);
+ case SentinelGatewayConstants.PARAM_PARSE_STRATEGY_COOKIE:
+ return parseCookie(item, request);
default:
return null;
}
@@ -100,7 +103,7 @@ private String parseInternal(GatewayParamFlowItem item, T request) {
private String parseClientIp(/*@Valid*/ GatewayParamFlowItem item, T request) {
String clientIp = requestItemParser.getRemoteAddress(request);
String pattern = item.getPattern();
- if (pattern == null) {
+ if (StringUtil.isEmpty(pattern)) {
return clientIp;
}
return parseWithMatchStrategyInternal(item.getMatchStrategy(), clientIp, pattern);
@@ -111,7 +114,7 @@ private String parseHeader(/*@Valid*/ GatewayParamFlowItem item, T request) {
String pattern = item.getPattern();
// TODO: what if the header has multiple values?
String headerValue = requestItemParser.getHeader(request, headerKey);
- if (pattern == null) {
+ if (StringUtil.isEmpty(pattern)) {
return headerValue;
}
// Match value according to regex pattern or exact mode.
@@ -121,7 +124,7 @@ private String parseHeader(/*@Valid*/ GatewayParamFlowItem item, T request) {
private String parseHost(/*@Valid*/ GatewayParamFlowItem item, T request) {
String pattern = item.getPattern();
String host = requestItemParser.getHeader(request, "Host");
- if (pattern == null) {
+ if (StringUtil.isEmpty(pattern)) {
return host;
}
// Match value according to regex pattern or exact mode.
@@ -132,7 +135,18 @@ private String parseUrlParameter(/*@Valid*/ GatewayParamFlowItem item, T request
String paramName = item.getFieldName();
String pattern = item.getPattern();
String param = requestItemParser.getUrlParam(request, paramName);
- if (pattern == null) {
+ if (StringUtil.isEmpty(pattern)) {
+ return param;
+ }
+ // Match value according to regex pattern or exact mode.
+ return parseWithMatchStrategyInternal(item.getMatchStrategy(), param, pattern);
+ }
+
+ private String parseCookie(/*@Valid*/ GatewayParamFlowItem item, T request) {
+ String cookieName = item.getFieldName();
+ String pattern = item.getPattern();
+ String param = requestItemParser.getCookieValue(request, cookieName);
+ if (StringUtil.isEmpty(pattern)) {
return param;
}
// Match value according to regex pattern or exact mode.
@@ -140,13 +154,22 @@ private String parseUrlParameter(/*@Valid*/ GatewayParamFlowItem item, T request
}
private String parseWithMatchStrategyInternal(int matchStrategy, String value, String pattern) {
- // TODO: implement here.
if (value == null) {
return null;
}
- if (matchStrategy == SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX) {
- return value;
+ switch (matchStrategy) {
+ case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_EXACT:
+ return value.equals(pattern) ? value : SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM;
+ case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_CONTAINS:
+ return value.contains(pattern) ? value : SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM;
+ case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX:
+ Pattern regex = GatewayRegexCache.getRegexPattern(pattern);
+ if (regex == null) {
+ return value;
+ }
+ return regex.matcher(value).matches() ? value : SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM;
+ default:
+ return value;
}
- return value;
}
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCache.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCache.java
new file mode 100644
index 0000000000..17d22b9e94
--- /dev/null
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCache.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.gateway.common.param;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Pattern;
+
+import com.alibaba.csp.sentinel.log.RecordLog;
+
+/**
+ * @author Eric Zhao
+ * @since 1.6.2
+ */
+public final class GatewayRegexCache {
+
+ private static final Map REGEX_CACHE = new ConcurrentHashMap<>();
+
+ public static Pattern getRegexPattern(String pattern) {
+ if (pattern == null) {
+ return null;
+ }
+ return REGEX_CACHE.get(pattern);
+ }
+
+ public static boolean addRegexPattern(String pattern) {
+ if (pattern == null) {
+ return false;
+ }
+ try {
+ Pattern regex = Pattern.compile(pattern);
+ REGEX_CACHE.put(pattern, regex);
+ return true;
+ } catch (Exception ex) {
+ RecordLog.warn("[GatewayRegexCache] Failed to compile the regex: " + pattern, ex);
+ return false;
+ }
+ }
+
+ public static void clear() {
+ REGEX_CACHE.clear();
+ }
+
+ private GatewayRegexCache() {}
+}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/RequestItemParser.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/RequestItemParser.java
index 5b28abe785..7eb71c52be 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/RequestItemParser.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/RequestItemParser.java
@@ -41,7 +41,7 @@ public interface RequestItemParser {
* Get the header associated with the header key.
*
* @param request valid request
- * @param key valid header key
+ * @param key valid header key
* @return the header
*/
String getHeader(T request, String key);
@@ -49,9 +49,19 @@ public interface RequestItemParser {
/**
* Get the parameter value associated with the parameter name.
*
- * @param request valid request
+ * @param request valid request
* @param paramName valid parameter name
* @return the parameter value
*/
String getUrlParam(T request, String paramName);
+
+ /**
+ * Get the cookie value associated with the cookie name.
+ *
+ * @param request valid request
+ * @param cookieName valid cookie name
+ * @return the cookie value
+ * @since 1.7.0
+ */
+ String getCookieValue(T request, String cookieName);
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleConverter.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleConverter.java
index f5531fa24f..814c0bfe20 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleConverter.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleConverter.java
@@ -15,7 +15,9 @@
*/
package com.alibaba.csp.sentinel.adapter.gateway.common.rule;
+import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowItem;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRule;
/**
@@ -32,6 +34,18 @@ static FlowRule toFlowRule(/*@Valid*/ GatewayFlowRule rule) {
.setMaxQueueingTimeMs(rule.getMaxQueueingTimeoutMs());
}
+ static ParamFlowItem generateNonMatchPassParamItem() {
+ return new ParamFlowItem().setClassType(String.class.getName())
+ .setCount(1000_0000)
+ .setObject(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+ }
+
+ static ParamFlowItem generateNonMatchBlockParamItem() {
+ return new ParamFlowItem().setClassType(String.class.getName())
+ .setCount(0)
+ .setObject(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+ }
+
static ParamFlowRule applyNonParamToParamRule(/*@Valid*/ GatewayFlowRule gatewayRule, int idx) {
return new ParamFlowRule(gatewayRule.getResource())
.setCount(gatewayRule.getCount())
@@ -63,7 +77,11 @@ static ParamFlowRule applyToParamRule(/*@Valid*/ GatewayFlowRule gatewayRule, in
GatewayParamFlowItem gatewayItem = gatewayRule.getParamItem();
// Apply the current idx to gateway rule item.
gatewayItem.setIndex(idx);
- // TODO: implement for pattern-based parameters.
+ // Apply for pattern-based parameters.
+ String valuePattern = gatewayItem.getPattern();
+ if (valuePattern != null) {
+ paramRule.getParamFlowItemList().add(generateNonMatchPassParamItem());
+ }
return paramRule;
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleManager.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleManager.java
index e4880bed2d..8744707d85 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleManager.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/common/rule/GatewayRuleManager.java
@@ -16,6 +16,7 @@
package com.alibaba.csp.sentinel.adapter.gateway.common.rule;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
@@ -24,6 +25,7 @@
import java.util.concurrent.ConcurrentHashMap;
import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
+import com.alibaba.csp.sentinel.adapter.gateway.common.param.GatewayRegexCache;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.property.DynamicSentinelProperty;
import com.alibaba.csp.sentinel.property.PropertyListener;
@@ -131,6 +133,16 @@ private int getIdxInternal(Map idxMap, String resourceName) {
return idxMap.get(resourceName);
}
+ private void cacheRegexPattern(/*@NonNull*/ GatewayParamFlowItem item) {
+ String pattern = item.getPattern();
+ if (StringUtil.isNotEmpty(pattern) &&
+ item.getMatchStrategy() == SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX) {
+ if (GatewayRegexCache.getRegexPattern(pattern) == null) {
+ GatewayRegexCache.addRegexPattern(pattern);
+ }
+ }
+ }
+
private synchronized void applyGatewayRuleInternal(Set conf) {
if (conf == null || conf.isEmpty()) {
applyToConvertedParamMap(new HashSet());
@@ -162,6 +174,7 @@ private synchronized void applyGatewayRuleInternal(Set conf) {
if (paramFlowRules.add(GatewayRuleConverter.applyToParamRule(rule, idx))) {
idxMap.put(rule.getResource(), idx + 1);
}
+ cacheRegexPattern(rule.getParamItem());
}
// Apply to the gateway rule map.
Set ruleSet = gatewayRuleMap.get(resourceName);
@@ -242,14 +255,18 @@ static boolean isValidParamItem(/*@NonNull*/ GatewayParamFlowItem item) {
if (item.getParseStrategy() < 0) {
return false;
}
- if (item.getParseStrategy() == SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM ||
- item.getParseStrategy() == SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER) {
- if (StringUtil.isBlank(item.getFieldName())) {
- return false;
- }
+ // Check required field name for item types.
+ if (FIELD_REQUIRED_SET.contains(item.getParseStrategy()) && StringUtil.isBlank(item.getFieldName())) {
+ return false;
}
return StringUtil.isEmpty(item.getPattern()) || item.getMatchStrategy() >= 0;
}
+ private static final Set FIELD_REQUIRED_SET = new HashSet<>(
+ Arrays.asList(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM,
+ SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER,
+ SentinelGatewayConstants.PARAM_PARSE_STRATEGY_COOKIE)
+ );
+
private GatewayRuleManager() {}
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParserTest.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParserTest.java
index 7edc7844ed..e37c693018 100644
--- a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParserTest.java
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayParamParserTest.java
@@ -94,6 +94,7 @@ public void testParseParametersWithItems() {
final String api1 = "my_test_route_B";
final String headerName = "X-Sentinel-Flag";
final String paramName = "p";
+ final String cookieName = "myCookie";
GatewayFlowRule routeRuleNoParam = new GatewayFlowRule(routeId1)
.setCount(10)
.setIntervalSec(10);
@@ -128,6 +129,13 @@ public void testParseParametersWithItems() {
.setParamItem(new GatewayParamFlowItem()
.setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HOST)
);
+ GatewayFlowRule routeRule5 = new GatewayFlowRule(routeId1)
+ .setCount(50)
+ .setIntervalSec(30)
+ .setParamItem(new GatewayParamFlowItem()
+ .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_COOKIE)
+ .setFieldName(cookieName)
+ );
GatewayFlowRule apiRule1 = new GatewayFlowRule(api1)
.setResourceMode(SentinelGatewayConstants.RESOURCE_MODE_CUSTOM_API_NAME)
.setCount(5)
@@ -140,6 +148,7 @@ public void testParseParametersWithItems() {
rules.add(routeRule2);
rules.add(routeRule3);
rules.add(routeRule4);
+ rules.add(routeRule5);
rules.add(routeRuleNoParam);
rules.add(apiRule1);
GatewayRuleManager.loadRules(rules);
@@ -148,19 +157,24 @@ public void testParseParametersWithItems() {
final String expectedAddress = "66.77.88.99";
final String expectedHeaderValue1 = "Sentinel";
final String expectedUrlParamValue1 = "17";
+ final String expectedCookieValue1 = "Sentinel-Foo";
+
mockClientHostAddress(itemParser, expectedAddress);
Map expectedHeaders = new HashMap() {{
put(headerName, expectedHeaderValue1); put("Host", expectedHost);
}};
mockHeaders(itemParser, expectedHeaders);
mockSingleUrlParam(itemParser, paramName, expectedUrlParamValue1);
+ mockSingleCookie(itemParser, cookieName, expectedCookieValue1);
+
Object[] params = paramParser.parseParameterFor(routeId1, request, routeIdPredicate);
- // Param length should be 5 (4 with parameters, 1 normal flow with generated constant)
- assertThat(params.length).isEqualTo(5);
+ // Param length should be 6 (5 with parameters, 1 normal flow with generated constant)
+ assertThat(params.length).isEqualTo(6);
assertThat(params[routeRule1.getParamItem().getIndex()]).isEqualTo(expectedAddress);
assertThat(params[routeRule2.getParamItem().getIndex()]).isEqualTo(expectedHeaderValue1);
assertThat(params[routeRule3.getParamItem().getIndex()]).isEqualTo(expectedUrlParamValue1);
assertThat(params[routeRule4.getParamItem().getIndex()]).isEqualTo(expectedHost);
+ assertThat(params[routeRule5.getParamItem().getIndex()]).isEqualTo(expectedCookieValue1);
assertThat(params[params.length - 1]).isEqualTo(SentinelGatewayConstants.GATEWAY_DEFAULT_PARAM);
assertThat(paramParser.parseParameterFor(api1, request, routeIdPredicate).length).isZero();
@@ -172,6 +186,125 @@ public void testParseParametersWithItems() {
assertThat(params[apiRule1.getParamItem().getIndex()]).isEqualTo(expectedUrlParamValue2);
}
+ @Test
+ public void testParseParametersWithEmptyItemPattern() {
+ RequestItemParser itemParser = mock(RequestItemParser.class);
+ GatewayParamParser paramParser = new GatewayParamParser<>(itemParser);
+ // Create a fake request.
+ Object request = new Object();
+ // Prepare gateway rules.
+ Set rules = new HashSet<>();
+ final String routeId = "my_test_route_DS(*H";
+ final String headerName = "X-Sentinel-Flag";
+ GatewayFlowRule routeRule1 = new GatewayFlowRule(routeId)
+ .setCount(10)
+ .setIntervalSec(2)
+ .setParamItem(new GatewayParamFlowItem()
+ .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER)
+ .setFieldName(headerName)
+ .setPattern("")
+ .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_EXACT)
+ );
+ rules.add(routeRule1);
+ GatewayRuleManager.loadRules(rules);
+
+ mockSingleHeader(itemParser, headerName, "Sent1nel");
+ Object[] params = paramParser.parseParameterFor(routeId, request, routeIdPredicate);
+ assertThat(params.length).isEqualTo(1);
+ // Empty pattern should not take effect.
+ assertThat(params[routeRule1.getParamItem().getIndex()]).isEqualTo("Sent1nel");
+ }
+
+ @Test
+ public void testParseParametersWithItemPatternMatching() {
+ RequestItemParser itemParser = mock(RequestItemParser.class);
+ GatewayParamParser paramParser = new GatewayParamParser<>(itemParser);
+ // Create a fake request.
+ Object request = new Object();
+
+ // Prepare gateway rules.
+ Set rules = new HashSet<>();
+ final String routeId1 = "my_test_route_F&@";
+ final String api1 = "my_test_route_E5K";
+ final String headerName = "X-Sentinel-Flag";
+ final String paramName = "p";
+
+ String nameEquals = "Wow";
+ String nameContains = "warn";
+ String valueRegex = "\\d+";
+ GatewayFlowRule routeRule1 = new GatewayFlowRule(routeId1)
+ .setCount(10)
+ .setIntervalSec(1)
+ .setControlBehavior(RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER)
+ .setMaxQueueingTimeoutMs(600)
+ .setParamItem(new GatewayParamFlowItem()
+ .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER)
+ .setFieldName(headerName)
+ .setPattern(nameEquals)
+ .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_EXACT)
+ );
+ GatewayFlowRule routeRule2 = new GatewayFlowRule(routeId1)
+ .setCount(20)
+ .setIntervalSec(1)
+ .setBurst(5)
+ .setParamItem(new GatewayParamFlowItem()
+ .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM)
+ .setFieldName(paramName)
+ .setPattern(nameContains)
+ .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_CONTAINS)
+ );
+ GatewayFlowRule apiRule1 = new GatewayFlowRule(api1)
+ .setResourceMode(SentinelGatewayConstants.RESOURCE_MODE_CUSTOM_API_NAME)
+ .setCount(5)
+ .setIntervalSec(1)
+ .setParamItem(new GatewayParamFlowItem()
+ .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM)
+ .setFieldName(paramName)
+ .setPattern(valueRegex)
+ .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX)
+ );
+ rules.add(routeRule1);
+ rules.add(routeRule2);
+ rules.add(apiRule1);
+ GatewayRuleManager.loadRules(rules);
+
+ mockSingleHeader(itemParser, headerName, nameEquals);
+ mockSingleUrlParam(itemParser, paramName, nameContains);
+ Object[] params = paramParser.parseParameterFor(routeId1, request, routeIdPredicate);
+ assertThat(params.length).isEqualTo(2);
+ assertThat(params[routeRule1.getParamItem().getIndex()]).isEqualTo(nameEquals);
+ assertThat(params[routeRule2.getParamItem().getIndex()]).isEqualTo(nameContains);
+
+ mockSingleHeader(itemParser, headerName, nameEquals + "_foo");
+ mockSingleUrlParam(itemParser, paramName, nameContains + "_foo");
+ params = paramParser.parseParameterFor(routeId1, request, routeIdPredicate);
+ assertThat(params.length).isEqualTo(2);
+ assertThat(params[routeRule1.getParamItem().getIndex()])
+ .isEqualTo(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+ assertThat(params[routeRule2.getParamItem().getIndex()])
+ .isEqualTo(nameContains + "_foo");
+
+ mockSingleHeader(itemParser, headerName, "foo");
+ mockSingleUrlParam(itemParser, paramName, "foo");
+ params = paramParser.parseParameterFor(routeId1, request, routeIdPredicate);
+ assertThat(params.length).isEqualTo(2);
+ assertThat(params[routeRule1.getParamItem().getIndex()])
+ .isEqualTo(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+ assertThat(params[routeRule2.getParamItem().getIndex()])
+ .isEqualTo(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+
+ mockSingleUrlParam(itemParser, paramName, "23");
+ params = paramParser.parseParameterFor(api1, request, apiNamePredicate);
+ assertThat(params.length).isEqualTo(1);
+ assertThat(params[apiRule1.getParamItem().getIndex()]).isEqualTo("23");
+
+ mockSingleUrlParam(itemParser, paramName, "some233");
+ params = paramParser.parseParameterFor(api1, request, apiNamePredicate);
+ assertThat(params.length).isEqualTo(1);
+ assertThat(params[apiRule1.getParamItem().getIndex()])
+ .isEqualTo(SentinelGatewayConstants.GATEWAY_NOT_MATCH_PARAM);
+ }
+
private void mockClientHostAddress(/*@Mock*/ RequestItemParser parser, String address) {
when(parser.getRemoteAddress(any())).thenReturn(address);
}
@@ -196,15 +329,21 @@ private void mockSingleHeader(/*@Mock*/ RequestItemParser parser, String key, St
when(parser.getHeader(any(), eq(key))).thenReturn(value);
}
+ private void mockSingleCookie(/*@Mock*/ RequestItemParser parser, String key, String value) {
+ when(parser.getCookieValue(any(), eq(key))).thenReturn(value);
+ }
+
@Before
public void setUp() {
GatewayApiDefinitionManager.loadApiDefinitions(new HashSet());
GatewayRuleManager.loadRules(new HashSet());
+ GatewayRegexCache.clear();
}
@After
public void tearDown() {
GatewayApiDefinitionManager.loadApiDefinitions(new HashSet());
GatewayRuleManager.loadRules(new HashSet());
+ GatewayRegexCache.clear();
}
}
diff --git a/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCacheTest.java b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCacheTest.java
new file mode 100644
index 0000000000..c10b2888fb
--- /dev/null
+++ b/sentinel-adapter/sentinel-api-gateway-adapter-common/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/common/param/GatewayRegexCacheTest.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.gateway.common.param;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Eric Zhao
+ */
+public class GatewayRegexCacheTest {
+
+ @Before
+ public void setUp() {
+ GatewayRegexCache.clear();
+ }
+
+ @After
+ public void tearDown() {
+ GatewayRegexCache.clear();
+ }
+
+ @Test
+ public void testAddAndGetRegexPattern() {
+ // Test for invalid pattern.
+ assertThat(GatewayRegexCache.addRegexPattern("\\")).isFalse();
+ assertThat(GatewayRegexCache.addRegexPattern(null)).isFalse();
+ // Test for good pattern.
+ String goodPattern = "\\d+";
+ assertThat(GatewayRegexCache.addRegexPattern(goodPattern)).isTrue();
+ assertThat(GatewayRegexCache.getRegexPattern(goodPattern)).isNotNull();
+ }
+}
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/pom.xml b/sentinel-adapter/sentinel-dubbo-adapter/pom.xml
index 6bbf6d6a1b..732c8c6caa 100755
--- a/sentinel-adapter/sentinel-dubbo-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-dubbo-adapter/pom.xml
@@ -6,7 +6,7 @@
com.alibaba.csp
sentinel-adapter
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
sentinel-dubbo-adapter
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilter.java b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilter.java
index 2c5b077964..aa8248a524 100755
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilter.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilter.java
@@ -15,6 +15,7 @@
*/
package com.alibaba.csp.sentinel.adapter.dubbo;
+import com.alibaba.csp.sentinel.util.StringUtil;
import com.alibaba.dubbo.rpc.Filter;
import com.alibaba.dubbo.rpc.Invocation;
import com.alibaba.dubbo.rpc.Invoker;
@@ -27,9 +28,9 @@ abstract class AbstractDubboFilter implements Filter {
protected String getResourceName(Invoker invoker, Invocation invocation) {
StringBuilder buf = new StringBuilder(64);
buf.append(invoker.getInterface().getName())
- .append(":")
- .append(invocation.getMethodName())
- .append("(");
+ .append(":")
+ .append(invocation.getMethodName())
+ .append("(");
boolean isFirst = true;
for (Class clazz : invocation.getParameterTypes()) {
if (!isFirst) {
@@ -41,4 +42,16 @@ protected String getResourceName(Invoker invoker, Invocation invocation) {
buf.append(")");
return buf.toString();
}
+
+ protected String getResourceName(Invoker invoker, Invocation invocation, String prefix) {
+ if (StringUtil.isBlank(prefix)) {
+ return getResourceName(invoker, invocation);
+ }
+ StringBuilder buf = new StringBuilder(64);
+ return buf.append(prefix)
+ .append(getResourceName(invoker, invocation))
+ .toString();
+
+
+ }
}
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
index ceae979d53..e76f2db42e 100644
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/DubboAppContextFilter.java
@@ -24,12 +24,14 @@
import com.alibaba.dubbo.rpc.RpcContext;
import com.alibaba.dubbo.rpc.RpcException;
+import static com.alibaba.dubbo.common.Constants.CONSUMER;
+
/**
* Puts current consumer's application name in the attachment of each invocation.
*
* @author Eric Zhao
*/
-@Activate(group = "consumer")
+@Activate(group = CONSUMER)
public class DubboAppContextFilter implements Filter {
@Override
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
index 54e067ba2f..e7c36af92e 100755
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilter.java
@@ -17,10 +17,11 @@
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
-import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.dubbo.common.extension.Activate;
@@ -30,6 +31,8 @@
import com.alibaba.dubbo.rpc.Result;
import com.alibaba.dubbo.rpc.RpcException;
+import static com.alibaba.dubbo.common.Constants.CONSUMER;
+
/**
* Dubbo service consumer filter for Sentinel. Auto activated by default.
*
@@ -41,7 +44,7 @@
* @author leyou
* @author Eric Zhao
*/
-@Activate(group = "consumer")
+@Activate(group = CONSUMER)
public class SentinelDubboConsumerFilter extends AbstractDubboFilter implements Filter {
public SentinelDubboConsumerFilter() {
@@ -53,20 +56,24 @@ public Result invoke(Invoker invoker, Invocation invocation) throws RpcExcept
Entry interfaceEntry = null;
Entry methodEntry = null;
try {
- String resourceName = getResourceName(invoker, invocation);
- interfaceEntry = SphU.entry(invoker.getInterface().getName(), EntryType.OUT);
- methodEntry = SphU.entry(resourceName, EntryType.OUT);
+ String resourceName = getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ interfaceEntry = SphU.entry(invoker.getInterface().getName(), ResourceTypeConstants.COMMON_RPC,
+ EntryType.OUT);
+ methodEntry = SphU.entry(resourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT);
Result result = invoker.invoke(invocation);
if (result.hasException()) {
+ Throwable e = result.getException();
// Record common exception.
- Tracer.trace(result.getException());
+ Tracer.traceEntry(e, interfaceEntry);
+ Tracer.traceEntry(e, methodEntry);
}
return result;
} catch (BlockException e) {
return DubboFallbackRegistry.getConsumerFallback().handle(invoker, invocation, e);
} catch (RpcException e) {
- Tracer.trace(e);
+ Tracer.traceEntry(e, interfaceEntry);
+ Tracer.traceEntry(e, methodEntry);
throw e;
} finally {
if (methodEntry != null) {
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
index c82afb8bb7..85d566ad99 100755
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilter.java
@@ -17,13 +17,14 @@
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
import com.alibaba.csp.sentinel.adapter.dubbo.fallback.DubboFallbackRegistry;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.slots.block.BlockException;
-import com.alibaba.csp.sentinel.slots.block.SentinelRpcException;
import com.alibaba.dubbo.common.extension.Activate;
import com.alibaba.dubbo.rpc.Filter;
import com.alibaba.dubbo.rpc.Invocation;
@@ -31,6 +32,8 @@
import com.alibaba.dubbo.rpc.Result;
import com.alibaba.dubbo.rpc.RpcException;
+import static com.alibaba.dubbo.common.Constants.PROVIDER;
+
/**
* Dubbo service provider filter for Sentinel. Auto activated by default.
*
@@ -42,7 +45,7 @@
* @author leyou
* @author Eric Zhao
*/
-@Activate(group = "provider")
+@Activate(group = PROVIDER)
public class SentinelDubboProviderFilter extends AbstractDubboFilter implements Filter {
public SentinelDubboProviderFilter() {
@@ -57,21 +60,26 @@ public Result invoke(Invoker invoker, Invocation invocation) throws RpcExcept
Entry interfaceEntry = null;
Entry methodEntry = null;
try {
- String resourceName = getResourceName(invoker, invocation);
+ String resourceName = getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
String interfaceName = invoker.getInterface().getName();
ContextUtil.enter(resourceName, application);
- interfaceEntry = SphU.entry(interfaceName, EntryType.IN);
- methodEntry = SphU.entry(resourceName, EntryType.IN, 1, invocation.getArguments());
+ interfaceEntry = SphU.entry(interfaceName, ResourceTypeConstants.COMMON_RPC, EntryType.IN);
+ methodEntry = SphU.entry(resourceName, ResourceTypeConstants.COMMON_RPC,
+ EntryType.IN, invocation.getArguments());
Result result = invoker.invoke(invocation);
if (result.hasException()) {
- Tracer.trace(result.getException());
+ Throwable e = result.getException();
+ // Record common exception.
+ Tracer.traceEntry(e, interfaceEntry);
+ Tracer.traceEntry(e, methodEntry);
}
return result;
} catch (BlockException e) {
return DubboFallbackRegistry.getProviderFallback().handle(invoker, invocation, e);
} catch (RpcException e) {
- Tracer.trace(e);
+ Tracer.traceEntry(e, interfaceEntry);
+ Tracer.traceEntry(e, methodEntry);
throw e;
} finally {
if (methodEntry != null) {
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java
new file mode 100644
index 0000000000..b7658d29a4
--- /dev/null
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/dubbo/config/DubboConfig.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.dubbo.config;
+
+import com.alibaba.csp.sentinel.config.SentinelConfig;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+/**
+ *
+ * Responsible for dubbo service provider, consumer attribute configuration
+ *
+ *
+ * @author lianglin
+ * @since 1.7.0
+ */
+public final class DubboConfig {
+
+ public static final String DUBBO_USE_PREFIX = "csp.sentinel.dubbo.resource.use.prefix";
+ private static final String TRUE_STR = "true";
+
+ public static final String DUBBO_PROVIDER_PREFIX = "csp.sentinel.dubbo.resource.provider.prefix";
+ public static final String DUBBO_CONSUMER_PREFIX = "csp.sentinel.dubbo.resource.consumer.prefix";
+
+ private static final String DEFAULT_DUBBO_PROVIDER_PREFIX = "dubbo:provider:";
+ private static final String DEFAULT_DUBBO_CONSUMER_PREFIX = "dubbo:consumer:";
+
+ public static boolean isUsePrefix() {
+ return TRUE_STR.equalsIgnoreCase(SentinelConfig.getConfig(DUBBO_USE_PREFIX));
+ }
+
+
+ public static String getDubboProviderPrefix() {
+ if (isUsePrefix()) {
+ String config = SentinelConfig.getConfig(DUBBO_PROVIDER_PREFIX);
+ return StringUtil.isNotBlank(config) ? config : DEFAULT_DUBBO_PROVIDER_PREFIX;
+ }
+ return null;
+ }
+
+ public static String getDubboConsumerPrefix() {
+ if (isUsePrefix()) {
+ String config = SentinelConfig.getConfig(DUBBO_CONSUMER_PREFIX);
+ return StringUtil.isNotBlank(config) ? config : DEFAULT_DUBBO_CONSUMER_PREFIX;
+ }
+ return null;
+ }
+
+
+}
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilterTest.java b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilterTest.java
index 69b95c6d54..cb9da8c413 100644
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilterTest.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/AbstractDubboFilterTest.java
@@ -1,22 +1,42 @@
package com.alibaba.csp.sentinel.adapter.dubbo;
+import com.alibaba.csp.sentinel.adapter.dubbo.config.DubboConfig;
import com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService;
+import com.alibaba.csp.sentinel.config.SentinelConfig;
import com.alibaba.dubbo.rpc.Invocation;
import com.alibaba.dubbo.rpc.Invoker;
import com.alibaba.dubbo.rpc.Result;
import com.alibaba.dubbo.rpc.RpcException;
+import org.junit.After;
+import org.junit.Before;
import org.junit.Test;
import java.lang.reflect.Method;
-import static org.junit.Assert.*;
-import static org.mockito.Mockito.*;
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
/**
* @author cdfive
*/
public class AbstractDubboFilterTest {
+
+ @Before
+ public void setUp() {
+ SentinelConfig.setConfig("csp.sentinel.dubbo.resource.use.prefix", "true");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "");
+ }
+
+ @After
+ public void tearDown() {
+ SentinelConfig.setConfig("csp.sentinel.dubbo.resource.use.prefix", "false");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "");
+ }
+
private AbstractDubboFilter filter = new AbstractDubboFilter() {
@Override
public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
@@ -24,6 +44,7 @@ public Result invoke(Invoker invoker, Invocation invocation) throws RpcExcept
}
};
+
@Test
public void testGetResourceName() {
Invoker invoker = mock(Invoker.class);
@@ -38,4 +59,32 @@ public void testGetResourceName() {
assertEquals("com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
}
+
+ @Test
+ public void testGetResourceNameWithPrefix() {
+ Invoker invoker = mock(Invoker.class);
+ when(invoker.getInterface()).thenReturn(DemoService.class);
+
+ Invocation invocation = mock(Invocation.class);
+ Method method = DemoService.class.getMethods()[0];
+ when(invocation.getMethodName()).thenReturn(method.getName());
+ when(invocation.getParameterTypes()).thenReturn(method.getParameterTypes());
+
+ //test with default prefix
+ String resourceName = filter.getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
+ System.out.println("resourceName = " + resourceName);
+ assertEquals("dubbo:provider:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+ resourceName = filter.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ assertEquals("dubbo:consumer:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+
+
+ //test with custom prefix
+ SentinelConfig.setConfig(DubboConfig.DUBBO_PROVIDER_PREFIX, "my:dubbo:provider:");
+ SentinelConfig.setConfig(DubboConfig.DUBBO_CONSUMER_PREFIX, "my:dubbo:consumer:");
+ resourceName = filter.getResourceName(invoker, invocation, DubboConfig.getDubboProviderPrefix());
+ assertEquals("my:dubbo:provider:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+ resourceName = filter.getResourceName(invoker, invocation, DubboConfig.getDubboConsumerPrefix());
+ assertEquals("my:dubbo:consumer:com.alibaba.csp.sentinel.adapter.dubbo.provider.DemoService:sayHello(java.lang.String,int)", resourceName);
+
+ }
}
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
index a71b0d00fb..58de29d64f 100644
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboConsumerFilterTest.java
@@ -92,7 +92,7 @@ private void verifyInvocationStructure(Invoker invoker, Invocation invocation) {
DefaultNode entranceNode = context.getEntranceNode();
ResourceWrapper entranceResource = entranceNode.getId();
assertEquals(Constants.CONTEXT_DEFAULT_NAME, entranceResource.getName());
- assertSame(EntryType.IN, entranceResource.getType());
+ assertSame(EntryType.IN, entranceResource.getEntryType());
// As SphU.entry(interfaceName, EntryType.OUT);
Set childList = entranceNode.getChildList();
@@ -100,7 +100,7 @@ private void verifyInvocationStructure(Invoker invoker, Invocation invocation) {
DefaultNode interfaceNode = (DefaultNode) childList.iterator().next();
ResourceWrapper interfaceResource = interfaceNode.getId();
assertEquals(DemoService.class.getName(), interfaceResource.getName());
- assertSame(EntryType.OUT, interfaceResource.getType());
+ assertSame(EntryType.OUT, interfaceResource.getEntryType());
// As SphU.entry(resourceName, EntryType.OUT);
childList = interfaceNode.getChildList();
@@ -108,7 +108,7 @@ private void verifyInvocationStructure(Invoker invoker, Invocation invocation) {
DefaultNode methodNode = (DefaultNode) childList.iterator().next();
ResourceWrapper methodResource = methodNode.getId();
assertEquals(resourceName, methodResource.getName());
- assertSame(EntryType.OUT, methodResource.getType());
+ assertSame(EntryType.OUT, methodResource.getEntryType());
// Verify curEntry
Entry curEntry = context.getCurEntry();
diff --git a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
index 809a5c7159..8f1f850f2f 100644
--- a/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
+++ b/sentinel-adapter/sentinel-dubbo-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/dubbo/SentinelDubboProviderFilterTest.java
@@ -92,7 +92,7 @@ private void verifyInvocationStructure(String originApplication, Invoker invoker
DefaultNode entranceNode = context.getEntranceNode();
ResourceWrapper entranceResource = entranceNode.getId();
assertEquals(resourceName, entranceResource.getName());
- assertSame(EntryType.IN, entranceResource.getType());
+ assertSame(EntryType.IN, entranceResource.getEntryType());
// As SphU.entry(interfaceName, EntryType.IN);
Set childList = entranceNode.getChildList();
@@ -100,7 +100,7 @@ private void verifyInvocationStructure(String originApplication, Invoker invoker
DefaultNode interfaceNode = (DefaultNode) childList.iterator().next();
ResourceWrapper interfaceResource = interfaceNode.getId();
assertEquals(DemoService.class.getName(), interfaceResource.getName());
- assertSame(EntryType.IN, interfaceResource.getType());
+ assertSame(EntryType.IN, interfaceResource.getEntryType());
// As SphU.entry(resourceName, EntryType.IN, 1, invocation.getArguments());
childList = interfaceNode.getChildList();
@@ -108,7 +108,7 @@ private void verifyInvocationStructure(String originApplication, Invoker invoker
DefaultNode methodNode = (DefaultNode) childList.iterator().next();
ResourceWrapper methodResource = methodNode.getId();
assertEquals(resourceName, methodResource.getName());
- assertSame(EntryType.IN, methodResource.getType());
+ assertSame(EntryType.IN, methodResource.getEntryType());
// Verify curEntry
Entry curEntry = context.getCurEntry();
diff --git a/sentinel-adapter/sentinel-grpc-adapter/README.md b/sentinel-adapter/sentinel-grpc-adapter/README.md
index 38d60030b6..e3c3aa273a 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/README.md
+++ b/sentinel-adapter/sentinel-grpc-adapter/README.md
@@ -3,7 +3,6 @@
Sentinel gRPC Adapter provides client and server interceptor for gRPC services.
> Note that currently the interceptor only supports unary methods in gRPC.
-> In some circumstances (e.g. asynchronous call), the RT metrics might not be accurate.
## Client Interceptor
@@ -35,4 +34,3 @@ Server server = ServerBuilder.forPort(port)
.intercept(new SentinelGrpcServerInterceptor()) // Add the server interceptor.
.build();
```
-
diff --git a/sentinel-adapter/sentinel-grpc-adapter/pom.xml b/sentinel-adapter/sentinel-grpc-adapter/pom.xml
index 034b541987..7f4f9f1378 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-grpc-adapter/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
sentinel-grpc-adapter
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptor.java b/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptor.java
index 4e1686279c..20fe36b15a 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptor.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptor.java
@@ -15,28 +15,27 @@
*/
package com.alibaba.csp.sentinel.adapter.grpc;
-import javax.annotation.Nullable;
-
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
-import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.slots.block.BlockException;
-
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.ForwardingClientCall;
-import io.grpc.ForwardingClientCallListener.SimpleForwardingClientCallListener;
+import io.grpc.ForwardingClientCallListener;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.Status;
+import javax.annotation.Nullable;
+import java.util.concurrent.atomic.AtomicReference;
+
/**
* gRPC client interceptor for Sentinel. Currently it only works with unary methods.
- *
+ *
* Example code:
*
* public class ServiceClient {
@@ -52,50 +51,59 @@
*
* }
*
- *
+ *
* For server interceptor, see {@link SentinelGrpcServerInterceptor}.
*
* @author Eric Zhao
*/
public class SentinelGrpcClientInterceptor implements ClientInterceptor {
-
private static final Status FLOW_CONTROL_BLOCK = Status.UNAVAILABLE.withDescription(
- "Flow control limit exceeded (client side)");
+ "Flow control limit exceeded (client side)");
@Override
public ClientCall interceptCall(MethodDescriptor methodDescriptor,
CallOptions callOptions, Channel channel) {
- String resourceName = methodDescriptor.getFullMethodName();
+ String fullMethodName = methodDescriptor.getFullMethodName();
Entry entry = null;
try {
- entry = SphU.entry(resourceName, EntryType.OUT);
+ entry = SphU.asyncEntry(fullMethodName, EntryType.OUT);
+ final AtomicReference atomicReferenceEntry = new AtomicReference<>(entry);
// Allow access, forward the call.
return new ForwardingClientCall.SimpleForwardingClientCall(
- channel.newCall(methodDescriptor, callOptions)) {
+ channel.newCall(methodDescriptor, callOptions)) {
@Override
public void start(Listener responseListener, Metadata headers) {
- super.start(new SimpleForwardingClientCallListener(responseListener) {
- @Override
- public void onReady() {
- super.onReady();
- }
-
+ super.start(new ForwardingClientCallListener.SimpleForwardingClientCallListener(responseListener) {
@Override
public void onClose(Status status, Metadata trailers) {
- super.onClose(status, trailers);
- // Record the exception metrics.
- if (!status.isOk()) {
- recordException(status.asRuntimeException());
+ Entry entry = atomicReferenceEntry.get();
+ if (entry != null) {
+ // Record the exception metrics.
+ if (!status.isOk()) {
+ Tracer.traceEntry(status.asRuntimeException(), entry);
+ }
+ entry.exit();
+ atomicReferenceEntry.set(null);
}
+ super.onClose(status, trailers);
}
}, headers);
}
+ /**
+ * Some Exceptions will only call cancel.
+ */
@Override
public void cancel(@Nullable String message, @Nullable Throwable cause) {
+ Entry entry = atomicReferenceEntry.get();
+ // Some Exceptions will call onClose and cancel.
+ if (entry != null) {
+ // Record the exception metrics.
+ Tracer.traceEntry(cause, entry);
+ entry.exit();
+ atomicReferenceEntry.set(null);
+ }
super.cancel(message, cause);
- // Record the exception metrics.
- recordException(cause);
}
};
} catch (BlockException e) {
@@ -108,32 +116,27 @@ public void start(Listener responseListener, Metadata headers) {
@Override
public void request(int numMessages) {
-
}
@Override
public void cancel(@Nullable String message, @Nullable Throwable cause) {
-
}
@Override
public void halfClose() {
-
}
@Override
public void sendMessage(ReqT message) {
-
}
};
- } finally {
+ } catch (RuntimeException e) {
+ // Catch the RuntimeException newCall throws, entry is guaranteed to exit.
if (entry != null) {
+ Tracer.traceEntry(e, entry);
entry.exit();
}
+ throw e;
}
}
-
- private void recordException(Throwable t) {
- Tracer.trace(t);
- }
}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptor.java b/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptor.java
index 1e0d909019..ca1d558d36 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptor.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptor.java
@@ -19,21 +19,21 @@
import com.alibaba.csp.sentinel.EntryType;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
-import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.slots.block.BlockException;
-
import io.grpc.ForwardingServerCall;
import io.grpc.ForwardingServerCallListener;
import io.grpc.Metadata;
import io.grpc.ServerCall;
-import io.grpc.ServerCall.Listener;
import io.grpc.ServerCallHandler;
import io.grpc.ServerInterceptor;
import io.grpc.Status;
+import io.grpc.StatusRuntimeException;
+
+import java.util.concurrent.atomic.AtomicReference;
/**
* gRPC server interceptor for Sentinel. Currently it only works with unary methods.
- *
+ *
* Example code:
*
* Server server = ServerBuilder.forPort(port)
@@ -41,50 +41,69 @@
* .intercept(new SentinelGrpcServerInterceptor()) // Add the server interceptor.
* .build();
*
- *
+ *
* For client interceptor, see {@link SentinelGrpcClientInterceptor}.
*
* @author Eric Zhao
*/
public class SentinelGrpcServerInterceptor implements ServerInterceptor {
-
private static final Status FLOW_CONTROL_BLOCK = Status.UNAVAILABLE.withDescription(
- "Flow control limit exceeded (server side)");
+ "Flow control limit exceeded (server side)");
+ private static final StatusRuntimeException STATUS_RUNTIME_EXCEPTION = new StatusRuntimeException(Status.CANCELLED);
@Override
- public Listener interceptCall(ServerCall serverCall, Metadata metadata,
- ServerCallHandler serverCallHandler) {
- String resourceName = serverCall.getMethodDescriptor().getFullMethodName();
+ public ServerCall.Listener interceptCall(ServerCall call, Metadata headers, ServerCallHandler next) {
+ String fullMethodName = call.getMethodDescriptor().getFullMethodName();
// Remote address: serverCall.getAttributes().get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR);
Entry entry = null;
try {
- ContextUtil.enter(resourceName);
- entry = SphU.entry(resourceName, EntryType.IN);
+ entry = SphU.asyncEntry(fullMethodName, EntryType.IN);
+ final AtomicReference atomicReferenceEntry = new AtomicReference<>(entry);
// Allow access, forward the call.
return new ForwardingServerCallListener.SimpleForwardingServerCallListener(
- serverCallHandler.startCall(
- new ForwardingServerCall.SimpleForwardingServerCall(serverCall) {
- @Override
- public void close(Status status, Metadata trailers) {
- super.close(status, trailers);
- // Record the exception metrics.
- if (!status.isOk()) {
- recordException(status.asRuntimeException());
- }
- }
- }, metadata)) {};
+ next.startCall(
+ new ForwardingServerCall.SimpleForwardingServerCall(call) {
+ @Override
+ public void close(Status status, Metadata trailers) {
+ Entry entry = atomicReferenceEntry.get();
+ if (entry != null) {
+ // Record the exception metrics.
+ if (!status.isOk()) {
+ Tracer.traceEntry(status.asRuntimeException(), entry);
+ }
+ //entry exit when the call be closed
+ entry.exit();
+ }
+ super.close(status, trailers);
+ }
+ }, headers)) {
+ /**
+ * If call was canceled, onCancel will be called. and the close will not be called
+ * so the server is encouraged to abort processing to save resources by onCancel
+ * @see ServerCall.Listener#onCancel()
+ */
+ @Override
+ public void onCancel() {
+ Entry entry = atomicReferenceEntry.get();
+ if (entry != null) {
+ Tracer.traceEntry(STATUS_RUNTIME_EXCEPTION, entry);
+ entry.exit();
+ atomicReferenceEntry.set(null);
+ }
+ super.onCancel();
+ }
+ };
} catch (BlockException e) {
- serverCall.close(FLOW_CONTROL_BLOCK, new Metadata());
- return new ServerCall.Listener() {};
- } finally {
+ call.close(FLOW_CONTROL_BLOCK, new Metadata());
+ return new ServerCall.Listener() {
+ };
+ } catch (RuntimeException e) {
+ // Catch the RuntimeException startCall throws, entry is guaranteed to exit.
if (entry != null) {
+ Tracer.traceEntry(e, entry);
entry.exit();
}
- ContextUtil.exit();
+ throw e;
}
}
-
- private void recordException(Throwable t) {
- Tracer.trace(t);
- }
}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceClient.java b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceClient.java
index dab36678c9..2aaefae957 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceClient.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceClient.java
@@ -15,38 +15,36 @@
*/
package com.alibaba.csp.sentinel.adapter.grpc;
-import java.util.concurrent.TimeUnit;
-
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooRequest;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooResponse;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooServiceGrpc;
-
import io.grpc.ClientInterceptor;
import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
+import java.util.concurrent.TimeUnit;
+
/**
* A simple wrapped gRPC client for FooService.
*
* @author Eric Zhao
*/
final class FooServiceClient {
-
private final ManagedChannel channel;
private final FooServiceGrpc.FooServiceBlockingStub blockingStub;
FooServiceClient(String host, int port) {
this.channel = ManagedChannelBuilder.forAddress(host, port)
- .usePlaintext()
- .build();
+ .usePlaintext()
+ .build();
this.blockingStub = FooServiceGrpc.newBlockingStub(this.channel);
}
FooServiceClient(String host, int port, ClientInterceptor interceptor) {
this.channel = ManagedChannelBuilder.forAddress(host, port)
- .usePlaintext()
- .intercept(interceptor)
- .build();
+ .usePlaintext()
+ .intercept(interceptor)
+ .build();
this.blockingStub = FooServiceGrpc.newBlockingStub(this.channel);
}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceImpl.java b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceImpl.java
index adda5102da..298ec44fe1 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceImpl.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/FooServiceImpl.java
@@ -18,27 +18,59 @@
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooRequest;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooResponse;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooServiceGrpc;
-
import io.grpc.stub.StreamObserver;
/**
* Implementation of FooService defined in proto.
*/
class FooServiceImpl extends FooServiceGrpc.FooServiceImplBase {
-
@Override
public void sayHello(FooRequest request, StreamObserver responseObserver) {
- String message = String.format("Hello %s! Your ID is %d.", request.getName(), request.getId());
- FooResponse response = FooResponse.newBuilder().setMessage(message).build();
- responseObserver.onNext(response);
- responseObserver.onCompleted();
+ int id = request.getId();
+ switch (id) {
+ // Exception test
+ case -1:
+ responseObserver.onError(new IllegalAccessException("The id is error!"));
+ break;
+ // RT test
+ case -2:
+ try {
+ Thread.sleep(1000);
+ } catch (InterruptedException e) {
+ responseObserver.onError(e);
+ break;
+ }
+ default:
+ String message = String.format("Hello %s! Your ID is %d.", request.getName(), id);
+ FooResponse response = FooResponse.newBuilder().setMessage(message).build();
+ responseObserver.onNext(response);
+ responseObserver.onCompleted();
+ break;
+ }
}
@Override
public void anotherHello(FooRequest request, StreamObserver responseObserver) {
- String message = String.format("Good day, %s (%d)", request.getName(), request.getId());
- FooResponse response = FooResponse.newBuilder().setMessage(message).build();
- responseObserver.onNext(response);
- responseObserver.onCompleted();
+ int id = request.getId();
+ switch (id) {
+ // Exception test
+ case -1:
+ responseObserver.onError(new IllegalAccessException("The id is error!"));
+ break;
+ // RT test
+ case -2:
+ try {
+ Thread.sleep(1000);
+ } catch (InterruptedException e) {
+ responseObserver.onError(e);
+ break;
+ }
+ default:
+ String message = String.format("Good day, %s (%d)", request.getName(), id);
+ FooResponse response = FooResponse.newBuilder().setMessage(message).build();
+ responseObserver.onNext(response);
+ responseObserver.onCompleted();
+ break;
+ }
}
}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/GrpcTestServer.java b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/GrpcTestServer.java
index f46c5718a1..86fe011518 100644
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/GrpcTestServer.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/GrpcTestServer.java
@@ -19,6 +19,7 @@
import io.grpc.ServerBuilder;
import java.io.IOException;
+import java.util.concurrent.Executors;
class GrpcTestServer {
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptorTest.java b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptorTest.java
index e61dd7605c..9b43416884 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptorTest.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcClientInterceptorTest.java
@@ -15,8 +15,6 @@
*/
package com.alibaba.csp.sentinel.adapter.grpc;
-import java.util.Collections;
-
import com.alibaba.csp.sentinel.EntryType;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooRequest;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooResponse;
@@ -25,12 +23,17 @@
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import com.alibaba.csp.sentinel.slots.clusterbuilder.ClusterBuilderSlot;
-
import io.grpc.StatusRuntimeException;
import org.junit.After;
+import org.junit.Before;
import org.junit.Test;
-import static org.junit.Assert.*;
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
/**
* Test cases for {@link SentinelGrpcClientInterceptor}.
@@ -38,48 +41,52 @@
* @author Eric Zhao
*/
public class SentinelGrpcClientInterceptorTest {
-
- private final String resourceName = "com.alibaba.sentinel.examples.FooService/sayHello";
- private final int threshold = 2;
+ private final String fullMethodName = "com.alibaba.sentinel.examples.FooService/sayHello";
private final GrpcTestServer server = new GrpcTestServer();
+ private FooServiceClient client;
private void configureFlowRule(int count) {
FlowRule rule = new FlowRule()
- .setCount(count)
- .setGrade(RuleConstant.FLOW_GRADE_QPS)
- .setResource(resourceName)
- .setLimitApp("default")
- .as(FlowRule.class);
+ .setCount(count)
+ .setGrade(RuleConstant.FLOW_GRADE_QPS)
+ .setResource(fullMethodName)
+ .setLimitApp("default")
+ .as(FlowRule.class);
FlowRuleManager.loadRules(Collections.singletonList(rule));
}
@Test
public void testGrpcClientInterceptor() throws Exception {
final int port = 19328;
-
- configureFlowRule(threshold);
server.start(port, false);
+ client = new FooServiceClient("localhost", port, new SentinelGrpcClientInterceptor());
- FooServiceClient client = new FooServiceClient("localhost", port, new SentinelGrpcClientInterceptor());
-
- assertTrue(sendRequest(client));
- ClusterNode clusterNode = ClusterBuilderSlot.getClusterNode(resourceName, EntryType.OUT);
+ configureFlowRule(Integer.MAX_VALUE);
+ assertTrue(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(666).build()));
+ ClusterNode clusterNode = ClusterBuilderSlot.getClusterNode(fullMethodName, EntryType.OUT);
assertNotNull(clusterNode);
- assertEquals(1, clusterNode.totalRequest() - clusterNode.blockRequest());
+ assertEquals(1, clusterNode.totalPass());
// Not allowed to pass.
configureFlowRule(0);
-
// The second request will be blocked.
- assertFalse(sendRequest(client));
+ assertFalse(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(666).build()));
assertEquals(1, clusterNode.blockRequest());
+ configureFlowRule(Integer.MAX_VALUE);
+ assertFalse(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(-1).build()));
+ assertEquals(1, clusterNode.totalException());
+
+ configureFlowRule(Integer.MAX_VALUE);
+ assertTrue(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(-2).build()));
+ assertTrue(clusterNode.avgRt() >= 1000);
+
server.stop();
}
- private boolean sendRequest(FooServiceClient client) {
+ private boolean sendRequest(FooRequest request) {
try {
- FooResponse response = client.sayHello(FooRequest.newBuilder().setName("Sentinel").setId(666).build());
+ FooResponse response = client.sayHello(request);
System.out.println("Response: " + response);
return true;
} catch (StatusRuntimeException ex) {
@@ -88,9 +95,15 @@ private boolean sendRequest(FooServiceClient client) {
}
}
+ @Before
+ public void cleanUpBefore() {
+ FlowRuleManager.loadRules(null);
+ ClusterBuilderSlot.getClusterNodeMap().clear();
+ }
+
@After
- public void cleanUp() {
+ public void cleanUpAfter() {
FlowRuleManager.loadRules(null);
ClusterBuilderSlot.getClusterNodeMap().clear();
}
-}
\ No newline at end of file
+}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptorTest.java b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptorTest.java
index 004a256357..ceef04fafd 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptorTest.java
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/grpc/SentinelGrpcServerInterceptorTest.java
@@ -15,8 +15,6 @@
*/
package com.alibaba.csp.sentinel.adapter.grpc;
-import java.util.Collections;
-
import com.alibaba.csp.sentinel.EntryType;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooRequest;
import com.alibaba.csp.sentinel.adapter.grpc.gen.FooResponse;
@@ -25,12 +23,17 @@
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import com.alibaba.csp.sentinel.slots.clusterbuilder.ClusterBuilderSlot;
-
import io.grpc.StatusRuntimeException;
import org.junit.After;
+import org.junit.Before;
import org.junit.Test;
-import static org.junit.Assert.*;
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
/**
* Test cases for {@link SentinelGrpcServerInterceptor}.
@@ -38,49 +41,52 @@
* @author Eric Zhao
*/
public class SentinelGrpcServerInterceptorTest {
-
private final String resourceName = "com.alibaba.sentinel.examples.FooService/anotherHello";
- private final int threshold = 4;
private final GrpcTestServer server = new GrpcTestServer();
-
private FooServiceClient client;
private void configureFlowRule(int count) {
FlowRule rule = new FlowRule()
- .setCount(count)
- .setGrade(RuleConstant.FLOW_GRADE_QPS)
- .setResource(resourceName)
- .setLimitApp("default")
- .as(FlowRule.class);
+ .setCount(count)
+ .setGrade(RuleConstant.FLOW_GRADE_QPS)
+ .setResource(resourceName)
+ .setLimitApp("default")
+ .as(FlowRule.class);
FlowRuleManager.loadRules(Collections.singletonList(rule));
}
@Test
public void testGrpcServerInterceptor() throws Exception {
final int port = 19329;
- client = new FooServiceClient("localhost", port);
-
- configureFlowRule(threshold);
server.start(port, true);
+ client = new FooServiceClient("localhost", port);
- assertTrue(sendRequest());
+ configureFlowRule(Integer.MAX_VALUE);
+ assertTrue(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(666).build()));
ClusterNode clusterNode = ClusterBuilderSlot.getClusterNode(resourceName, EntryType.IN);
assertNotNull(clusterNode);
- assertEquals(1, clusterNode.totalRequest() - clusterNode.blockRequest());
+ assertEquals(1, clusterNode.totalPass());
// Not allowed to pass.
configureFlowRule(0);
-
// The second request will be blocked.
- assertFalse(sendRequest());
+ assertFalse(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(666).build()));
assertEquals(1, clusterNode.blockRequest());
+ configureFlowRule(Integer.MAX_VALUE);
+ assertFalse(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(-1).build()));
+ assertEquals(1, clusterNode.totalException());
+
+ configureFlowRule(Integer.MAX_VALUE);
+ assertTrue(sendRequest(FooRequest.newBuilder().setName("Sentinel").setId(-2).build()));
+ assertTrue(clusterNode.avgRt() >= 1000);
+
server.stop();
}
- private boolean sendRequest() {
+ private boolean sendRequest(FooRequest request) {
try {
- FooResponse response = client.anotherHello(FooRequest.newBuilder().setName("Sentinel").setId(666).build());
+ FooResponse response = client.anotherHello(request);
System.out.println("Response: " + response);
return true;
} catch (StatusRuntimeException ex) {
@@ -89,10 +95,15 @@ private boolean sendRequest() {
}
}
+ @Before
+ public void cleanUpBefore() {
+ FlowRuleManager.loadRules(null);
+ ClusterBuilderSlot.getClusterNodeMap().clear();
+ }
@After
- public void cleanUp() {
+ public void cleanUpAfter() {
FlowRuleManager.loadRules(null);
ClusterBuilderSlot.getClusterNodeMap().clear();
}
-}
\ No newline at end of file
+}
diff --git a/sentinel-adapter/sentinel-grpc-adapter/src/test/proto/example.proto b/sentinel-adapter/sentinel-grpc-adapter/src/test/proto/example.proto
index 61858510b6..daf70e3c19 100755
--- a/sentinel-adapter/sentinel-grpc-adapter/src/test/proto/example.proto
+++ b/sentinel-adapter/sentinel-grpc-adapter/src/test/proto/example.proto
@@ -18,6 +18,5 @@ message FooResponse {
// Example service definition.
service FooService {
rpc sayHello(FooRequest) returns (FooResponse) {}
-
rpc anotherHello(FooRequest) returns (FooResponse) {}
-}
\ No newline at end of file
+}
diff --git a/sentinel-adapter/sentinel-reactor-adapter/pom.xml b/sentinel-adapter/sentinel-reactor-adapter/pom.xml
index 2e483c8933..c02c5c5e8b 100644
--- a/sentinel-adapter/sentinel-reactor-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-reactor-adapter/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
diff --git a/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/EntryConfig.java b/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/EntryConfig.java
index be677d532a..2113d6d231 100644
--- a/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/EntryConfig.java
+++ b/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/EntryConfig.java
@@ -18,6 +18,7 @@
import java.util.Arrays;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.util.AssertUtil;
/**
@@ -28,6 +29,8 @@ public class EntryConfig {
private final String resourceName;
private final EntryType entryType;
+ private final int resourceType;
+
private final int acquireCount;
private final Object[] args;
private final ContextConfig contextConfig;
@@ -44,17 +47,31 @@ public EntryConfig(String resourceName, EntryType entryType, ContextConfig conte
this(resourceName, entryType, 1, new Object[0], contextConfig);
}
+ public EntryConfig(String resourceName, int resourceType, EntryType entryType, ContextConfig contextConfig) {
+ this(resourceName, resourceType, entryType, 1, new Object[0], contextConfig);
+ }
+
public EntryConfig(String resourceName, EntryType entryType, int acquireCount, Object[] args) {
this(resourceName, entryType, acquireCount, args, null);
}
public EntryConfig(String resourceName, EntryType entryType, int acquireCount, Object[] args,
ContextConfig contextConfig) {
+ this(resourceName, ResourceTypeConstants.COMMON, entryType, acquireCount, args, contextConfig);
+ }
+
+ public EntryConfig(String resourceName, int resourceType, EntryType entryType, int acquireCount, Object[] args) {
+ this(resourceName, resourceType, entryType, acquireCount, args, null);
+ }
+
+ public EntryConfig(String resourceName, int resourceType, EntryType entryType, int acquireCount, Object[] args,
+ ContextConfig contextConfig) {
AssertUtil.assertNotBlank(resourceName, "resourceName cannot be blank");
AssertUtil.notNull(entryType, "entryType cannot be null");
AssertUtil.isTrue(acquireCount > 0, "acquireCount should be positive");
this.resourceName = resourceName;
this.entryType = entryType;
+ this.resourceType = resourceType;
this.acquireCount = acquireCount;
this.args = args;
// Constructed ContextConfig should be valid here. Null is allowed here.
@@ -81,11 +98,19 @@ public ContextConfig getContextConfig() {
return contextConfig;
}
+ /**
+ * @since 1.7.0
+ */
+ public int getResourceType() {
+ return resourceType;
+ }
+
@Override
public String toString() {
return "EntryConfig{" +
"resourceName='" + resourceName + '\'' +
", entryType=" + entryType +
+ ", resourceType=" + resourceType +
", acquireCount=" + acquireCount +
", args=" + Arrays.toString(args) +
", contextConfig=" + contextConfig +
diff --git a/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/SentinelReactorSubscriber.java b/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/SentinelReactorSubscriber.java
index 3a3be77404..00a4418850 100644
--- a/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/SentinelReactorSubscriber.java
+++ b/sentinel-adapter/sentinel-reactor-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/reactor/SentinelReactorSubscriber.java
@@ -89,8 +89,8 @@ private void entryWhenSubscribed() {
ContextUtil.enter(sentinelContextConfig.getContextName(), sentinelContextConfig.getOrigin());
}
try {
- AsyncEntry entry = SphU.asyncEntry(entryConfig.getResourceName(), entryConfig.getEntryType(),
- entryConfig.getAcquireCount(), entryConfig.getArgs());
+ AsyncEntry entry = SphU.asyncEntry(entryConfig.getResourceName(), entryConfig.getResourceType(),
+ entryConfig.getEntryType(), entryConfig.getAcquireCount(), entryConfig.getArgs());
this.currentEntry = entry;
actual.onSubscribe(this);
} catch (BlockException ex) {
@@ -155,7 +155,7 @@ protected void hookOnError(Throwable t) {
@Override
protected void hookOnCancel() {
-
+ tryCompleteEntry();
}
private boolean tryCompleteEntry() {
diff --git a/sentinel-adapter/sentinel-reactor-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/reactor/MonoSentinelOperatorIntegrationTest.java b/sentinel-adapter/sentinel-reactor-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/reactor/MonoSentinelOperatorIntegrationTest.java
index e682723a92..ba867839cd 100644
--- a/sentinel-adapter/sentinel-reactor-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/reactor/MonoSentinelOperatorIntegrationTest.java
+++ b/sentinel-adapter/sentinel-reactor-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/reactor/MonoSentinelOperatorIntegrationTest.java
@@ -162,6 +162,28 @@ public void testEmitSingleError() {
assertEquals(1, cn.totalException());
}
+ @Test
+ public void testMultipleReactorTransformerLatterFlowControl() {
+ String resourceName1 = createResourceName("testMultipleReactorTransformerLatterFlowControl1");
+ String resourceName2 = createResourceName("testMultipleReactorTransformerLatterFlowControl2");
+ FlowRuleManager.loadRules(Collections.singletonList(
+ new FlowRule(resourceName2).setCount(0)
+ ));
+ StepVerifier.create(Mono.just(2)
+ .transform(new SentinelReactorTransformer<>(resourceName1))
+ .transform(new SentinelReactorTransformer<>(resourceName2)))
+ .expectError(BlockException.class)
+ .verify();
+
+ ClusterNode cn1 = ClusterBuilderSlot.getClusterNode(resourceName1);
+ assertNotNull(cn1);
+ ClusterNode cn2 = ClusterBuilderSlot.getClusterNode(resourceName2);
+ assertNotNull(cn2);
+ assertEquals(1, cn2.blockRequest());
+ assertEquals(1, cn1.totalSuccess());
+ FlowRuleManager.loadRules(new ArrayList<>());
+ }
+
private String createResourceName(String resourceName) {
return "reactor_test_mono_" + resourceName;
}
diff --git a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/pom.xml b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/pom.xml
index b221cc7b99..6c3b13128f 100644
--- a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
diff --git a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilter.java b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilter.java
index dbe9c13089..3dfbaa5a41 100644
--- a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilter.java
+++ b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilter.java
@@ -20,6 +20,7 @@
import java.util.stream.Collectors;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
import com.alibaba.csp.sentinel.adapter.gateway.common.param.GatewayParamParser;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
@@ -34,6 +35,7 @@
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
+import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@@ -41,7 +43,17 @@
* @author Eric Zhao
* @since 1.6.0
*/
-public class SentinelGatewayFilter implements GatewayFilter, GlobalFilter {
+public class SentinelGatewayFilter implements GatewayFilter, GlobalFilter, Ordered {
+
+ private final int order;
+
+ public SentinelGatewayFilter() {
+ this(Ordered.HIGHEST_PRECEDENCE);
+ }
+
+ public SentinelGatewayFilter(int order) {
+ this.order = order;
+ }
private final GatewayParamParser paramParser = new GatewayParamParser<>(
new ServerWebExchangeItemParser());
@@ -59,8 +71,8 @@ public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
.map(f -> f.apply(exchange))
.orElse("");
asyncResult = asyncResult.transform(
- new SentinelReactorTransformer<>(new EntryConfig(routeId, EntryType.IN,
- 1, params, new ContextConfig(contextName(routeId), origin)))
+ new SentinelReactorTransformer<>(new EntryConfig(routeId, ResourceTypeConstants.COMMON_API_GATEWAY,
+ EntryType.IN, 1, params, new ContextConfig(contextName(routeId), origin)))
);
}
@@ -69,7 +81,8 @@ public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
Object[] params = paramParser.parseParameterFor(apiName, exchange,
r -> r.getResourceMode() == SentinelGatewayConstants.RESOURCE_MODE_CUSTOM_API_NAME);
asyncResult = asyncResult.transform(
- new SentinelReactorTransformer<>(new EntryConfig(apiName, EntryType.IN, 1, params))
+ new SentinelReactorTransformer<>(new EntryConfig(apiName, ResourceTypeConstants.COMMON_API_GATEWAY,
+ EntryType.IN, 1, params))
);
}
@@ -87,4 +100,9 @@ Set pickMatchingApiDefinitions(ServerWebExchange exchange) {
.map(WebExchangeApiMatcher::getApiName)
.collect(Collectors.toSet());
}
+
+ @Override
+ public int getOrder() {
+ return order;
+ }
}
diff --git a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/ServerWebExchangeItemParser.java b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/ServerWebExchangeItemParser.java
index 6088cd2d7e..fcf00ecb3e 100644
--- a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/ServerWebExchangeItemParser.java
+++ b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/ServerWebExchangeItemParser.java
@@ -16,9 +16,11 @@
package com.alibaba.csp.sentinel.adapter.gateway.sc;
import java.net.InetSocketAddress;
+import java.util.Optional;
import com.alibaba.csp.sentinel.adapter.gateway.common.param.RequestItemParser;
+import org.springframework.http.HttpCookie;
import org.springframework.web.server.ServerWebExchange;
/**
@@ -50,4 +52,11 @@ public String getHeader(ServerWebExchange exchange, String key) {
public String getUrlParam(ServerWebExchange exchange, String paramName) {
return exchange.getRequest().getQueryParams().getFirst(paramName);
}
+
+ @Override
+ public String getCookieValue(ServerWebExchange exchange, String cookieName) {
+ return Optional.ofNullable(exchange.getResponse().getCookies().getFirst(cookieName))
+ .map(HttpCookie::getValue)
+ .orElse(null);
+ }
}
diff --git a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/api/matcher/WebExchangeApiMatcher.java b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/api/matcher/WebExchangeApiMatcher.java
index 7abae52b62..3a671c489c 100644
--- a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/api/matcher/WebExchangeApiMatcher.java
+++ b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/sc/api/matcher/WebExchangeApiMatcher.java
@@ -59,9 +59,9 @@ private Optional> fromApiPathPredicate(/*@Valid*/ A
return Optional.empty();
}
switch (item.getMatchStrategy()) {
- case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX:
+ case SentinelGatewayConstants.URL_MATCH_STRATEGY_REGEX:
return Optional.of(RouteMatchers.regexPath(pattern));
- case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX:
+ case SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX:
return Optional.of(RouteMatchers.antPath(pattern));
default:
return Optional.of(RouteMatchers.exactPath(pattern));
diff --git a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilterTest.java b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilterTest.java
index 078bfec6e4..1bf86ea021 100644
--- a/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilterTest.java
+++ b/sentinel-adapter/sentinel-spring-cloud-gateway-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/gateway/sc/SentinelGatewayFilterTest.java
@@ -44,14 +44,14 @@ public void testPickMatchingApiDefinitions() {
ApiDefinition api1 = new ApiDefinition(apiName1)
.setPredicateItems(Collections.singleton(
new ApiPathPredicateItem().setPattern("/product/**")
- .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX)
+ .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX)
));
String apiName2 = "another_customized_api";
ApiDefinition api2 = new ApiDefinition(apiName2)
.setPredicateItems(new HashSet() {{
add(new ApiPathPredicateItem().setPattern("/something"));
add(new ApiPathPredicateItem().setPattern("/other/**")
- .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX));
+ .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
}});
apiDefinitions.add(api1);
apiDefinitions.add(api2);
diff --git a/sentinel-adapter/sentinel-spring-webflux-adapter/README.md b/sentinel-adapter/sentinel-spring-webflux-adapter/README.md
index ed47f5d7c8..158937fe93 100644
--- a/sentinel-adapter/sentinel-spring-webflux-adapter/README.md
+++ b/sentinel-adapter/sentinel-spring-webflux-adapter/README.md
@@ -50,7 +50,7 @@ public class WebFluxConfig {
You can register various customized callback in `WebFluxCallbackManager`:
- `setBlockHandler`: register a customized `BlockRequestHandler` to handle the blocked request. The default implementation is `DefaultBlockRequestHandler`, which returns default message like `Blocked by Sentinel: FlowException`.
-- `setUrlCleaner`: used for normalization of URL. The function type is `(ServerWebExchange, String) → String`, which means `(webExchange, originalUrl) → finalUrl`.
+- `setUrlCleaner`: used for normalization of URL. The function type is `(ServerWebExchange, String) → String`, which means `(webExchange, originalUrl) → finalUrl`, if the finalUrl is `"""` or `null`, the URLs will be excluded (since Sentinel 1.7.0)..
- `setRequestOriginParser`: used to resolve the origin from the HTTP request. The function type is `ServerWebExchange → String`.
You can also refer to the demo: [sentinel-demo-spring-webflux](https://github.com/alibaba/Sentinel/tree/master/sentinel-demo/sentinel-demo-spring-webflux).
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-spring-webflux-adapter/pom.xml b/sentinel-adapter/sentinel-spring-webflux-adapter/pom.xml
index 3c8a8d12e0..c940192811 100644
--- a/sentinel-adapter/sentinel-spring-webflux-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-spring-webflux-adapter/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
diff --git a/sentinel-adapter/sentinel-spring-webflux-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxFilter.java b/sentinel-adapter/sentinel-spring-webflux-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxFilter.java
index b83767d2ed..7d9cbf2860 100644
--- a/sentinel-adapter/sentinel-spring-webflux-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxFilter.java
+++ b/sentinel-adapter/sentinel-spring-webflux-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxFilter.java
@@ -18,10 +18,12 @@
import java.util.Optional;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.adapter.reactor.ContextConfig;
import com.alibaba.csp.sentinel.adapter.reactor.EntryConfig;
import com.alibaba.csp.sentinel.adapter.reactor.SentinelReactorTransformer;
import com.alibaba.csp.sentinel.adapter.spring.webflux.callback.WebFluxCallbackManager;
+import com.alibaba.csp.sentinel.util.StringUtil;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebFilter;
@@ -36,24 +38,25 @@ public class SentinelWebFluxFilter implements WebFilter {
@Override
public Mono filter(ServerWebExchange exchange, WebFilterChain chain) {
- return chain.filter(exchange)
- .transform(buildSentinelTransformer(exchange));
- }
-
- private SentinelReactorTransformer buildSentinelTransformer(ServerWebExchange exchange) {
// Maybe we can get the URL pattern elsewhere via:
// exchange.getAttributeOrDefault(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE, path)
-
String path = exchange.getRequest().getPath().value();
- String finalPath = Optional.ofNullable(WebFluxCallbackManager.getUrlCleaner())
- .map(f -> f.apply(exchange, path))
- .orElse(path);
+
+ String finalPath = WebFluxCallbackManager.getUrlCleaner().apply(exchange, path);
+ if (StringUtil.isEmpty(finalPath)) {
+ return chain.filter(exchange);
+ }
+ return chain.filter(exchange)
+ .transform(buildSentinelTransformer(exchange, finalPath));
+ }
+
+ private SentinelReactorTransformer buildSentinelTransformer(ServerWebExchange exchange, String finalPath) {
String origin = Optional.ofNullable(WebFluxCallbackManager.getRequestOriginParser())
.map(f -> f.apply(exchange))
.orElse(EMPTY_ORIGIN);
- return new SentinelReactorTransformer<>(
- new EntryConfig(finalPath, EntryType.IN, new ContextConfig(finalPath, origin)));
+ return new SentinelReactorTransformer<>(new EntryConfig(finalPath, ResourceTypeConstants.COMMON_WEB,
+ EntryType.IN, new ContextConfig(finalPath, origin)));
}
private static final String EMPTY_ORIGIN = "";
diff --git a/sentinel-adapter/sentinel-spring-webflux-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxIntegrationTest.java b/sentinel-adapter/sentinel-spring-webflux-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxIntegrationTest.java
index 91d7b923fd..2e0ec9e46d 100644
--- a/sentinel-adapter/sentinel-spring-webflux-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxIntegrationTest.java
+++ b/sentinel-adapter/sentinel-spring-webflux-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webflux/SentinelWebFluxIntegrationTest.java
@@ -101,6 +101,26 @@ public void testCustomizedUrlCleaner() throws Exception {
WebFluxCallbackManager.resetUrlCleaner();
}
+ @Test
+ public void testCustomizedIgnoreUrlCleaner() throws Exception {
+ final String fooPrefix = "/foo/";
+ String url1 = fooPrefix + 1;
+ WebFluxCallbackManager.setUrlCleaner(((exchange, originUrl) -> {
+ if (originUrl.startsWith(fooPrefix)) {
+ return "";
+ }
+ return originUrl;
+ }));
+ this.webClient.get()
+ .uri(url1)
+ .exchange()
+ .expectStatus().isOk()
+ .expectBody(String.class).isEqualTo("Hello 1");
+
+ assertNull(ClusterBuilderSlot.getClusterNode(url1));
+ WebFluxCallbackManager.resetUrlCleaner();
+ }
+
@Test
public void testCustomizedBlockRequestHandler() throws Exception {
String url = "/error";
@@ -166,4 +186,4 @@ public void cleanUp() {
FlowRuleManager.loadRules(new ArrayList<>());
ClusterBuilderSlot.resetClusterNodes();
}
-}
\ No newline at end of file
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/README.md b/sentinel-adapter/sentinel-spring-webmvc-adapter/README.md
new file mode 100755
index 0000000000..941daed42e
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/README.md
@@ -0,0 +1,106 @@
+# Sentinel Spring MVC Adapter
+
+## Introduction
+
+Sentinel provides integration for Spring Web to enable flow control for web requests.
+
+Add the following dependency in `pom.xml` (if you are using Maven):
+
+```xml
+
+ com.alibaba.csp
+ sentinel-spring-webmvc-adapter
+ x.y.z
+
+```
+
+Then we could add a configuration bean to configure the interceptor:
+
+```java
+@Configuration
+public class InterceptorConfig implements WebMvcConfigurer {
+
+ @Override
+ public void addInterceptors(InterceptorRegistry registry) {
+ SentinelWebMvcConfig config = new SentinelWebMvcConfig();
+ // Enable the HTTP method prefix.
+ config.setHttpMethodSpecify(true);
+ // Add to the interceptor list.
+ registry.addInterceptor(new SentinelWebInterceptor(config)).addPathPatterns("/**");
+ }
+}
+```
+
+Then Sentinel will extract URL patterns defined in Web Controller as the web resource (e.g. `/foo/{id}`).
+
+## Configuration
+
+### Block handling
+
+Sentinel Spring Web adapter provides a `BlockExceptionHandler` interface to handle the blocked requests.
+We could set the handler via `SentinelWebMvcTotalConfig#setBlockExceptionHandler()` method.
+
+By default the interceptor will throw out the `BlockException`.
+We need to set a global exception handler function in Spring to handle it. An example:
+
+```java
+@ControllerAdvice
+@Order(0)
+public class SentinelBlockExceptionHandlerConfig {
+ private Logger logger = LoggerFactory.getLogger(this.getClass());
+
+ @ExceptionHandler(BlockException.class)
+ @ResponseBody
+ public String sentinelBlockHandler(BlockException e) {
+ AbstractRule rule = e.getRule();
+ logger.info("Blocked by Sentinel: {}", rule.toString());
+ return "Blocked by Sentinel";
+ }
+}
+```
+
+We've provided a `DefaultBlockExceptionHandler`. When a request is blocked, the handler will return a default page
+indicating the request is rejected (`Blocked by Sentinel (flow limiting)`).
+The HTTP status code of the default block page is **429 (Too Many Requests)**.
+
+We could also implement our implementation of the `BlockExceptionHandler` interface and
+set to the config object. An example:
+
+```java
+SentinelWebMvcConfig config = new SentinelWebMvcConfig();
+config.setBlockExceptionHandler((request, response, e) -> {
+ String resourceName = e.getRule().getResource();
+ // Depending on your situation, you can choose to process or throw
+ if ("/hello".equals(resourceName)) {
+ // Do something ......
+ response.getWriter().write("Blocked by Sentinel");
+ } else {
+ // Handle it in global exception handling
+ throw e;
+ }
+});
+```
+
+### Customized configuration
+
+- Common configuration in `SentinelWebMvcConfig` and `SentinelWebMvcTotalConfig`:
+
+| name | description | type | default value |
+|------|------------|------|-------|
+| `blockExceptionHandler`| The handler that handles the block request | `BlockExceptionHandler` | null (throw out the BlockException) |
+| `originParser` | Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request | `RequestOriginParser` | - |
+
+- `SentinelWebMvcConfig` configuration:
+
+| name | description | type | default value |
+|------|------------|------|-------|
+| urlCleaner | The `UrlCleaner` interface is designed for clean and unify the URL resource. | `UrlCleaner` | - |
+| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_entry_attr` |
+| httpMethodSpecify | Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`). | `boolean` | `false` |
+
+- `SentinelWebMvcTotalConfig` configuration:
+
+| name | description | type | default value |
+|------|------------|------|-------|
+| totalResourceName | The resource name in `SentinelTotalInterceptor` | `String` | `spring-mvc-total-url-request` |
+| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_total_entry_attr` |
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/pom.xml b/sentinel-adapter/sentinel-spring-webmvc-adapter/pom.xml
new file mode 100644
index 0000000000..b74d2cc475
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/pom.xml
@@ -0,0 +1,56 @@
+
+
+
+ com.alibaba.csp
+ sentinel-adapter
+ 1.7.2-SNAPSHOT
+
+ 4.0.0
+
+ sentinel-spring-webmvc-adapter
+ jar
+
+
+ 5.1.8.RELEASE
+ 2.1.3.RELEASE
+ 3.1.0
+
+
+
+
+ com.alibaba.csp
+ sentinel-core
+
+
+ javax.servlet
+ javax.servlet-api
+ ${servlet.api.version}
+ provided
+
+
+ org.springframework
+ spring-webmvc
+ ${spring.version}
+ provided
+
+
+ org.springframework.boot
+ spring-boot-starter-web
+ ${spring.boot.version}
+ test
+
+
+ org.springframework.boot
+ spring-boot-starter-test
+ ${spring.boot.version}
+ test
+
+
+ com.alibaba
+ fastjson
+ test
+
+
+
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/AbstractSentinelInterceptor.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/AbstractSentinelInterceptor.java
new file mode 100644
index 0000000000..e9f0a39ee6
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/AbstractSentinelInterceptor.java
@@ -0,0 +1,147 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import com.alibaba.csp.sentinel.Entry;
+import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
+import com.alibaba.csp.sentinel.SphU;
+import com.alibaba.csp.sentinel.Tracer;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.config.BaseWebMvcConfig;
+import com.alibaba.csp.sentinel.context.ContextUtil;
+import com.alibaba.csp.sentinel.log.RecordLog;
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import com.alibaba.csp.sentinel.util.AssertUtil;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.ModelAndView;
+
+/**
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public abstract class AbstractSentinelInterceptor implements HandlerInterceptor {
+
+ public static final String SENTINEL_SPRING_WEB_CONTEXT_NAME = "sentinel_spring_web_context";
+ private static final String EMPTY_ORIGIN = "";
+
+ private final BaseWebMvcConfig baseWebMvcConfig;
+
+ public AbstractSentinelInterceptor(BaseWebMvcConfig config) {
+ AssertUtil.notNull(config, "BaseWebMvcConfig should not be null");
+ AssertUtil.assertNotBlank(config.getRequestAttributeName(), "requestAttributeName should not be blank");
+ this.baseWebMvcConfig = config;
+ }
+
+ @Override
+ public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
+ throws Exception {
+ try {
+ String resourceName = getResourceName(request);
+
+ if (StringUtil.isNotEmpty(resourceName)) {
+ // Parse the request origin using registered origin parser.
+ String origin = parseOrigin(request);
+ ContextUtil.enter(SENTINEL_SPRING_WEB_CONTEXT_NAME, origin);
+ Entry entry = SphU.entry(resourceName, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
+
+ setEntryInRequest(request, baseWebMvcConfig.getRequestAttributeName(), entry);
+ }
+ return true;
+ } catch (BlockException e) {
+ handleBlockException(request, response, e);
+ return false;
+ }
+ }
+
+ /**
+ * Return the resource name of the target web resource.
+ *
+ * @param request web request
+ * @return the resource name of the target web resource.
+ */
+ protected abstract String getResourceName(HttpServletRequest request);
+
+ @Override
+ public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
+ Object handler, Exception ex) throws Exception {
+ Entry entry = getEntryInRequest(request, baseWebMvcConfig.getRequestAttributeName());
+ if (entry != null) {
+ traceExceptionAndExit(entry, ex);
+ removeEntryInRequest(request);
+ }
+ ContextUtil.exit();
+ }
+
+ @Override
+ public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
+ ModelAndView modelAndView) throws Exception {
+ }
+
+ protected void setEntryInRequest(HttpServletRequest request, String name, Entry entry) {
+ Object attrVal = request.getAttribute(name);
+ if (attrVal != null) {
+ RecordLog.warn("[{}] The attribute key '{0}' already exists in request, please set `requestAttributeName`",
+ getClass().getSimpleName(), name);
+ } else {
+ request.setAttribute(name, entry);
+ }
+ }
+
+ protected Entry getEntryInRequest(HttpServletRequest request, String attrKey) {
+ Object entryObject = request.getAttribute(attrKey);
+ return entryObject == null ? null : (Entry)entryObject;
+ }
+
+ protected void removeEntryInRequest(HttpServletRequest request) {
+ request.removeAttribute(baseWebMvcConfig.getRequestAttributeName());
+ }
+
+ protected void traceExceptionAndExit(Entry entry, Exception ex) {
+ if (entry != null) {
+ if (ex != null) {
+ Tracer.traceEntry(ex, entry);
+ }
+ entry.exit();
+ }
+ }
+
+ protected void handleBlockException(HttpServletRequest request, HttpServletResponse response, BlockException e)
+ throws Exception {
+ if (baseWebMvcConfig.getBlockExceptionHandler() != null) {
+ baseWebMvcConfig.getBlockExceptionHandler().handle(request, response, e);
+ } else {
+ // Throw BlockException directly. Users need to handle it in Spring global exception handler.
+ throw e;
+ }
+ }
+
+ protected String parseOrigin(HttpServletRequest request) {
+ String origin = EMPTY_ORIGIN;
+ if (baseWebMvcConfig.getOriginParser() != null) {
+ origin = baseWebMvcConfig.getOriginParser().parseOrigin(request);
+ if (StringUtil.isEmpty(origin)) {
+ return EMPTY_ORIGIN;
+ }
+ }
+ return origin;
+ }
+
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptor.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptor.java
new file mode 100644
index 0000000000..b01b2c358a
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptor.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.config.SentinelWebMvcConfig;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.UrlCleaner;
+
+import javax.servlet.http.HttpServletRequest;
+
+import com.alibaba.csp.sentinel.util.StringUtil;
+import org.springframework.web.servlet.HandlerMapping;
+
+/**
+ * Spring Web MVC interceptor that integrates with Sentinel.
+ *
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public class SentinelWebInterceptor extends AbstractSentinelInterceptor {
+
+ private final SentinelWebMvcConfig config;
+
+ public SentinelWebInterceptor() {
+ this(new SentinelWebMvcConfig());
+ }
+
+ public SentinelWebInterceptor(SentinelWebMvcConfig config) {
+ super(config);
+ if (config == null) {
+ // Use the default config by default.
+ this.config = new SentinelWebMvcConfig();
+ } else {
+ this.config = config;
+ }
+ }
+
+ @Override
+ protected String getResourceName(HttpServletRequest request) {
+ // Resolve the Spring Web URL pattern from the request attribute.
+ Object resourceNameObject = request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
+ if (resourceNameObject == null || !(resourceNameObject instanceof String)) {
+ return null;
+ }
+ String resourceName = (String) resourceNameObject;
+ UrlCleaner urlCleaner = config.getUrlCleaner();
+ if (urlCleaner != null) {
+ resourceName = urlCleaner.clean(resourceName);
+ }
+ // Add method specification if necessary
+ if (StringUtil.isNotEmpty(resourceName) && config.isHttpMethodSpecify()) {
+ resourceName = request.getMethod().toUpperCase() + ":" + resourceName;
+ }
+ return resourceName;
+ }
+
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebTotalInterceptor.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebTotalInterceptor.java
new file mode 100644
index 0000000000..d356ca36ff
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebTotalInterceptor.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.config.SentinelWebMvcTotalConfig;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * The web interceptor for all requests, which will unify all URL as
+ * a single resource name (configured in {@link SentinelWebMvcTotalConfig}).
+ *
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public class SentinelWebTotalInterceptor extends AbstractSentinelInterceptor {
+
+ private final SentinelWebMvcTotalConfig config;
+
+ public SentinelWebTotalInterceptor(SentinelWebMvcTotalConfig config) {
+ super(config);
+ if (config == null) {
+ this.config = new SentinelWebMvcTotalConfig();
+ } else {
+ this.config = config;
+ }
+ }
+
+ public SentinelWebTotalInterceptor() {
+ this(new SentinelWebMvcTotalConfig());
+ }
+
+ @Override
+ protected String getResourceName(HttpServletRequest request) {
+ return config.getTotalResourceName();
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/BlockExceptionHandler.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/BlockExceptionHandler.java
new file mode 100644
index 0000000000..b40a06ebe6
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/BlockExceptionHandler.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.callback;
+
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Handler for the blocked request.
+ *
+ * @author kaizi2009
+ */
+public interface BlockExceptionHandler {
+
+ /**
+ * Handle the request when blocked.
+ *
+ * @param request Servlet request
+ * @param response Servlet response
+ * @param e the block exception
+ * @throws Exception users may throw out the BlockException or other error occurs
+ */
+ void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception;
+
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/DefaultBlockExceptionHandler.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/DefaultBlockExceptionHandler.java
new file mode 100644
index 0000000000..acb74d0e43
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/DefaultBlockExceptionHandler.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.callback;
+
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.PrintWriter;
+
+/**
+ * Default handler for the blocked request.
+ *
+ * @author kaizi2009
+ */
+public class DefaultBlockExceptionHandler implements BlockExceptionHandler {
+
+ @Override
+ public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
+ // Return 429 (Too Many Requests) by default.
+ response.setStatus(429);
+
+ StringBuffer url = request.getRequestURL();
+
+ if ("GET".equals(request.getMethod()) && StringUtil.isNotBlank(request.getQueryString())) {
+ url.append("?").append(request.getQueryString());
+ }
+
+ PrintWriter out = response.getWriter();
+ out.print("Blocked by Sentinel (flow limiting)");
+ out.flush();
+ out.close();
+ }
+
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/RequestOriginParser.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/RequestOriginParser.java
new file mode 100644
index 0000000000..647e018363
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/RequestOriginParser.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.spring.webmvc.callback;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * The origin parser parses request origin (e.g. IP, user, appName) from HTTP request.
+ *
+ * @author kaizi2009
+ */
+public interface RequestOriginParser {
+
+ /**
+ * Parse the origin from given HTTP request.
+ *
+ * @param request HTTP request
+ * @return parsed origin
+ */
+ String parseOrigin(HttpServletRequest request);
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/UrlCleaner.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/UrlCleaner.java
new file mode 100644
index 0000000000..8541d097b6
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/callback/UrlCleaner.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.callback;
+
+/**
+ * Unify the resource target.
+ *
+ * @author kaizi2009
+ */
+public interface UrlCleaner {
+
+ /**
+ * Unify the resource target.
+ *
+ * @param originUrl the original URL
+ * @return the unified resource name
+ */
+ String clean(String originUrl);
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/BaseWebMvcConfig.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/BaseWebMvcConfig.java
new file mode 100644
index 0000000000..03ff0ebc7b
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/BaseWebMvcConfig.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.spring.webmvc.config;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.BlockExceptionHandler;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.RequestOriginParser;
+import com.alibaba.csp.sentinel.util.AssertUtil;
+
+/**
+ * Common base configuration for Spring Web MVC adapter.
+ *
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public abstract class BaseWebMvcConfig {
+
+ protected String requestAttributeName;
+ protected BlockExceptionHandler blockExceptionHandler;
+ protected RequestOriginParser originParser;
+
+ public String getRequestAttributeName() {
+ return requestAttributeName;
+ }
+
+ public void setRequestAttributeName(String requestAttributeName) {
+ this.requestAttributeName = requestAttributeName;
+ }
+
+ public BlockExceptionHandler getBlockExceptionHandler() {
+ return blockExceptionHandler;
+ }
+
+ public void setBlockExceptionHandler(BlockExceptionHandler blockExceptionHandler) {
+ this.blockExceptionHandler = blockExceptionHandler;
+ }
+
+ public RequestOriginParser getOriginParser() {
+ return originParser;
+ }
+
+ public void setOriginParser(RequestOriginParser originParser) {
+ this.originParser = originParser;
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcConfig.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcConfig.java
new file mode 100755
index 0000000000..29a2891ca6
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcConfig.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.spring.webmvc.config;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.UrlCleaner;
+
+/**
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public class SentinelWebMvcConfig extends BaseWebMvcConfig {
+
+ public static final String DEFAULT_REQUEST_ATTRIBUTE_NAME = "$$sentinel_spring_web_entry_attr";
+
+ /**
+ * Specify the URL cleaner that unifies the URL resources.
+ */
+ private UrlCleaner urlCleaner;
+ /**
+ * Specify whether the URL resource name should contain the HTTP method prefix (e.g. {@code POST:}).
+ */
+ private boolean httpMethodSpecify;
+
+ public SentinelWebMvcConfig() {
+ super();
+ setRequestAttributeName(DEFAULT_REQUEST_ATTRIBUTE_NAME);
+ }
+
+ public UrlCleaner getUrlCleaner() {
+ return urlCleaner;
+ }
+
+ public SentinelWebMvcConfig setUrlCleaner(UrlCleaner urlCleaner) {
+ this.urlCleaner = urlCleaner;
+ return this;
+ }
+
+ public boolean isHttpMethodSpecify() {
+ return httpMethodSpecify;
+ }
+
+ public SentinelWebMvcConfig setHttpMethodSpecify(boolean httpMethodSpecify) {
+ this.httpMethodSpecify = httpMethodSpecify;
+ return this;
+ }
+
+ @Override
+ public String toString() {
+ return "SentinelWebMvcConfig{" +
+ "urlCleaner=" + urlCleaner +
+ ", httpMethodSpecify=" + httpMethodSpecify +
+ ", requestAttributeName='" + requestAttributeName + '\'' +
+ ", blockExceptionHandler=" + blockExceptionHandler +
+ ", originParser=" + originParser +
+ '}';
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcTotalConfig.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcTotalConfig.java
new file mode 100644
index 0000000000..dc8b4af026
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelWebMvcTotalConfig.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.config;
+
+/**
+ * @author kaizi2009
+ * @since 1.7.1
+ */
+public class SentinelWebMvcTotalConfig extends BaseWebMvcConfig {
+
+ public static final String DEFAULT_TOTAL_RESOURCE_NAME = "spring-mvc-total-url-request";
+ public static final String DEFAULT_REQUEST_ATTRIBUTE_NAME = "$$sentinel_spring_web_total_entry_attr";
+
+ private String totalResourceName = DEFAULT_TOTAL_RESOURCE_NAME;
+
+ public SentinelWebMvcTotalConfig() {
+ super();
+ setRequestAttributeName(DEFAULT_REQUEST_ATTRIBUTE_NAME);
+ }
+
+ public String getTotalResourceName() {
+ return totalResourceName;
+ }
+
+ public SentinelWebMvcTotalConfig setTotalResourceName(String totalResourceName) {
+ this.totalResourceName = totalResourceName;
+ return this;
+ }
+
+ @Override
+ public String toString() {
+ return "SentinelWebMvcTotalConfig{" +
+ "totalResourceName='" + totalResourceName + '\'' +
+ ", requestAttributeName='" + requestAttributeName + '\'' +
+ ", blockExceptionHandler=" + blockExceptionHandler +
+ ", originParser=" + originParser +
+ '}';
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/ResultWrapper.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/ResultWrapper.java
new file mode 100644
index 0000000000..66121fcd60
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/ResultWrapper.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import com.alibaba.fastjson.JSONObject;
+
+/**
+ * @author kaizi2009
+ */
+public class ResultWrapper {
+
+ private Integer code;
+ private String message;
+
+ public ResultWrapper(Integer code, String message) {
+ this.code = code;
+ this.message = message;
+ }
+
+ public Integer getCode() {
+ return code;
+ }
+
+ public void setCode(Integer code) {
+ this.code = code;
+ }
+
+ public static ResultWrapper error() {
+
+ return new ResultWrapper(-1, "System error");
+ }
+
+ public static ResultWrapper blocked() {
+ return new ResultWrapper(-2, "Blocked by Sentinel");
+ }
+
+ public String toJsonString() {
+ return JSONObject.toJSONString(this);
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelSpringMvcIntegrationTest.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelSpringMvcIntegrationTest.java
new file mode 100644
index 0000000000..f6a4b30fba
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelSpringMvcIntegrationTest.java
@@ -0,0 +1,155 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import com.alibaba.csp.sentinel.node.ClusterNode;
+import com.alibaba.csp.sentinel.slots.block.RuleConstant;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
+import com.alibaba.csp.sentinel.slots.clusterbuilder.ClusterBuilderSlot;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+import java.util.Collections;
+
+import org.junit.After;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.MediaType;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+/**
+ * @author kaizi2009
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = TestApplication.class)
+@AutoConfigureMockMvc
+public class SentinelSpringMvcIntegrationTest {
+
+ private static final String HELLO_STR = "Hello!";
+ @Autowired
+ private MockMvc mvc;
+
+ @Test
+ public void testBase() throws Exception {
+ String url = "/hello";
+ this.mvc.perform(get(url))
+ .andExpect(status().isOk())
+ .andExpect(content().string(HELLO_STR));
+
+ ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
+ assertNotNull(cn);
+ assertEquals(1, cn.passQps(), 0.01);
+ }
+
+ @Test
+ public void testOriginParser() throws Exception {
+ String springMvcPathVariableUrl = "/foo/{id}";
+ String limitOrigin = "userA";
+ final String headerName = "S-User";
+ configureRulesFor(springMvcPathVariableUrl, 0, limitOrigin);
+
+ this.mvc.perform(get("/foo/1").accept(MediaType.TEXT_PLAIN).header(headerName, "userB"))
+ .andExpect(status().isOk())
+ .andExpect(content().string("foo 1"));
+
+ // This will be blocked and reponse json.
+ this.mvc.perform(
+ get("/foo/2").accept(MediaType.APPLICATION_JSON).header(headerName, limitOrigin))
+ .andExpect(status().isOk())
+ .andExpect(content().json(ResultWrapper.blocked().toJsonString()));
+ this.mvc.perform(get("/foo/3").accept(MediaType.APPLICATION_JSON))
+ .andExpect(status().isOk())
+ .andExpect(content().string(ResultWrapper.blocked().toJsonString()));
+
+ FlowRuleManager.loadRules(null);
+ }
+
+ @Test
+ public void testTotalInterceptor() throws Exception {
+ String url = "/hello";
+ String totalTarget = "my_spring_mvc_total_url_request";
+ for (int i = 0; i < 3; i++) {
+ this.mvc.perform(get(url))
+ .andExpect(status().isOk())
+ .andExpect(content().string(HELLO_STR));
+ }
+ ClusterNode cn = ClusterBuilderSlot.getClusterNode(totalTarget);
+ assertNotNull(cn);
+ assertEquals(3, cn.passQps(), 0.01);
+ }
+
+ @Test
+ public void testRuntimeException() throws Exception {
+ String url = "/runtimeException";
+ configureExceptionRulesFor(url, 3, null);
+ int repeat = 3;
+ for (int i = 0; i < repeat; i++) {
+ this.mvc.perform(get(url))
+ .andExpect(status().isOk())
+ .andExpect(content().string(ResultWrapper.error().toJsonString()));
+ ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
+ assertNotNull(cn);
+ assertEquals(i + 1, cn.passQps(), 0.01);
+ }
+
+ // This will be blocked and reponse json.
+ this.mvc.perform(get(url))
+ .andExpect(status().isOk())
+ .andExpect(content().string(ResultWrapper.blocked().toJsonString()));
+ ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
+ assertNotNull(cn);
+ assertEquals(repeat, cn.passQps(), 0.01);
+ assertEquals(1, cn.blockRequest(), 1);
+ }
+
+ private void configureRulesFor(String resource, int count, String limitApp) {
+ FlowRule rule = new FlowRule()
+ .setCount(count)
+ .setGrade(RuleConstant.FLOW_GRADE_QPS);
+ rule.setResource(resource);
+ if (StringUtil.isNotBlank(limitApp)) {
+ rule.setLimitApp(limitApp);
+ }
+ FlowRuleManager.loadRules(Collections.singletonList(rule));
+ }
+
+ private void configureExceptionRulesFor(String resource, int count, String limitApp) {
+ FlowRule rule = new FlowRule()
+ .setCount(count)
+ .setGrade(RuleConstant.DEGRADE_GRADE_EXCEPTION_RATIO);
+ rule.setResource(resource);
+ if (StringUtil.isNotBlank(limitApp)) {
+ rule.setLimitApp(limitApp);
+ }
+ FlowRuleManager.loadRules(Collections.singletonList(rule));
+ }
+
+ @After
+ public void cleanUp() {
+ FlowRuleManager.loadRules(null);
+ ClusterBuilderSlot.resetClusterNodes();
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptorTest.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptorTest.java
new file mode 100644
index 0000000000..506d9b2d46
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelWebInterceptorTest.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.config.SentinelWebMvcConfig;
+
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+/**
+ * @author Eric Zhao
+ */
+public class SentinelWebInterceptorTest {
+
+ @Test(expected = IllegalArgumentException.class)
+ public void testPassIllegalConfig() {
+ SentinelWebMvcConfig config = new SentinelWebMvcConfig();
+ config.setRequestAttributeName(null);
+ SentinelWebInterceptor interceptor = new SentinelWebInterceptor(config);
+ }
+}
\ No newline at end of file
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/TestApplication.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/TestApplication.java
new file mode 100644
index 0000000000..da9b6bba93
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/TestApplication.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.EnableAspectJAutoProxy;
+
+/**
+ * @author kaizi2009
+ */
+@SpringBootApplication
+public class TestApplication {
+ public static void main(String[] args) {
+ SpringApplication.run(TestApplication.class);
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/InterceptorConfig.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/InterceptorConfig.java
new file mode 100644
index 0000000000..1ff24fd2cf
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/InterceptorConfig.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.config;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.SentinelWebInterceptor;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.SentinelWebTotalInterceptor;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.BlockExceptionHandler;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.RequestOriginParser;
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Config sentinel interceptor
+ *
+ * @author kaizi2009
+ */
+@Configuration
+public class InterceptorConfig implements WebMvcConfigurer {
+
+ @Override
+ public void addInterceptors(InterceptorRegistry registry) {
+ //Add sentinel interceptor
+ addSpringMvcInterceptor(registry);
+
+ //If you want to sentinel the total flow, you can add total interceptor
+ addSpringMvcTotalInterceptor(registry);
+ }
+
+ private void addSpringMvcInterceptor(InterceptorRegistry registry) {
+ //Config
+ SentinelWebMvcConfig config = new SentinelWebMvcConfig();
+
+ config.setBlockExceptionHandler(new BlockExceptionHandler() {
+ @Override
+ public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
+ String resourceName = e.getRule().getResource();
+ //Depending on your situation, you can choose to process or throw
+ if ("/hello".equals(resourceName)) {
+ //Do something ......
+ //Write string or json string;
+ response.getWriter().write("/Blocked by sentinel");
+ } else {
+ //Handle in global exception handling
+ throw e;
+ }
+ }
+ });
+
+ //Custom configuration if necessary
+ config.setHttpMethodSpecify(false);
+ config.setOriginParser(new RequestOriginParser() {
+ @Override
+ public String parseOrigin(HttpServletRequest request) {
+ return request.getHeader("S-user");
+ }
+ });
+
+ //Add sentinel interceptor
+ registry.addInterceptor(new SentinelWebInterceptor(config)).addPathPatterns("/**");
+ }
+
+ private void addSpringMvcTotalInterceptor(InterceptorRegistry registry) {
+ //Configure
+ SentinelWebMvcTotalConfig config = new SentinelWebMvcTotalConfig();
+
+ //Custom configuration if necessary
+ config.setRequestAttributeName("my_sentinel_spring_mvc_total_entity_container");
+ config.setTotalResourceName("my_spring_mvc_total_url_request");
+
+ //Add sentinel interceptor
+ registry.addInterceptor(new SentinelWebTotalInterceptor(config)).addPathPatterns("/**");
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelSpringMvcBlockHandlerConfig.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelSpringMvcBlockHandlerConfig.java
new file mode 100644
index 0000000000..b8e4660377
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/config/SentinelSpringMvcBlockHandlerConfig.java
@@ -0,0 +1,54 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.config;
+
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.ResultWrapper;
+import com.alibaba.csp.sentinel.slots.block.AbstractRule;
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.core.annotation.Order;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+/**
+ * Config 'BlockException' handler, handler it in spring veb 'ExceptionHandler'
+ *
+ * @author kaizi2009
+ */
+@ControllerAdvice
+@Order(0)
+public class SentinelSpringMvcBlockHandlerConfig {
+ private Logger logger = LoggerFactory.getLogger(this.getClass());
+
+ @ExceptionHandler(BlockException.class)
+ @ResponseBody
+ public ResultWrapper sentinelBlockHandler(BlockException e) {
+ AbstractRule rule = e.getRule();
+ //Log
+ logger.info("Blocked by sentinel, {}", rule.toString());
+ //Return object
+ return ResultWrapper.blocked();
+ }
+
+ @ExceptionHandler(Exception.class)
+ @ResponseBody
+ public ResultWrapper exceptionHandler(Exception e) {
+ logger.error("System error", e.getMessage());
+ return new ResultWrapper(-1, "System error");
+ }
+}
diff --git a/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/controller/TestController.java b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/controller/TestController.java
new file mode 100644
index 0000000000..d8a42ab8fb
--- /dev/null
+++ b/sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/controller/TestController.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.spring.webmvc.controller;
+
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * @author kaizi2009
+ */
+@RestController
+public class TestController {
+
+ @GetMapping("/hello")
+ public String apiHello() {
+ return "Hello!";
+ }
+
+ @GetMapping("/err")
+ public String apiError() {
+ return "Oops...";
+ }
+
+ @GetMapping("/foo/{id}")
+ public String apiFoo(@PathVariable("id") Long id) {
+ return "foo " + id;
+ }
+
+ @GetMapping("/runtimeException")
+ public String runtimeException() {
+ int i = 1 / 0;
+ return "runtimeException";
+ }
+
+ @GetMapping("/exclude/{id}")
+ public String apiExclude(@PathVariable("id") Long id) {
+ return "Exclude " + id;
+ }
+
+}
diff --git a/sentinel-adapter/sentinel-web-servlet/README.md b/sentinel-adapter/sentinel-web-servlet/README.md
index f73451a3c7..1d56d21b6e 100755
--- a/sentinel-adapter/sentinel-web-servlet/README.md
+++ b/sentinel-adapter/sentinel-web-servlet/README.md
@@ -1,6 +1,7 @@
# Sentinel Web Servlet Filter
-Sentinel provides Servlet filter integration to enable flow control for web requests. Add the following dependency in `pom.xml` (if you are using Maven):
+Sentinel provides Servlet filter integration to enable flow control for web requests.
+Add the following dependency in `pom.xml` (if you are using Maven):
```xml
@@ -10,7 +11,7 @@ Sentinel provides Servlet filter integration to enable flow control for web requ
```
-To use the filter, you can simply configure your `web.xml` with:
+To activate the filter, you can simply configure your `web.xml` with:
```xml
@@ -34,16 +35,21 @@ public class FilterConfig {
public FilterRegistrationBean sentinelFilterRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean<>();
registration.setFilter(new CommonFilter());
+ // Set the matching URL pattern for the filter.
registration.addUrlPatterns("/*");
- registration.setName("sentinelFilter");
+ registration.setName("sentinelCommonFilter");
registration.setOrder(1);
-
+ // Set whether to support the specified HTTP method prefix for the filter.
+ registration.addInitParameter(CommonFilter.HTTP_METHOD_SPECIFY, "false");
return registration;
}
}
```
-When a request is blocked, Sentinel servlet filter will give a default page indicating the request blocked.
+When a request is blocked, Sentinel servlet filter will display a default page indicating the request is rejected.
+The HTTP status code of the default block page is **429 (Too Many Requests)**. You can customize it
+via the `csp.sentinel.web.servlet.block.status` configuration item (since 1.7.0).
+
If customized block page is set (via `WebServletConfig.setBlockPage(blockPage)` method),
the filter will redirect the request to provided URL. You can also implement your own
block handler (the `UrlBlockHandler` interface) and register to `WebCallbackManager`.
@@ -52,5 +58,9 @@ The `UrlCleaner` interface is designed for clean and unify the URL resource.
For REST APIs, you have to clean the URL resource (e.g. `/foo/1` and `/foo/2` -> `/foo/:id`), or
the amount of context and resources will exceed the threshold.
-`RequestOriginParser` interface is useful for extracting request origin (e.g. IP or appName from HTTP Header)
-from HTTP request. You can implement your own `RequestOriginParser` and register to `WebCallbackManager`.
\ No newline at end of file
+If you need to exclude some URLs (that should not be recorded as Sentinel resources), you could also
+leverage the `UrlCleaner` interface. You may unify the unwanted URLs to the empty string `""` or `null`,
+then the URLs will be excluded (since Sentinel 1.6.3).
+
+The `RequestOriginParser` interface is useful for extracting request origin (e.g. IP or appName from HTTP Header)
+from HTTP request. You can implement your own `RequestOriginParser` and register to `WebCallbackManager`.
diff --git a/sentinel-adapter/sentinel-web-servlet/pom.xml b/sentinel-adapter/sentinel-web-servlet/pom.xml
index fc82802ed2..32c6b0d3fa 100755
--- a/sentinel-adapter/sentinel-web-servlet/pom.xml
+++ b/sentinel-adapter/sentinel-web-servlet/pom.xml
@@ -6,7 +6,7 @@
com.alibaba.csp
sentinel-adapter
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
sentinel-web-servlet
diff --git a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilter.java b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilter.java
index f24bbe55e2..e246e06c65 100755
--- a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilter.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilter.java
@@ -28,40 +28,58 @@
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser;
import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner;
import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
+import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
import com.alibaba.csp.sentinel.adapter.servlet.util.FilterUtil;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.util.StringUtil;
-/***
+/**
* Servlet filter that integrates with Sentinel.
*
* @author youji.zj
* @author Eric Zhao
+ * @author zhaoyuguang
*/
public class CommonFilter implements Filter {
- private final static String HTTP_METHOD_SPECIFY = "HTTP_METHOD_SPECIFY";
+ /**
+ * Specify whether the URL resource name should contain the HTTP method prefix (e.g. {@code POST:}).
+ */
+ public static final String HTTP_METHOD_SPECIFY = "HTTP_METHOD_SPECIFY";
+ /**
+ * If enabled, use the URL path as the context name, or else use the default
+ * {@link WebServletConfig#WEB_SERVLET_CONTEXT_NAME}. Please pay attention to the number of context (EntranceNode),
+ * which may affect the memory footprint.
+ *
+ * @since 1.7.0
+ */
+ public static final String WEB_CONTEXT_UNIFY = "WEB_CONTEXT_UNIFY";
+
private final static String COLON = ":";
+
private boolean httpMethodSpecify = false;
+ private boolean webContextUnify = true;
@Override
public void init(FilterConfig filterConfig) {
httpMethodSpecify = Boolean.parseBoolean(filterConfig.getInitParameter(HTTP_METHOD_SPECIFY));
+ if (filterConfig.getInitParameter(WEB_CONTEXT_UNIFY) != null) {
+ webContextUnify = Boolean.parseBoolean(filterConfig.getInitParameter(WEB_CONTEXT_UNIFY));
+ }
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest sRequest = (HttpServletRequest) request;
- Entry entry = null;
-
- Entry methodEntry = null;
+ Entry urlEntry = null;
try {
String target = FilterUtil.filterTarget(sRequest);
@@ -73,39 +91,33 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
target = urlCleaner.clean(target);
}
- // Parse the request origin using registered origin parser.
- String origin = parseOrigin(sRequest);
-
- ContextUtil.enter(target, origin);
- entry = SphU.entry(target, EntryType.IN);
-
-
- // Add method specification if necessary
- if (httpMethodSpecify) {
- methodEntry = SphU.entry(sRequest.getMethod().toUpperCase() + COLON + target,
- EntryType.IN);
+ // If you intend to exclude some URLs, you can convert the URLs to the empty string ""
+ // in the UrlCleaner implementation.
+ if (!StringUtil.isEmpty(target)) {
+ // Parse the request origin using registered origin parser.
+ String origin = parseOrigin(sRequest);
+ String contextName = webContextUnify ? WebServletConfig.WEB_SERVLET_CONTEXT_NAME : target;
+ ContextUtil.enter(contextName, origin);
+
+ if (httpMethodSpecify) {
+ // Add HTTP method prefix if necessary.
+ String pathWithHttpMethod = sRequest.getMethod().toUpperCase() + COLON + target;
+ urlEntry = SphU.entry(pathWithHttpMethod, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
+ } else {
+ urlEntry = SphU.entry(target, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
+ }
}
-
chain.doFilter(request, response);
} catch (BlockException e) {
HttpServletResponse sResponse = (HttpServletResponse) response;
// Return the block page, or redirect to another URL.
WebCallbackManager.getUrlBlockHandler().blocked(sRequest, sResponse, e);
- } catch (IOException e2) {
- Tracer.trace(e2);
+ } catch (IOException | ServletException | RuntimeException e2) {
+ Tracer.traceEntry(e2, urlEntry);
throw e2;
- } catch (ServletException e3) {
- Tracer.trace(e3);
- throw e3;
- } catch (RuntimeException e4) {
- Tracer.trace(e4);
- throw e4;
} finally {
- if (methodEntry != null) {
- methodEntry.exit();
- }
- if (entry != null) {
- entry.exit();
+ if (urlEntry != null) {
+ urlEntry.exit();
}
ContextUtil.exit();
}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonTotalFilter.java b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonTotalFilter.java
index 803607d5b7..47161e0f30 100755
--- a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonTotalFilter.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/CommonTotalFilter.java
@@ -27,10 +27,11 @@
import javax.servlet.http.HttpServletResponse;
import com.alibaba.csp.sentinel.Entry;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
-import com.alibaba.csp.sentinel.adapter.servlet.util.FilterUtil;
+import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.slots.block.BlockException;
@@ -52,26 +53,18 @@ public void init(FilterConfig filterConfig) {
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
HttpServletRequest sRequest = (HttpServletRequest)request;
- String target = FilterUtil.filterTarget(sRequest);
- target = WebCallbackManager.getUrlCleaner().clean(target);
Entry entry = null;
try {
- ContextUtil.enter(target);
- entry = SphU.entry(TOTAL_URL_REQUEST);
+ ContextUtil.enter(WebServletConfig.WEB_SERVLET_CONTEXT_NAME);
+ entry = SphU.entry(TOTAL_URL_REQUEST, ResourceTypeConstants.COMMON_WEB);
chain.doFilter(request, response);
} catch (BlockException e) {
HttpServletResponse sResponse = (HttpServletResponse)response;
WebCallbackManager.getUrlBlockHandler().blocked(sRequest, sResponse, e);
- } catch (IOException e2) {
+ } catch (IOException | ServletException | RuntimeException e2) {
Tracer.trace(e2);
throw e2;
- } catch (ServletException e3) {
- Tracer.trace(e3);
- throw e3;
- } catch (RuntimeException e4) {
- Tracer.trace(e4);
- throw e4;
} finally {
if (entry != null) {
entry.exit();
diff --git a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/config/WebServletConfig.java b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/config/WebServletConfig.java
index bcaafe0786..dc6f66c42a 100755
--- a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/config/WebServletConfig.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/config/WebServletConfig.java
@@ -18,13 +18,23 @@
import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter;
import com.alibaba.csp.sentinel.adapter.servlet.CommonTotalFilter;
import com.alibaba.csp.sentinel.config.SentinelConfig;
+import com.alibaba.csp.sentinel.log.RecordLog;
+import com.alibaba.csp.sentinel.util.StringUtil;
/**
+ * The configuration center for Web Servlet adapter.
+ *
* @author leyou
+ * @author zhaoyuguang
*/
-public class WebServletConfig {
+public final class WebServletConfig {
+
+ public static final String WEB_SERVLET_CONTEXT_NAME = "sentinel_web_servlet_context";
- public static final String BLOCK_PAGE = "csp.sentinel.web.servlet.block.page";
+ public static final String BLOCK_PAGE_URL_CONF_KEY = "csp.sentinel.web.servlet.block.page";
+ public static final String BLOCK_PAGE_HTTP_STATUS_CONF_KEY = "csp.sentinel.web.servlet.block.status";
+
+ private static final int HTTP_STATUS_TOO_MANY_REQUESTS = 429;
/**
* Get redirecting page when Sentinel blocking for {@link CommonFilter} or
@@ -33,10 +43,52 @@ public class WebServletConfig {
* @return the block page URL, maybe null if not configured.
*/
public static String getBlockPage() {
- return SentinelConfig.getConfig(BLOCK_PAGE);
+ return SentinelConfig.getConfig(BLOCK_PAGE_URL_CONF_KEY);
}
public static void setBlockPage(String blockPage) {
- SentinelConfig.setConfig(BLOCK_PAGE, blockPage);
+ SentinelConfig.setConfig(BLOCK_PAGE_URL_CONF_KEY, blockPage);
+ }
+
+ /**
+ * Get the HTTP status when using the default block page.
+ * You can set the status code with the {@code -Dcsp.sentinel.web.servlet.block.status}
+ * property. When the property is empty or invalid, Sentinel will use 429 (Too Many Requests)
+ * as the default status code.
+ *
+ * @return the HTTP status of the default block page
+ * @since 1.7.0
+ */
+ public static int getBlockPageHttpStatus() {
+ String value = SentinelConfig.getConfig(BLOCK_PAGE_HTTP_STATUS_CONF_KEY);
+ if (StringUtil.isEmpty(value)) {
+ return HTTP_STATUS_TOO_MANY_REQUESTS;
+ }
+ try {
+ int s = Integer.parseInt(value);
+ if (s <= 0) {
+ throw new IllegalArgumentException("Invalid status code: " + s);
+ }
+ return s;
+ } catch (Exception e) {
+ RecordLog.warn("[WebServletConfig] Invalid block HTTP status (" + value + "), using default 429");
+ setBlockPageHttpStatus(HTTP_STATUS_TOO_MANY_REQUESTS);
+ }
+ return HTTP_STATUS_TOO_MANY_REQUESTS;
}
+
+ /**
+ * Set the HTTP status of the default block page.
+ *
+ * @param httpStatus the HTTP status of the default block page
+ * @since 1.7.0
+ */
+ public static void setBlockPageHttpStatus(int httpStatus) {
+ if (httpStatus <= 0) {
+ throw new IllegalArgumentException("Invalid HTTP status code: " + httpStatus);
+ }
+ SentinelConfig.setConfig(BLOCK_PAGE_HTTP_STATUS_CONF_KEY, String.valueOf(httpStatus));
+ }
+
+ private WebServletConfig() {}
}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/util/FilterUtil.java b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/util/FilterUtil.java
index 626aecf16e..a4781bead3 100755
--- a/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/util/FilterUtil.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/main/java/com/alibaba/csp/sentinel/adapter/servlet/util/FilterUtil.java
@@ -27,6 +27,7 @@
/**
* Util class for web servlet filter.
*
+ * @author zhaoyuguang
* @author youji.zj
* @author Eric Zhao
*/
@@ -65,7 +66,7 @@ public static void blockRequest(HttpServletRequest request, HttpServletResponse
}
if (StringUtil.isBlank(WebServletConfig.getBlockPage())) {
- writeDefaultBlockedPage(response);
+ writeDefaultBlockedPage(response, WebServletConfig.getBlockPageHttpStatus());
} else {
String redirectUrl = WebServletConfig.getBlockPage() + "?http_referer=" + url.toString();
// Redirect to the customized block page.
@@ -73,7 +74,8 @@ public static void blockRequest(HttpServletRequest request, HttpServletResponse
}
}
- private static void writeDefaultBlockedPage(HttpServletResponse response) throws IOException {
+ private static void writeDefaultBlockedPage(HttpServletResponse response, int httpStatus) throws IOException {
+ response.setStatus(httpStatus);
PrintWriter out = response.getWriter();
out.print(DEFAULT_BLOCK_MSG);
out.flush();
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilterTest.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilterTest.java
index bd42a89b06..a505ebf809 100644
--- a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilterTest.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/CommonFilterTest.java
@@ -19,6 +19,7 @@
import javax.servlet.http.HttpServletRequest;
+import com.alibaba.csp.sentinel.Constants;
import com.alibaba.csp.sentinel.adapter.servlet.callback.DefaultUrlCleaner;
import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser;
import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner;
@@ -26,6 +27,8 @@
import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
import com.alibaba.csp.sentinel.adapter.servlet.util.FilterUtil;
import com.alibaba.csp.sentinel.node.ClusterNode;
+import com.alibaba.csp.sentinel.node.EntranceNode;
+import com.alibaba.csp.sentinel.node.Node;
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
@@ -38,15 +41,17 @@
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import static org.junit.Assert.*;
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
/**
+ * @author zhaoyuguang
* @author Eric Zhao
*/
@RunWith(SpringRunner.class)
@@ -76,6 +81,7 @@ private void configureRulesFor(String resource, int count, String limitApp) {
@Test
public void testCommonFilterMiscellaneous() throws Exception {
+ Constants.ROOT.removeChildList();
String url = "/hello";
this.mvc.perform(get(url))
.andExpect(status().isOk())
@@ -85,22 +91,39 @@ public void testCommonFilterMiscellaneous() throws Exception {
assertNotNull(cn);
assertEquals(1, cn.passQps(), 0.01);
+ String context = "";
+ for (Node n : Constants.ROOT.getChildList()) {
+ if (n instanceof EntranceNode) {
+ String id = ((EntranceNode) n).getId().getName();
+ if (url.equals(id)) {
+ context = ((EntranceNode) n).getId().getName();
+ }
+ }
+ }
+ assertEquals("", context);
+
testCommonBlockAndRedirectBlockPage(url, cn);
// Test for url cleaner.
testUrlCleaner();
-
+ testUrlExclusion();
testCustomOriginParser();
}
private void testCommonBlockAndRedirectBlockPage(String url, ClusterNode cn) throws Exception {
configureRulesFor(url, 0);
// The request will be blocked and response is default block message.
+ WebServletConfig.setBlockPageHttpStatus(HttpStatus.OK.value());
this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN))
.andExpect(status().isOk())
.andExpect(content().string(FilterUtil.DEFAULT_BLOCK_MSG));
assertEquals(1, cn.blockQps(), 0.01);
+ WebServletConfig.setBlockPageHttpStatus(HttpStatus.TOO_MANY_REQUESTS.value());
+ this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN))
+ .andExpect(status().isTooManyRequests())
+ .andExpect(content().string(FilterUtil.DEFAULT_BLOCK_MSG));
+
// Test for redirect.
String redirectUrl = "http://some-location.com";
WebServletConfig.setBlockPage(redirectUrl);
@@ -139,6 +162,25 @@ public String clean(String originUrl) {
WebCallbackManager.setUrlCleaner(new DefaultUrlCleaner());
}
+ private void testUrlExclusion() throws Exception {
+ final String excludePrefix = "/exclude/";
+ String url = excludePrefix + 1;
+ WebCallbackManager.setUrlCleaner(new UrlCleaner() {
+ @Override
+ public String clean(String originUrl) {
+ if(originUrl.startsWith(excludePrefix)) {
+ return "";
+ }
+ return originUrl;
+ }
+ });
+ this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN))
+ .andExpect(status().isOk())
+ .andExpect(content().string("Exclude 1"));
+ assertNull(ClusterBuilderSlot.getClusterNode(url));
+ WebCallbackManager.setUrlCleaner(new DefaultUrlCleaner());
+ }
+
private void testCustomOriginParser() throws Exception {
String url = "/hello";
String limitOrigin = "userA";
@@ -158,7 +200,7 @@ public String parseOrigin(HttpServletRequest request) {
.andExpect(content().string(HELLO_STR));
// This will be blocked.
this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN).header(headerName, limitOrigin))
- .andExpect(status().isOk())
+ .andExpect(status().isTooManyRequests())
.andExpect(content().string(FilterUtil.DEFAULT_BLOCK_MSG));
this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN))
.andExpect(status().isOk())
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/TestController.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/TestController.java
index 6221190b67..dce4e2ebfe 100644
--- a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/TestController.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servlet/TestController.java
@@ -39,4 +39,9 @@ public String apiError() {
public String apiFoo(@PathVariable("id") Long id) {
return "Hello " + id;
}
+
+ @GetMapping("/exclude/{id}")
+ public String apiExclude(@PathVariable("id") Long id) {
+ return "Exclude " + id;
+ }
}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/CommonFilterContextTest.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/CommonFilterContextTest.java
new file mode 100644
index 0000000000..10c215d995
--- /dev/null
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/CommonFilterContextTest.java
@@ -0,0 +1,100 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.servletcontext;
+
+import com.alibaba.csp.sentinel.Constants;
+import com.alibaba.csp.sentinel.node.ClusterNode;
+import com.alibaba.csp.sentinel.node.EntranceNode;
+import com.alibaba.csp.sentinel.node.Node;
+import com.alibaba.csp.sentinel.slots.block.RuleConstant;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
+import com.alibaba.csp.sentinel.slots.clusterbuilder.ClusterBuilderSlot;
+import com.alibaba.csp.sentinel.util.StringUtil;
+import org.junit.After;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * @author zhaoyuguang
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = TestContextApplication.class,
+ webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+@AutoConfigureMockMvc
+public class CommonFilterContextTest {
+
+ private static final String HELLO_STR = "Hello!";
+
+ @Autowired
+ private MockMvc mvc;
+
+ private void configureRulesFor(String resource, int count) {
+ configureRulesFor(resource, count, "default");
+ }
+
+ private void configureRulesFor(String resource, int count, String limitApp) {
+ FlowRule rule = new FlowRule()
+ .setCount(count)
+ .setGrade(RuleConstant.FLOW_GRADE_QPS);
+ rule.setResource(resource);
+ if (StringUtil.isNotBlank(limitApp)) {
+ rule.setLimitApp(limitApp);
+ }
+ FlowRuleManager.loadRules(Collections.singletonList(rule));
+ }
+
+ @Test
+ public void testCommonFilterMiscellaneous() throws Exception {
+ String url = "/hello";
+ this.mvc.perform(get(url))
+ .andExpect(status().isOk())
+ .andExpect(content().string(HELLO_STR));
+
+ ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
+ assertNotNull(cn);
+ assertEquals(1, cn.passQps(), 0.01);
+ String context = "";
+ for (Node n : Constants.ROOT.getChildList()) {
+ if (n instanceof EntranceNode) {
+ String id = ((EntranceNode) n).getId().getName();
+ if (url.equals(id)) {
+ context = ((EntranceNode) n).getId().getName();
+ }
+ }
+ }
+ assertEquals(url, context);
+ }
+
+ @After
+ public void cleanUp() {
+ FlowRuleManager.loadRules(null);
+ ClusterBuilderSlot.resetClusterNodes();
+ }
+}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/FilterContextConfig.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/FilterContextConfig.java
new file mode 100644
index 0000000000..aff3a5db9d
--- /dev/null
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/FilterContextConfig.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.servletcontext;
+
+import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter;
+import org.springframework.boot.web.servlet.FilterRegistrationBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author zhaoyuguang
+ */
+@Configuration
+public class FilterContextConfig {
+
+ @Bean
+ public FilterRegistrationBean sentinelFilterRegistration() {
+ FilterRegistrationBean registration = new FilterRegistrationBean();
+ registration.setFilter(new CommonFilter());
+ registration.addUrlPatterns("/*");
+ registration.addInitParameter(CommonFilter.WEB_CONTEXT_UNIFY, "false");
+ registration.setName("sentinelFilter");
+ registration.setOrder(1);
+
+ return registration;
+ }
+}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextApplication.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextApplication.java
new file mode 100644
index 0000000000..fbf16c6ee7
--- /dev/null
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextApplication.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.servletcontext;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * @author zhaoyuguang
+ */
+@SpringBootApplication
+public class TestContextApplication {
+
+ public static void main(String[] args) {
+ SpringApplication.run(TestContextApplication.class, args);
+ }
+}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextController.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextController.java
new file mode 100644
index 0000000000..39fc81a104
--- /dev/null
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletcontext/TestContextController.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.csp.sentinel.adapter.servletcontext;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * @author zhaoyuguang
+ */
+@RestController
+public class TestContextController {
+
+ @GetMapping("/hello")
+ public String apiHello() {
+ return "Hello!";
+ }
+}
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/CommonFilterMethodTest.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/CommonFilterMethodTest.java
index 5d9a006a53..b220961032 100644
--- a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/CommonFilterMethodTest.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/CommonFilterMethodTest.java
@@ -41,6 +41,7 @@
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
/**
+ * @author zhaoyuguang
* @author Roger Law
*/
@RunWith(SpringRunner.class)
@@ -107,7 +108,7 @@ private void testCommonBlockAndRedirectBlockPage(String url, ClusterNode cnGet,
configureRulesFor(GET + ":" + url, 0);
// The request will be blocked and response is default block message.
this.mvc.perform(get(url).accept(MediaType.TEXT_PLAIN))
- .andExpect(status().isOk())
+ .andExpect(status().isTooManyRequests())
.andExpect(content().string(FilterUtil.DEFAULT_BLOCK_MSG));
assertEquals(1, cnGet.blockQps(), 0.01);
diff --git a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/FilterMethodConfig.java b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/FilterMethodConfig.java
index d2c9d21fa0..5759a75977 100644
--- a/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/FilterMethodConfig.java
+++ b/sentinel-adapter/sentinel-web-servlet/src/test/java/com/alibaba/csp/sentinel/adapter/servletmethod/FilterMethodConfig.java
@@ -16,7 +16,7 @@ public FilterRegistrationBean sentinelFilterRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean();
registration.setFilter(new CommonFilter());
registration.addUrlPatterns("/*");
- registration.addInitParameter("HTTP_METHOD_SPECIFY", "true");
+ registration.addInitParameter(CommonFilter.HTTP_METHOD_SPECIFY, "true");
registration.setName("sentinelFilter");
registration.setOrder(1);
diff --git a/sentinel-adapter/sentinel-zuul-adapter/pom.xml b/sentinel-adapter/sentinel-zuul-adapter/pom.xml
index a00190ff24..6857cb8e8e 100755
--- a/sentinel-adapter/sentinel-zuul-adapter/pom.xml
+++ b/sentinel-adapter/sentinel-zuul-adapter/pom.xml
@@ -5,7 +5,7 @@
sentinel-adapter
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
sentinel-zuul-adapter
diff --git a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/RequestContextItemParser.java b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/RequestContextItemParser.java
index c1e081e8b1..aaa5bb2f76 100644
--- a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/RequestContextItemParser.java
+++ b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/RequestContextItemParser.java
@@ -15,6 +15,8 @@
*/
package com.alibaba.csp.sentinel.adapter.gateway.zuul;
+import javax.servlet.http.Cookie;
+
import com.alibaba.csp.sentinel.adapter.gateway.common.param.RequestItemParser;
import com.netflix.zuul.context.RequestContext;
@@ -44,4 +46,18 @@ public String getHeader(RequestContext requestContext, String headerKey) {
public String getUrlParam(RequestContext requestContext, String paramName) {
return requestContext.getRequest().getParameter(paramName);
}
+
+ @Override
+ public String getCookieValue(RequestContext requestContext, String cookieName) {
+ Cookie[] cookies = requestContext.getRequest().getCookies();
+ if (cookies == null || cookieName == null) {
+ return null;
+ }
+ for (Cookie cookie : cookies) {
+ if (cookie != null && cookieName.equals(cookie.getName())) {
+ return cookie.getValue();
+ }
+ }
+ return null;
+ }
}
diff --git a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/api/matcher/RequestContextApiMatcher.java b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/api/matcher/RequestContextApiMatcher.java
index 90718db194..162874d4bb 100644
--- a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/api/matcher/RequestContextApiMatcher.java
+++ b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/api/matcher/RequestContextApiMatcher.java
@@ -61,9 +61,9 @@ private Predicate fromApiPathPredicate(/*@Valid*/ ApiPathPredica
return null;
}
switch (item.getMatchStrategy()) {
- case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_REGEX:
+ case SentinelGatewayConstants.URL_MATCH_STRATEGY_REGEX:
return ZuulRouteMatchers.regexPath(pattern);
- case SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX:
+ case SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX:
return ZuulRouteMatchers.antPath(pattern);
default:
return ZuulRouteMatchers.exactPath(pattern);
diff --git a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/EntryHolder.java b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/EntryHolder.java
new file mode 100644
index 0000000000..c67708b5af
--- /dev/null
+++ b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/EntryHolder.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 1999-2019 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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
+ *
+ * https://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 com.alibaba.csp.sentinel.adapter.gateway.zuul.filters;
+
+import com.alibaba.csp.sentinel.Entry;
+
+/**
+ * @author wavesZh
+ */
+class EntryHolder {
+
+ final private Entry entry;
+
+ final private Object[] params;
+
+ public EntryHolder(Entry entry, Object[] params) {
+ this.entry = entry;
+ this.params = params;
+ }
+
+ public Entry getEntry() {
+ return entry;
+ }
+
+ public Object[] getParams() {
+ return params;
+ }
+}
diff --git a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelEntryUtils.java b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelEntryUtils.java
index 8c93a1b7ec..48e91e38fb 100644
--- a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelEntryUtils.java
+++ b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelEntryUtils.java
@@ -17,7 +17,7 @@
import java.util.Deque;
-import com.alibaba.csp.sentinel.AsyncEntry;
+import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.Tracer;
import com.alibaba.csp.sentinel.adapter.gateway.zuul.constants.ZuulConstant;
import com.alibaba.csp.sentinel.context.ContextUtil;
@@ -34,11 +34,11 @@ final class SentinelEntryUtils {
static void tryExitFromCurrentContext() {
RequestContext ctx = RequestContext.getCurrentContext();
if (ctx.containsKey(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY)) {
- Deque asyncEntries = (Deque) ctx.get(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
- AsyncEntry entry;
- while (!asyncEntries.isEmpty()) {
- entry = asyncEntries.pop();
- entry.exit();
+ Deque holders = (Deque) ctx.get(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
+ EntryHolder holder;
+ while (!holders.isEmpty()) {
+ holder = holders.pop();
+ exit(holder);
}
ctx.remove(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
}
@@ -50,17 +50,22 @@ static void tryExitFromCurrentContext() {
static void tryTraceExceptionThenExitFromCurrentContext(Throwable t) {
RequestContext ctx = RequestContext.getCurrentContext();
if (ctx.containsKey(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY)) {
- Deque asyncEntries = (Deque) ctx.get(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
- AsyncEntry entry;
- while (!asyncEntries.isEmpty()) {
- entry = asyncEntries.pop();
- Tracer.traceEntry(t, entry);
- entry.exit();
+ Deque holders = (Deque) ctx.get(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
+ EntryHolder holder;
+ while (!holders.isEmpty()) {
+ holder = holders.pop();
+ Tracer.traceEntry(t, holder.getEntry());
+ exit(holder);
}
ctx.remove(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY);
}
ContextUtil.exit();
}
+ static void exit(EntryHolder holder) {
+ Entry entry = holder.getEntry();
+ entry.exit(1, holder.getParams());
+ }
+
private SentinelEntryUtils() {}
}
diff --git a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelZuulPreFilter.java b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelZuulPreFilter.java
index 39f85ff0dc..649ffa19d5 100644
--- a/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelZuulPreFilter.java
+++ b/sentinel-adapter/sentinel-zuul-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/gateway/zuul/filters/SentinelZuulPreFilter.java
@@ -23,6 +23,7 @@
import com.alibaba.csp.sentinel.AsyncEntry;
import com.alibaba.csp.sentinel.EntryType;
+import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.adapter.gateway.common.param.GatewayParamParser;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
@@ -88,7 +89,7 @@ public boolean shouldFilter() {
}
private void doSentinelEntry(String resourceName, final int resType, RequestContext requestContext,
- Deque asyncEntries) throws BlockException {
+ Deque holders) throws BlockException {
Object[] params = paramParser.parseParameterFor(resourceName, requestContext,
new Predicate() {
@Override
@@ -96,8 +97,10 @@ public boolean test(GatewayFlowRule r) {
return r.getResourceMode() == resType;
}
});
- AsyncEntry entry = SphU.asyncEntry(resourceName, EntryType.IN, 1, params);
- asyncEntries.push(entry);
+ AsyncEntry entry = SphU.asyncEntry(resourceName, ResourceTypeConstants.COMMON_API_GATEWAY,
+ EntryType.IN, params);
+ EntryHolder holder = new EntryHolder(entry, params);
+ holders.push(holder);
}
@Override
@@ -106,12 +109,12 @@ public Object run() throws ZuulException {
String origin = parseOrigin(ctx.getRequest());
String routeId = (String)ctx.get(ZuulConstant.PROXY_ID_KEY);
- Deque asyncEntries = new ArrayDeque<>();
+ Deque holders = new ArrayDeque<>();
String fallBackRoute = routeId;
try {
if (StringUtil.isNotBlank(routeId)) {
ContextUtil.enter(GATEWAY_CONTEXT_ROUTE_PREFIX + routeId, origin);
- doSentinelEntry(routeId, RESOURCE_MODE_ROUTE_ID, ctx, asyncEntries);
+ doSentinelEntry(routeId, RESOURCE_MODE_ROUTE_ID, ctx, holders);
}
Set matchingApis = pickMatchingApiDefinitions(ctx);
@@ -120,7 +123,7 @@ public Object run() throws ZuulException {
}
for (String apiName : matchingApis) {
fallBackRoute = apiName;
- doSentinelEntry(apiName, RESOURCE_MODE_CUSTOM_API_NAME, ctx, asyncEntries);
+ doSentinelEntry(apiName, RESOURCE_MODE_CUSTOM_API_NAME, ctx, holders);
}
} catch (BlockException ex) {
ZuulBlockFallbackProvider zuulBlockFallbackProvider = ZuulBlockFallbackManager.getFallbackProvider(
@@ -138,8 +141,8 @@ public Object run() throws ZuulException {
} finally {
// We don't exit the entry here. We need to exit the entries in post filter to record Rt correctly.
// So here the entries will be carried in the request context.
- if (!asyncEntries.isEmpty()) {
- ctx.put(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY, asyncEntries);
+ if (!holders.isEmpty()) {
+ ctx.put(ZuulConstant.ZUUL_CTX_SENTINEL_ENTRIES_KEY, holders);
}
}
return null;
diff --git a/sentinel-benchmark/pom.xml b/sentinel-benchmark/pom.xml
index 7f7e9a88b1..50410f2dbd 100644
--- a/sentinel-benchmark/pom.xml
+++ b/sentinel-benchmark/pom.xml
@@ -5,7 +5,7 @@
sentinel-parent
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
diff --git a/sentinel-cluster/pom.xml b/sentinel-cluster/pom.xml
index c58ee305bc..52170486a0 100644
--- a/sentinel-cluster/pom.xml
+++ b/sentinel-cluster/pom.xml
@@ -5,7 +5,7 @@
sentinel-parent
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
pom
@@ -23,6 +23,7 @@
sentinel-cluster-client-default
sentinel-cluster-server-default
sentinel-cluster-common-default
+ sentinel-cluster-server-envoy-rls
diff --git a/sentinel-cluster/sentinel-cluster-client-default/pom.xml b/sentinel-cluster/sentinel-cluster-client-default/pom.xml
index 80bf32dffe..0775cb3196 100644
--- a/sentinel-cluster/sentinel-cluster-client-default/pom.xml
+++ b/sentinel-cluster/sentinel-cluster-client-default/pom.xml
@@ -5,7 +5,7 @@
sentinel-cluster
com.alibaba.csp
- 1.7.0-SNAPSHOT
+ 1.7.2-SNAPSHOT
4.0.0
@@ -53,5 +53,10 @@
mockito-core
test
-# Sentinel: Sentinel of Your Application
+# Sentinel: The Sentinel of Your Microservices
[](https://travis-ci.org/alibaba/Sentinel)
[](https://codecov.io/gh/alibaba/Sentinel)
@@ -30,8 +30,9 @@ See the [中文文档](https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB%
See the [Wiki](https://github.com/alibaba/Sentinel/wiki) for full documentation, examples, blog posts, operational details and other information.
-Sentinel provides integration module for various open-source frameworks and libraries
-(e.g. Spring Cloud, Apache Dubbo, gRPC, Spring WebFlux, Reactor). You can refer to [the document](https://github.com/alibaba/Sentinel/wiki/Adapters-to-Popular-Framework) for more information.
+Sentinel provides integration modules for various open-source frameworks
+(e.g. Spring Cloud, Apache Dubbo, gRPC, Spring WebFlux, Reactor) and service mesh.
+You can refer to [the document](https://github.com/alibaba/Sentinel/wiki/Adapters-to-Popular-Framework) for more information.
If you are using Sentinel, please [**leave a comment here**](https://github.com/alibaba/Sentinel/issues/18) to tell us your scenario to make Sentinel better.
It's also encouraged to add the link of your blog post, tutorial, demo or customized components to [**Awesome Sentinel**](./doc/awesome-sentinel.md).
@@ -55,7 +56,7 @@ If your application is build in Maven, just add the following dependency in `pom