upgrade sentinel version and enhance

2021-06-26 13:25:11 +08:00 · 2020-01-12 16:40:35 +08:00
parent 2a18ddb0be
commit b0273fb1c8
14 changed files with 205 additions and 100 deletions
--- a/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelConstants.java
+++ b/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelConstants.java
@@ -26,6 +26,11 @@ public final class SentinelConstants {
 	 */
 	public static final String PROPERTY_PREFIX = "spring.cloud.sentinel";

+	/**
+	 * Block page key.
+	 */
+	public static final String BLOCK_PAGE_URL_CONF_KEY = "csp.sentinel.web.servlet.block.page";
+
 	/**
 	 * Block type.
 	 */
@@ -41,6 +46,21 @@ public final class SentinelConstants {
 	 */
 	public static final String URLCLEANER_TYPE = "urlCleaner";

+	/**
+	 * The cold factor.
+	 */
+	public static final String COLD_FACTOR = "3";
+
+	/**
+	 * The charset.
+	 */
+	public static final String CHARSET = "UTF-8";
+
+	/**
+	 * The Sentinel api port.
+	 */
+	public static final String API_PORT = "8719";
+
 	private SentinelConstants() {
 		throw new AssertionError("Must not instantiate constant utility class");
 	}
--- a/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelProperties.java
+++ b/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelProperties.java
@@ -16,6 +16,7 @@

 package com.alibaba.cloud.sentinel;

+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
@@ -26,7 +27,9 @@ import com.alibaba.csp.sentinel.log.LogBase;
 import com.alibaba.csp.sentinel.transport.config.TransportConfig;

 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 import org.springframework.core.Ordered;
+import org.springframework.util.StringUtils;
 import org.springframework.validation.annotation.Validated;

 /**
@@ -52,6 +55,11 @@ public class SentinelProperties {
 	 */
 	private boolean enabled = true;

+	/**
+	 * The process page when the flow control is triggered.
+	 */
+	private String blockPage;
+
 	/**
 	 * Configurations about datasource, like 'nacos', 'apollo', 'file', 'zookeeper'.
 	 */
@@ -75,7 +83,7 @@ public class SentinelProperties {
 	private Servlet servlet = new Servlet();

 	/**
-	 * Sentinel filter when the application is web, the configuration is effective.
+	 * Sentinel interceptor when the application is web, the configuration is effective.
 	 */
 	private Filter filter = new Filter();

@@ -174,12 +182,23 @@ public class SentinelProperties {
 		this.httpMethodSpecify = httpMethodSpecify;
 	}

+	public String getBlockPage() {
+		if (StringUtils.hasText(this.blockPage)) {
+			return this.blockPage;
+		}
+		return this.servlet.getBlockPage();
+	}
+
+	public void setBlockPage(String blockPage) {
+		this.blockPage = blockPage;
+	}
+
 	public static class Flow {

 		/**
 		 * The cold factor {@link SentinelConfig#COLD_FACTOR}.
 		 */
-		private String coldFactor = "3";
+		private String coldFactor = SentinelConstants.COLD_FACTOR;

 		public String getColdFactor() {
 			return coldFactor;
@@ -198,10 +217,15 @@ public class SentinelProperties {
 		 */
 		private String blockPage;

+		@Deprecated
+		@DeprecatedConfigurationProperty(
+				reason = "replaced to SentinelProperties#blockPage.",
+				replacement = SentinelConstants.PROPERTY_PREFIX + ".block-page")
 		public String getBlockPage() {
 			return blockPage;
 		}

+		@Deprecated
 		public void setBlockPage(String blockPage) {
 			this.blockPage = blockPage;
 		}
@@ -224,7 +248,7 @@ public class SentinelProperties {
 		 * Charset when sentinel write or search metric file.
 		 * {@link SentinelConfig#CHARSET}
 		 */
-		private String charset = "UTF-8";
+		private String charset = SentinelConstants.CHARSET;

 		public String getFileSingleSize() {
 			return fileSingleSize;
@@ -257,7 +281,7 @@ public class SentinelProperties {
 		/**
 		 * Sentinel api port, default value is 8719 {@link TransportConfig#SERVER_PORT}.
 		 */
-		private String port = "8719";
+		private String port = SentinelConstants.API_PORT;

 		/**
 		 * Sentinel dashboard address, won't try to connect dashboard when address is
@@ -314,18 +338,18 @@ public class SentinelProperties {
 	public static class Filter {

 		/**
-		 * Sentinel filter chain order.
+		 * SentinelWebInterceptor order, will be register to InterceptorRegistry.
 		 */
 		private int order = Ordered.HIGHEST_PRECEDENCE;

 		/**
-		 * URL pattern for sentinel filter, default is /*.
+		 * URL pattern for SentinelWebInterceptor, default is /*.
 		 */
-		private List<String> urlPatterns;
+		private List<String> urlPatterns = Arrays.asList("/*");

 		/**
 		 * Enable to instance
-		 * {@link com.alibaba.csp.sentinel.adapter.servlet.CommonFilter}.
+		 * {@link com.alibaba.csp.sentinel.adapter.spring.webmvc.SentinelWebInterceptor}.
 		 */
 		private boolean enabled = true;

--- a/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelWebAutoConfiguration.java
+++ b/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/SentinelWebAutoConfiguration.java
@@ -16,18 +16,14 @@

 package com.alibaba.cloud.sentinel;

-import java.util.ArrayList;
-import java.util.List;
 import java.util.Optional;

-import javax.annotation.PostConstruct;
-import javax.servlet.Filter;
-
-import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter;
-import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser;
-import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler;
-import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner;
-import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.SentinelWebInterceptor;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.BlockExceptionHandler;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.DefaultBlockExceptionHandler;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.RequestOriginParser;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.UrlCleaner;
+import com.alibaba.csp.sentinel.adapter.spring.webmvc.config.SentinelWebMvcConfig;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

@@ -37,19 +33,22 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.util.StringUtils;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

 /**
 * @author xiaojing
+ * @author yuhuangbin
 */
@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
-@ConditionalOnClass(CommonFilter.class)
@ConditionalOnProperty(name = "spring.cloud.sentinel.enabled", matchIfMissing = true)
+@ConditionalOnClass(SentinelWebInterceptor.class)
@EnableConfigurationProperties(SentinelProperties.class)
-public class SentinelWebAutoConfiguration {
+public class SentinelWebAutoConfiguration implements WebMvcConfigurer {

 	private static final Logger log = LoggerFactory
 			.getLogger(SentinelWebAutoConfiguration.class);
@@ -61,44 +60,61 @@ public class SentinelWebAutoConfiguration {
 	private Optional<UrlCleaner> urlCleanerOptional;

 	@Autowired
-	private Optional<UrlBlockHandler> urlBlockHandlerOptional;
+	private Optional<BlockExceptionHandler> blockExceptionHandlerOptional;

 	@Autowired
 	private Optional<RequestOriginParser> requestOriginParserOptional;

-	@PostConstruct
-	public void init() {
-		urlBlockHandlerOptional.ifPresent(WebCallbackManager::setUrlBlockHandler);
-		urlCleanerOptional.ifPresent(WebCallbackManager::setUrlCleaner);
-		requestOriginParserOptional.ifPresent(WebCallbackManager::setRequestOriginParser);
+	@Autowired
+	private Optional<SentinelWebInterceptor> sentinelWebInterceptorOptional;
+
+	@Override
+	public void addInterceptors(InterceptorRegistry registry) {
+		if (!sentinelWebInterceptorOptional.isPresent()) {
+			return;
+		}
+		SentinelProperties.Filter filterConfig = properties.getFilter();
+		registry.addInterceptor(sentinelWebInterceptorOptional.get())
+				.order(filterConfig.getOrder())
+				.addPathPatterns(filterConfig.getUrlPatterns());
+		log.info(
+				"[Sentinel Starter] register SentinelWebInterceptor with urlPatterns: {}.",
+				filterConfig.getUrlPatterns());
 	}

 	@Bean
 	@ConditionalOnProperty(name = "spring.cloud.sentinel.filter.enabled",
 			matchIfMissing = true)
-	public FilterRegistrationBean sentinelFilter() {
-		FilterRegistrationBean<Filter> registration = new FilterRegistrationBean<>();
+	public SentinelWebInterceptor sentinelWebInterceptor(
+			SentinelWebMvcConfig sentinelWebMvcConfig) {
+		return new SentinelWebInterceptor(sentinelWebMvcConfig);
+	}

-		SentinelProperties.Filter filterConfig = properties.getFilter();
+	@Bean
+	@ConditionalOnProperty(name = "spring.cloud.sentinel.filter.enabled",
+			matchIfMissing = true)
+	public SentinelWebMvcConfig sentinelWebMvcConfig() {
+		SentinelWebMvcConfig sentinelWebMvcConfig = new SentinelWebMvcConfig();
+		sentinelWebMvcConfig.setHttpMethodSpecify(properties.getHttpMethodSpecify());

-		if (filterConfig.getUrlPatterns() == null
-				|| filterConfig.getUrlPatterns().isEmpty()) {
-			List<String> defaultPatterns = new ArrayList<>();
-			defaultPatterns.add("/*");
-			filterConfig.setUrlPatterns(defaultPatterns);
+		if (blockExceptionHandlerOptional.isPresent()) {
+			blockExceptionHandlerOptional
+					.ifPresent(sentinelWebMvcConfig::setBlockExceptionHandler);
+		}
+		else {
+			if (StringUtils.hasText(properties.getBlockPage())) {
+				sentinelWebMvcConfig.setBlockExceptionHandler(((request, response,
+						e) -> response.sendRedirect(properties.getBlockPage())));
+			}
+			else {
+				sentinelWebMvcConfig
+						.setBlockExceptionHandler(new DefaultBlockExceptionHandler());
+			}
 		}

-		registration.addUrlPatterns(filterConfig.getUrlPatterns().toArray(new String[0]));
-		Filter filter = new CommonFilter();
-		registration.setFilter(filter);
-		registration.setOrder(filterConfig.getOrder());
-		registration.addInitParameter("HTTP_METHOD_SPECIFY",
-				String.valueOf(properties.getHttpMethodSpecify()));
-		log.info(
-				"[Sentinel Starter] register Sentinel CommonFilter with urlPatterns: {}.",
-				filterConfig.getUrlPatterns());
-		return registration;
-
+		urlCleanerOptional.ifPresent(sentinelWebMvcConfig::setUrlCleaner);
+		requestOriginParserOptional.ifPresent(sentinelWebMvcConfig::setOriginParser);
+		return sentinelWebMvcConfig;
 	}

 }
--- a/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/custom/SentinelAutoConfiguration.java
+++ b/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/custom/SentinelAutoConfiguration.java
@@ -21,7 +21,6 @@ import javax.annotation.PostConstruct;
 import com.alibaba.cloud.sentinel.SentinelProperties;
 import com.alibaba.cloud.sentinel.datasource.converter.JsonConverter;
 import com.alibaba.cloud.sentinel.datasource.converter.XmlConverter;
-import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
 import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
 import com.alibaba.csp.sentinel.config.SentinelConfig;
 import com.alibaba.csp.sentinel.init.InitExecutor;
@@ -50,6 +49,9 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
 import org.springframework.util.StringUtils;

+import static com.alibaba.cloud.sentinel.SentinelConstants.BLOCK_PAGE_URL_CONF_KEY;
+import static com.alibaba.csp.sentinel.config.SentinelConfig.setConfig;
+
 /**
 * @author xiaojing
 * @author jiashuai.xie
@@ -124,8 +126,8 @@ public class SentinelAutoConfiguration {
 			System.setProperty(SentinelConfig.COLD_FACTOR,
 					properties.getFlow().getColdFactor());
 		}
-		if (StringUtils.hasText(properties.getServlet().getBlockPage())) {
-			WebServletConfig.setBlockPage(properties.getServlet().getBlockPage());
+		if (StringUtils.hasText(properties.getBlockPage())) {
+			setConfig(BLOCK_PAGE_URL_CONF_KEY, properties.getBlockPage());
 		}

 		// earlier initialize
--- a/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/endpoint/SentinelEndpoint.java
+++ b/spring-cloud-alibaba-sentinel/src/main/java/com/alibaba/cloud/sentinel/endpoint/SentinelEndpoint.java
@@ -20,7 +20,6 @@ import java.util.HashMap;
 import java.util.Map;

 import com.alibaba.cloud.sentinel.SentinelProperties;
-import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
 import com.alibaba.csp.sentinel.config.SentinelConfig;
 import com.alibaba.csp.sentinel.log.LogBase;
 import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRuleManager;
@@ -34,6 +33,8 @@ import com.alibaba.csp.sentinel.util.AppNameUtil;
 import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
 import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;

+import static com.alibaba.cloud.sentinel.SentinelConstants.BLOCK_PAGE_URL_CONF_KEY;
+
 /**
 * Endpoint for Sentinel, contains ans properties and rules.
 *
@@ -56,7 +57,7 @@ public class SentinelEndpoint {
 			result.put("appName", AppNameUtil.getAppName());
 			result.put("logDir", LogBase.getLogBaseDir());
 			result.put("logUsePid", LogBase.isLogNameUsePid());
-			result.put("blockPage", WebServletConfig.getBlockPage());
+			result.put("blockPage", SentinelConfig.getConfig(BLOCK_PAGE_URL_CONF_KEY));
 			result.put("metricsFileSize", SentinelConfig.singleMetricFileSize());
 			result.put("metricsFileCharset", SentinelConfig.charset());
 			result.put("totalMetricsFileCount", SentinelConfig.totalMetricFileCount());
--- a/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/additional-spring-configuration-metadata.json
+++ b/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -43,13 +43,13 @@
      "name": "spring.cloud.sentinel.filter.order",
      "type": "java.lang.Integer",
      "defaultValue": "Integer.MIN_VALUE",
-      "description": "sentinel filter chain order, will be set to FilterRegistrationBean."
+      "description": "SentinelWebInterceptor order, will be register to InterceptorRegistry."
    },
    {
      "name": "spring.cloud.sentinel.filter.enabled",
      "type": "java.lang.Boolean",
      "defaultValue": true,
-      "description": "Enable to instance com.alibaba.csp.sentinel.adapter.servlet.CommonFilter."
+      "description": "Enable to register com.alibaba.csp.sentinel.adapter.spring.webmvc.SentinelWebInterceptor."
    },
    {
      "name": "spring.cloud.sentinel.metric.charset",
@@ -79,10 +79,15 @@
      "description": "log file should with pid."
    },
    {
-      "name": "spring.cloud.sentinel.servlet.blockPage",
+      "name": "spring.cloud.sentinel.block-page",
      "type": "java.lang.String",
      "description": "the process page when the flow control is triggered."
    },
+    {
+      "name": "spring.cloud.sentinel.servlet.block-page",
+      "type": "java.lang.String",
+      "description": "recommoned use spring.cloud.sentinel.block-page."
+    },
    {
      "name": "spring.cloud.sentinel.flow.coldFactor",
      "type": "java.lang.String",