Polish #615

spring-cloud-alibaba-sentinel-zuul/pom.xml

@@ -17,12 +17,21 @@
         <dependency>
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
-            <scope>provided</scope>
+            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>com.alibaba.csp</groupId>
             <artifactId>sentinel-zuul-adapter</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.alibaba.csp</groupId>
+            <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-gateway</artifactId>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-configuration-processor</artifactId>

spring-cloud-alibaba-sentinel-zuul/src/main/java/org/springframework/cloud/alibaba/sentinel/zuul/SentinelSpringCloudGatewayAutoConfiguration.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright (C) 2018 the original author or authors.
+ *
+ * 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 org.springframework.cloud.alibaba.sentinel.zuul;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
+import javax.annotation.PostConstruct;
+
+import com.alibaba.csp.sentinel.adapter.gateway.sc.SentinelGatewayFilter;
+import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
+import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
+import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.cloud.gateway.filter.GlobalFilter;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.codec.ServerCodecConfigurer;
+import org.springframework.web.reactive.result.view.ViewResolver;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@Configuration
+@ConditionalOnClass(GlobalFilter.class)
+@ConditionalOnProperty(prefix = "spring.cloud.sentinel.spring-cloud-gateway", name = "enabled", havingValue = "true",
+    matchIfMissing = true)
+public class SentinelSpringCloudGatewayAutoConfiguration {
+
+    private static final Logger logger = LoggerFactory
+        .getLogger(SentinelSpringCloudGatewayAutoConfiguration.class);
+
+    private final List<ViewResolver> viewResolvers;
+    private final ServerCodecConfigurer serverCodecConfigurer;
+
+    @Autowired
+    private Optional<BlockRequestHandler> blockRequestHandlerOptional;
+
+    @PostConstruct
+    private void init() {
+        blockRequestHandlerOptional
+            .ifPresent(GatewayCallbackManager::setBlockHandler);
+    }
+
+    public SentinelSpringCloudGatewayAutoConfiguration(
+        ObjectProvider<List<ViewResolver>> viewResolversProvider,
+        ServerCodecConfigurer serverCodecConfigurer) {
+        this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
+        this.serverCodecConfigurer = serverCodecConfigurer;
+    }
+
+    @Bean
+    @Order(Ordered.HIGHEST_PRECEDENCE)
+    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
+        // Register the block exception handler for Spring Cloud Gateway.
+        logger.info("[Sentinel SpringCloudGateway] register SentinelGatewayBlockExceptionHandler");
+        return new SentinelGatewayBlockExceptionHandler(viewResolvers,
+            serverCodecConfigurer);
+    }
+
+    @Bean
+    @Order(-1)
+    public GlobalFilter sentinelGatewayFilter() {
+        logger.info("[Sentinel SpringCloudGateway] register SentinelGatewayFilter");
+        return new SentinelGatewayFilter();
+    }
+
+}

spring-cloud-alibaba-sentinel-zuul/src/main/java/org/springframework/cloud/alibaba/sentinel/zuul/SentinelZuulAutoConfiguration.java

@@ -16,22 +16,28 @@
 
 package org.springframework.cloud.alibaba.sentinel.zuul;
 
-import static org.springframework.cloud.commons.util.InetUtilsProperties.PREFIX;
+import java.util.Optional;
 
-import org.springframework.beans.factory.support.DefaultListableBeanFactory;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.cloud.alibaba.sentinel.zuul.handler.FallBackProviderHandler;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
+import javax.annotation.PostConstruct;
 
-import com.alibaba.csp.sentinel.adapter.gateway.zuul.callback.DefaultRequestOriginParser;
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.callback.RequestOriginParser;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.callback.ZuulGatewayCallbackManager;
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.filters.SentinelZuulErrorFilter;
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.filters.SentinelZuulPostFilter;
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.filters.SentinelZuulPreFilter;
 
 import com.netflix.zuul.ZuulFilter;
+import com.netflix.zuul.http.ZuulServlet;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.cloud.alibaba.sentinel.zuul.handler.FallBackProviderHandler;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
 
 /**
  * Sentinel Spring Cloud Zuul AutoConfiguration
@@ -39,35 +45,71 @@ import com.netflix.zuul.ZuulFilter;
  * @author tiger
  */
 @Configuration
-@ConditionalOnProperty(prefix = PREFIX, name = "enabled", havingValue = "true", matchIfMissing = true)
+@ConditionalOnClass(ZuulServlet.class)
+@ConditionalOnProperty(prefix = SentinelZuulAutoConfiguration.PREFIX, name = "enabled", havingValue = "true",
+    matchIfMissing = true)
 public class SentinelZuulAutoConfiguration {
 
-	@Bean
-	@ConditionalOnMissingBean(RequestOriginParser.class)
-	public RequestOriginParser requestOriginParser() {
-		return new DefaultRequestOriginParser();
-	}
+    private static final Logger logger = LoggerFactory
+        .getLogger(SentinelZuulAutoConfiguration.class);
 
-	@Bean
-	public ZuulFilter sentinelZuulPreFilter() {
-		// We can also provider the filter order in the constructor.
-		return new SentinelZuulPreFilter();
-	}
+    public static final String PREFIX = "spring.cloud.sentinel.zuul";
 
-	@Bean
-	public ZuulFilter sentinelZuulPostFilter() {
-		return new SentinelZuulPostFilter();
-	}
+    @Autowired
+    private Environment environment;
 
-	@Bean
-	public ZuulFilter sentinelZuulErrorFilter() {
-		return new SentinelZuulErrorFilter();
-	}
+    @Autowired
+    private Optional<RequestOriginParser> requestOriginParserOptional;
 
-	@Bean
-	public FallBackProviderHandler fallBackProviderListener(
-			DefaultListableBeanFactory beanFactory) {
-		return new FallBackProviderHandler(beanFactory);
-	}
+    @PostConstruct
+    private void init() {
+        requestOriginParserOptional
+            .ifPresent(ZuulGatewayCallbackManager::setOriginParser);
+    }
+
+    @Bean
+    public ZuulFilter sentinelZuulPreFilter() {
+        String preOrderStr = environment.getProperty(PREFIX + "." + "order.pre");
+        int order = 10000;
+        try {
+            order = Integer.parseInt(preOrderStr);
+        } catch (NumberFormatException e) {
+            // ignore
+        }
+        logger.info("[Sentinel Zuul] register SentinelZuulPreFilter {}", order);
+        return new SentinelZuulPreFilter(order);
+    }
+
+    @Bean
+    public ZuulFilter sentinelZuulPostFilter() {
+        String postOrderStr = environment.getProperty(PREFIX + "." + "order.post");
+        int order = 1000;
+        try {
+            order = Integer.parseInt(postOrderStr);
+        } catch (NumberFormatException e) {
+            // ignore
+        }
+        logger.info("[Sentinel Zuul] register SentinelZuulPostFilter {}", order);
+        return new SentinelZuulPostFilter(order);
+    }
+
+    @Bean
+    public ZuulFilter sentinelZuulErrorFilter() {
+        String errorOrderStr = environment.getProperty(PREFIX + "." + "order.error");
+        int order = -1;
+        try {
+            order = Integer.parseInt(errorOrderStr);
+        } catch (NumberFormatException e) {
+            // ignore
+        }
+        logger.info("[Sentinel Zuul] register SentinelZuulErrorFilter {}", order);
+        return new SentinelZuulErrorFilter(order);
+    }
+
+    @Bean
+    public FallBackProviderHandler fallBackProviderHandler(
+        DefaultListableBeanFactory beanFactory) {
+        return new FallBackProviderHandler(beanFactory);
+    }
 
 }

spring-cloud-alibaba-sentinel-zuul/src/main/java/org/springframework/cloud/alibaba/sentinel/zuul/handler/FallBackProviderHandler.java

@@ -2,11 +2,11 @@ package org.springframework.cloud.alibaba.sentinel.zuul.handler;
 
 import java.util.Map;
 
-import org.apache.commons.collections.MapUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.SmartInitializingSingleton;
 import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.util.CollectionUtils;
 
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.DefaultBlockFallbackProvider;
 import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.ZuulBlockFallbackManager;
@@ -30,7 +30,7 @@ public class FallBackProviderHandler implements SmartInitializingSingleton {
 	public void afterSingletonsInstantiated() {
 		Map<String, ZuulBlockFallbackProvider> providerMap = beanFactory
 				.getBeansOfType(ZuulBlockFallbackProvider.class);
-		if (MapUtils.isNotEmpty(providerMap)) {
+		if (!CollectionUtils.isEmpty(providerMap)) {
 			providerMap.forEach((k, v) -> {
 				logger.info("[Sentinel Zuul] Register provider name:{}, instance: {}", k,
 						v);

spring-cloud-alibaba-sentinel-zuul/src/main/resources/META-INF/spring.factories

@@ -1,2 +1,3 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.springframework.cloud.alibaba.sentinel.zuul.SentinelZuulAutoConfiguration
+org.springframework.cloud.alibaba.sentinel.zuul.SentinelZuulAutoConfiguration,\
+org.springframework.cloud.alibaba.sentinel.zuul.SentinelSpringCloudGatewayAutoConfiguration