Polish alibaba/spring-cloud-alibaba/#1283 : Renaming spring-cloud-starter-alibaba to be spring-cloud-alibaba-starters

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/README.md

@@ -0,0 +1,141 @@
+# Sentinel Spring Cloud Zuul Adapter
+
+Zuul does not provide rateLimit function, If use default `SentinelRibbonFilter` route filter. it wrapped by Hystrix Command. so only provide Service level 
+circuit protect. 
+
+Sentinel can provide `ServiceId` level and `API Path` level flow control for spring cloud zuul gateway service. 
+
+*Note*: this project is for zuul 1.
+
+## How to use
+
+1. Add maven dependency
+
+```xml
+<dependency>
+    <groupId>com.alibaba.cloud</groupId>
+    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
+    <version>x.y.z</version>
+</dependency>
+
+```
+
+2. Set application.property
+
+```
+// default value is false
+spring.cloud.sentinel.zuul.enabled=true
+```
+
+## How it works
+
+As Zuul run as per thread per connection block model, we add filters around `route Filter` to trace sentinel statistics.   
+
+- `SentinelPreFilter`: Get an entry of resource,the first order is **ServiceId**, then **API Path**. 
+- `SentinelPostFilter`: When success response,exit entry.
+- `SentinelErrorFilter`:  When get an `Exception`, trace the exception and exit context. 
+
+
+the order of Filter can be changed by configuration:
+
+```
+spring.cloud.sentinel.zuul.order.post=0
+spring.cloud.sentinel.zuul.order.pre=10000
+spring.cloud.sentinel.zuul.order.error=-1
+```
+
+
+Filters create structure like:
+
+
+```bash
+
+EntranceNode: machine-root(t:3 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+-EntranceNode: coke(t:2 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+--coke(t:2 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+---/coke/uri(t:0 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+-EntranceNode: sentinel_default_context(t:0 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+-EntranceNode: book(t:1 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+--book(t:1 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+---/book/uri(t:0 pq:0 bq:0 tq:0 rt:0 prq:0 1mp:0 1mb:0 1mt:0)
+
+```
+
+`book` and `coke` are serviceId. 
+
+`---/book/uri` is api path, the real uri is `/uri`. 
+
+
+## Integration with Sentinel DashBord
+
+Start [Sentinel DashBord](https://github.com/alibaba/Sentinel/wiki/%E6%8E%A7%E5%88%B6%E5%8F%B0).
+
+## Rule config with dataSource
+
+Sentinel has full rule config features. see [Dynamic-Rule-Configuration](https://github.com/alibaba/Sentinel/wiki/Dynamic-Rule-Configuration)
+
+
+## Custom Fallbacks
+
+Implements `SentinelFallbackProvider` to define your own Fallback Provider when Sentinel Block Exception throwing for different rout. the default 
+Fallback Provider is `DefaultBlockFallbackProvider`. 
+
+By default Fallback route is `ServiveId + URI PATH`, example `/book/coke`, first `book` is serviceId, `/uri` is URI PATH, so both  
+can be needed.
+
+Here is an example:
+
+```java
+
+// custom provider 
+public class MyCokeServiceBlockFallbackProvider implements SentinelFallbackProvider {
+
+    private Logger logger = LoggerFactory.getLogger(DefaultBlockFallbackProvider.class);
+    
+    // you can define root as service level 
+    @Override
+    public String getRoute() {
+        return "/coke/uri";
+    }
+
+    @Override
+    public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
+        if (cause instanceof BlockException) {
+            logger.info("get in fallback block exception:{}", cause);
+            return response(HttpStatus.TOO_MANY_REQUESTS, route);
+        } else {
+            return response(HttpStatus.INTERNAL_SERVER_ERROR, route);
+        }
+    }
+ }
+
+```
+
+## Custom Request Origin Parser
+By default this adapter use `DefaultRequestOriginParser` to parse sentinel origin.
+
+```java
+
+public class CustomRequestOriginParser implements RequestOriginParser {
+    @Override
+    public String parseOrigin(HttpServletRequest request) {
+        // do custom logic.
+        return "";
+    }
+}
+
+```
+
+## Custom UrlCleaner
+By default this adapter use `DefaultUrlCleaner` to define uri resource. 
+
+```java
+public class CustomUrlCleaner implements UrlCleaner {
+
+    @Override
+    public String clean(String originUrl) {
+        // do custom logic.
+        return originUrl;
+    }
+}
+```

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/pom.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>com.alibaba.cloud</groupId>
+        <artifactId>spring-cloud-alibaba-starters</artifactId>
+        <version>2.2.1.BUILD-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
+    <name>Spring Cloud Alibaba Sentinel Gateway</name>
+
+    <dependencies>
+
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>com.alibaba.csp</groupId>
+            <artifactId>sentinel-api-gateway-adapter-common</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.alibaba.csp</groupId>
+            <artifactId>sentinel-parameter-flow-control</artifactId>
+        </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>com.alibaba.cloud</groupId>
+            <artifactId>spring-cloud-alibaba-sentinel-datasource</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-gateway</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-xml</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/ConfigConstants.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway;
+
+import com.alibaba.cloud.sentinel.gateway.scg.SentinelGatewayProperties;
+import com.alibaba.cloud.sentinel.gateway.zuul.SentinelZuulProperties;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+public final class ConfigConstants {
+
+	/**
+	 * Netflix Zuul type.
+	 */
+	public static final String APP_TYPE_ZUUL_GATEWAY = "12";
+
+	/**
+	 * Spring Cloud Gateway type.
+	 */
+	public static final String APP_TYPE_SCG_GATEWAY = "11";
+
+	/**
+	 * ConfigurationProperties for {@link SentinelZuulProperties}.
+	 */
+	public static final String ZUUl_PREFIX = "spring.cloud.sentinel.zuul";
+
+	/**
+	 * ConfigurationProperties for {@link SentinelGatewayProperties}.
+	 */
+	public static final String GATEWAY_PREFIX = "spring.cloud.sentinel.scg";
+
+	/**
+	 * Response type for Spring Cloud Gateway fallback.
+	 */
+	public static final String FALLBACK_MSG_RESPONSE = "response";
+
+	/**
+	 * Redirect type for Spring Cloud Gateway fallback.
+	 */
+	public static final String FALLBACK_REDIRECT = "redirect";
+
+	private ConfigConstants() {
+		throw new AssertionError("Must not instantiate constant utility class");
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/FallbackProperties.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+public class FallbackProperties {
+
+	/**
+	 * The fallback mode for sentinel spring-cloud-gateway. choose `redirect` or
+	 * `response`.
+	 */
+	private String mode;
+
+	/**
+	 * Redirect Url for `redirect` mode.
+	 */
+	private String redirect;
+
+	/**
+	 * Response Body for `response` mode.
+	 */
+	private String responseBody;
+
+	/**
+	 * Response Status for `response` mode.
+	 */
+	private Integer responseStatus = HttpStatus.TOO_MANY_REQUESTS.value();
+
+	/**
+	 * Content-Type for `response` mode.
+	 */
+	private String contentType = MediaType.APPLICATION_JSON.toString();
+
+	public String getMode() {
+		return mode;
+	}
+
+	public FallbackProperties setMode(String mode) {
+		this.mode = mode;
+		return this;
+	}
+
+	public String getRedirect() {
+		return redirect;
+	}
+
+	public FallbackProperties setRedirect(String redirect) {
+		this.redirect = redirect;
+		return this;
+	}
+
+	public String getResponseBody() {
+		return responseBody;
+	}
+
+	public FallbackProperties setResponseBody(String responseBody) {
+		this.responseBody = responseBody;
+		return this;
+	}
+
+	public Integer getResponseStatus() {
+		return responseStatus;
+	}
+
+	public FallbackProperties setResponseStatus(Integer responseStatus) {
+		this.responseStatus = responseStatus;
+		return this;
+	}
+
+	public String getContentType() {
+		return contentType;
+	}
+
+	public FallbackProperties setContentType(String contentType) {
+		this.contentType = contentType;
+		return this;
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/GatewayEnvironmentPostProcessor.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.env.EnvironmentPostProcessor;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.MapPropertySource;
+import org.springframework.core.env.MutablePropertySources;
+import org.springframework.core.env.PropertySource;
+
+/**
+ * @author zhuhonghan
+ */
+public class GatewayEnvironmentPostProcessor implements EnvironmentPostProcessor {
+
+	private final static String SENTINEL_FILTER_ENABLED = "spring.cloud.sentinel.filter.enabled";
+
+	private final static String PROPERTY_SOURCE_NAME = "defaultProperties";
+
+	@Override
+	public void postProcessEnvironment(ConfigurableEnvironment environment,
+			SpringApplication springApplication) {
+		addDefaultPropertySource(environment);
+	}
+
+	private void addDefaultPropertySource(ConfigurableEnvironment environment) {
+
+		Map<String, Object> map = new HashMap<String, Object>();
+
+		configureDefaultProperties(map);
+
+		addOrReplace(environment.getPropertySources(), map);
+	}
+
+	private void configureDefaultProperties(Map<String, Object> source) {
+		// Required Properties
+		source.put(SENTINEL_FILTER_ENABLED, "false");
+	}
+
+	private void addOrReplace(MutablePropertySources propertySources,
+			Map<String, Object> map) {
+		MapPropertySource target = null;
+		if (propertySources.contains(PROPERTY_SOURCE_NAME)) {
+			PropertySource<?> source = propertySources.get(PROPERTY_SOURCE_NAME);
+			if (source instanceof MapPropertySource) {
+				target = (MapPropertySource) source;
+				for (String key : map.keySet()) {
+					if (!target.containsProperty(key)) {
+						target.getSource().put(key, map.get(key));
+					}
+				}
+			}
+		}
+		if (target == null) {
+			target = new MapPropertySource(PROPERTY_SOURCE_NAME, map);
+		}
+		if (!propertySources.contains(PROPERTY_SOURCE_NAME)) {
+			propertySources.addLast(target);
+		}
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/SentinelGatewayAutoConfiguration.java

@@ -0,0 +1,164 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import com.alibaba.cloud.sentinel.datasource.converter.JsonConverter;
+import com.alibaba.cloud.sentinel.datasource.converter.XmlConverter;
+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.ApiPredicateGroupItem;
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPredicateItem;
+import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.Version;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnProperty(name = "spring.cloud.sentinel.enabled", matchIfMissing = true)
+public class SentinelGatewayAutoConfiguration {
+
+	@ConditionalOnClass(ObjectMapper.class)
+	@Configuration(proxyBeanMethods = false)
+	protected static class SentinelConverterConfiguration {
+
+		static class ApiPredicateItemDeserializer
+				extends StdDeserializer<ApiPredicateItem> {
+
+			private Map<String, Class<? extends ApiPredicateItem>> registry = new HashMap<String, Class<? extends ApiPredicateItem>>();
+
+			ApiPredicateItemDeserializer() {
+				super(ApiPredicateItem.class);
+			}
+
+			void registerApiPredicateItem(String uniqueAttribute,
+					Class<? extends ApiPredicateItem> apiPredicateItemClass) {
+				registry.put(uniqueAttribute, apiPredicateItemClass);
+			}
+
+			@Override
+			public ApiPredicateItem deserialize(JsonParser jp,
+					DeserializationContext ctxt) throws IOException {
+				ObjectMapper mapper = (ObjectMapper) jp.getCodec();
+				ObjectNode root = mapper.readTree(jp);
+				Class<? extends ApiPredicateItem> apiPredicateItemClass = null;
+				Iterator<Entry<String, JsonNode>> elementsIterator = root.fields();
+				while (elementsIterator.hasNext()) {
+					Entry<String, JsonNode> element = elementsIterator.next();
+					String name = element.getKey();
+					if (registry.containsKey(name)) {
+						apiPredicateItemClass = registry.get(name);
+						break;
+					}
+				}
+				if (apiPredicateItemClass == null) {
+					return null;
+				}
+				return mapper.readValue(root.toString(), apiPredicateItemClass);
+			}
+
+		}
+
+		@Configuration(proxyBeanMethods = false)
+		protected static class SentinelJsonConfiguration {
+
+			private ObjectMapper objectMapper = new ObjectMapper();
+
+			public SentinelJsonConfiguration() {
+				objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,
+						false);
+
+				ApiPredicateItemDeserializer deserializer = new ApiPredicateItemDeserializer();
+				deserializer.registerApiPredicateItem("pattern",
+						ApiPathPredicateItem.class);
+				deserializer.registerApiPredicateItem("items",
+						ApiPredicateGroupItem.class);
+				SimpleModule module = new SimpleModule(
+						"PolymorphicApiPredicateItemDeserializerModule",
+						new Version(1, 0, 0, null));
+				module.addDeserializer(ApiPredicateItem.class, deserializer);
+				objectMapper.registerModule(module);
+			}
+
+			@Bean("sentinel-json-gw-flow-converter")
+			public JsonConverter jsonGatewayFlowConverter() {
+				return new JsonConverter(objectMapper, GatewayFlowRule.class);
+			}
+
+			@Bean("sentinel-json-gw-api-group-converter")
+			public JsonConverter jsonApiConverter() {
+				return new JsonConverter(objectMapper, ApiDefinition.class);
+			}
+
+		}
+
+		@ConditionalOnClass(XmlMapper.class)
+		@Configuration(proxyBeanMethods = false)
+		protected static class SentinelXmlConfiguration {
+
+			private XmlMapper xmlMapper = new XmlMapper();
+
+			public SentinelXmlConfiguration() {
+				xmlMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,
+						false);
+				ApiPredicateItemDeserializer deserializer = new ApiPredicateItemDeserializer();
+				deserializer.registerApiPredicateItem("pattern",
+						ApiPathPredicateItem.class);
+				deserializer.registerApiPredicateItem("items",
+						ApiPredicateGroupItem.class);
+				SimpleModule module = new SimpleModule(
+						"PolymorphicGatewayDeserializerModule",
+						new Version(1, 0, 0, null));
+				module.addDeserializer(ApiPredicateItem.class, deserializer);
+				xmlMapper.registerModule(module);
+			}
+
+			@Bean("sentinel-xml-gw-flow-converter")
+			public XmlConverter xmlGatewayFlowConverter() {
+				return new XmlConverter(xmlMapper, GatewayFlowRule.class);
+			}
+
+			@Bean("sentinel-xml-gw-api-group-converter")
+			public XmlConverter xmlApiConverter() {
+				return new XmlConverter(xmlMapper, ApiDefinition.class);
+			}
+
+		}
+
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/scg/SentinelGatewayProperties.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway.scg;
+
+import com.alibaba.cloud.sentinel.gateway.ConfigConstants;
+import com.alibaba.cloud.sentinel.gateway.FallbackProperties;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
+import org.springframework.core.Ordered;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@ConfigurationProperties(prefix = ConfigConstants.GATEWAY_PREFIX)
+public class SentinelGatewayProperties {
+
+	@NestedConfigurationProperty
+	private FallbackProperties fallback;
+
+	private Integer order = Ordered.HIGHEST_PRECEDENCE;
+
+	public FallbackProperties getFallback() {
+		return fallback;
+	}
+
+	public SentinelGatewayProperties setFallback(FallbackProperties fallback) {
+		this.fallback = fallback;
+		return this;
+	}
+
+	public Integer getOrder() {
+		return order;
+	}
+
+	public void setOrder(Integer order) {
+		this.order = order;
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/scg/SentinelSCGAutoConfiguration.java

@@ -0,0 +1,149 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway.scg;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
+import javax.annotation.PostConstruct;
+
+import com.alibaba.cloud.sentinel.gateway.ConfigConstants;
+import com.alibaba.cloud.sentinel.gateway.FallbackProperties;
+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.callback.RedirectBlockRequestHandler;
+import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
+import com.alibaba.csp.sentinel.config.SentinelConfig;
+import com.alibaba.csp.sentinel.util.StringUtil;
+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.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+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.MediaType;
+import org.springframework.http.codec.ServerCodecConfigurer;
+import org.springframework.web.reactive.function.server.ServerResponse;
+import org.springframework.web.reactive.result.view.ViewResolver;
+
+import static org.springframework.web.reactive.function.BodyInserters.fromValue;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(GlobalFilter.class)
+@ConditionalOnProperty(prefix = ConfigConstants.GATEWAY_PREFIX, name = "enabled",
+		havingValue = "true", matchIfMissing = true)
+@EnableConfigurationProperties(SentinelGatewayProperties.class)
+public class SentinelSCGAutoConfiguration {
+
+	private static final Logger logger = LoggerFactory
+			.getLogger(SentinelSCGAutoConfiguration.class);
+
+	private final List<ViewResolver> viewResolvers;
+
+	private final ServerCodecConfigurer serverCodecConfigurer;
+
+	@Autowired
+	private Optional<BlockRequestHandler> blockRequestHandlerOptional;
+
+	@Autowired
+	private SentinelGatewayProperties gatewayProperties;
+
+	@PostConstruct
+	private void init() {
+		// blockRequestHandlerOptional has low priority
+		blockRequestHandlerOptional.ifPresent(GatewayCallbackManager::setBlockHandler);
+		initAppType();
+		initFallback();
+	}
+
+	public SentinelSCGAutoConfiguration(
+			ObjectProvider<List<ViewResolver>> viewResolversProvider,
+			ServerCodecConfigurer serverCodecConfigurer) {
+		this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
+		this.serverCodecConfigurer = serverCodecConfigurer;
+	}
+
+	private void initAppType() {
+		System.setProperty(SentinelConfig.APP_TYPE, ConfigConstants.APP_TYPE_SCG_GATEWAY);
+	}
+
+	private void initFallback() {
+		FallbackProperties fallbackProperties = gatewayProperties.getFallback();
+		if (fallbackProperties == null
+				|| StringUtil.isBlank(fallbackProperties.getMode())) {
+			return;
+		}
+		if (ConfigConstants.FALLBACK_MSG_RESPONSE.equals(fallbackProperties.getMode())) {
+			if (StringUtil.isNotBlank(fallbackProperties.getResponseBody())) {
+				GatewayCallbackManager.setBlockHandler((exchange, t) -> ServerResponse
+						.status(fallbackProperties.getResponseStatus())
+						.contentType(
+								MediaType.valueOf(fallbackProperties.getContentType()))
+						.body(fromValue(fallbackProperties.getResponseBody())));
+				logger.info(
+						"[Sentinel SpringCloudGateway] using AnonymousBlockRequestHandler, responseStatus: "
+								+ fallbackProperties.getResponseStatus()
+								+ ", responseBody: "
+								+ fallbackProperties.getResponseBody());
+			}
+		}
+		String redirectUrl = fallbackProperties.getRedirect();
+		if (ConfigConstants.FALLBACK_REDIRECT.equals(fallbackProperties.getMode())
+				&& StringUtil.isNotBlank(redirectUrl)) {
+			GatewayCallbackManager
+					.setBlockHandler(new RedirectBlockRequestHandler(redirectUrl));
+			logger.info(
+					"[Sentinel SpringCloudGateway] using RedirectBlockRequestHandler, redirectUrl: "
+							+ redirectUrl);
+		}
+	}
+
+	@Bean
+	@Order(Ordered.HIGHEST_PRECEDENCE)
+	@ConditionalOnMissingBean
+	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)
+	@ConditionalOnMissingBean
+	public SentinelGatewayFilter sentinelGatewayFilter() {
+		logger.info(
+				"[Sentinel SpringCloudGateway] register SentinelGatewayFilter with order: {}",
+				gatewayProperties.getOrder());
+		return new SentinelGatewayFilter(gatewayProperties.getOrder());
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/zuul/FallBackProviderHandler.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway.zuul;
+
+import java.util.Map;
+
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.DefaultBlockFallbackProvider;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.ZuulBlockFallbackManager;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.ZuulBlockFallbackProvider;
+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;
+
+/**
+ * @author tiger
+ */
+public class FallBackProviderHandler implements SmartInitializingSingleton {
+
+	private static final Logger logger = LoggerFactory
+			.getLogger(FallBackProviderHandler.class);
+
+	private final DefaultListableBeanFactory beanFactory;
+
+	public FallBackProviderHandler(DefaultListableBeanFactory beanFactory) {
+		this.beanFactory = beanFactory;
+	}
+
+	@Override
+	public void afterSingletonsInstantiated() {
+		Map<String, ZuulBlockFallbackProvider> providerMap = beanFactory
+				.getBeansOfType(ZuulBlockFallbackProvider.class);
+		if (!CollectionUtils.isEmpty(providerMap)) {
+			providerMap.forEach((k, v) -> {
+				logger.info("[Sentinel Zuul] Register provider name:{}, instance: {}", k,
+						v);
+				ZuulBlockFallbackManager.registerProvider(v);
+			});
+		}
+		else {
+			logger.info("[Sentinel Zuul] Register default fallback provider. ");
+			ZuulBlockFallbackManager.registerProvider(new DefaultBlockFallbackProvider());
+		}
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/zuul/SentinelZuulAutoConfiguration.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway.zuul;
+
+import java.util.Optional;
+
+import javax.annotation.PostConstruct;
+
+import com.alibaba.cloud.sentinel.gateway.ConfigConstants;
+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.alibaba.csp.sentinel.config.SentinelConfig;
+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.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Sentinel Spring Cloud Zuul AutoConfiguration.
+ *
+ * @author tiger
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(ZuulServlet.class)
+@ConditionalOnProperty(prefix = ConfigConstants.ZUUl_PREFIX, name = "enabled",
+		havingValue = "true", matchIfMissing = true)
+@EnableConfigurationProperties(SentinelZuulProperties.class)
+public class SentinelZuulAutoConfiguration {
+
+	private static final Logger logger = LoggerFactory
+			.getLogger(SentinelZuulAutoConfiguration.class);
+
+	@Autowired
+	private Optional<RequestOriginParser> requestOriginParserOptional;
+
+	@Autowired
+	private SentinelZuulProperties zuulProperties;
+
+	@PostConstruct
+	private void init() {
+		requestOriginParserOptional
+				.ifPresent(ZuulGatewayCallbackManager::setOriginParser);
+		System.setProperty(SentinelConfig.APP_TYPE,
+				String.valueOf(ConfigConstants.APP_TYPE_ZUUL_GATEWAY));
+	}
+
+	@Bean
+	@ConditionalOnMissingBean
+	public SentinelZuulPreFilter sentinelZuulPreFilter() {
+		logger.info("[Sentinel Zuul] register SentinelZuulPreFilter {}",
+				zuulProperties.getOrder().getPre());
+		return new SentinelZuulPreFilter(zuulProperties.getOrder().getPre());
+	}
+
+	@Bean
+	@ConditionalOnMissingBean
+	public SentinelZuulPostFilter sentinelZuulPostFilter() {
+		logger.info("[Sentinel Zuul] register SentinelZuulPostFilter {}",
+				zuulProperties.getOrder().getPost());
+		return new SentinelZuulPostFilter(zuulProperties.getOrder().getPost());
+	}
+
+	@Bean
+	@ConditionalOnMissingBean
+	public SentinelZuulErrorFilter sentinelZuulErrorFilter() {
+		logger.info("[Sentinel Zuul] register SentinelZuulErrorFilter {}",
+				zuulProperties.getOrder().getError());
+		return new SentinelZuulErrorFilter(zuulProperties.getOrder().getError());
+	}
+
+	@Bean
+	public FallBackProviderHandler fallBackProviderHandler(
+			DefaultListableBeanFactory beanFactory) {
+		return new FallBackProviderHandler(beanFactory);
+	}
+
+}

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-gateway/src/main/java/com/alibaba/cloud/sentinel/gateway/zuul/SentinelZuulProperties.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2013-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 com.alibaba.cloud.sentinel.gateway.zuul;
+
+import com.alibaba.cloud.sentinel.gateway.ConfigConstants;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.constants.ZuulConstant;
+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 org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@ConfigurationProperties(prefix = ConfigConstants.ZUUl_PREFIX)
+public class SentinelZuulProperties {
+
+	@NestedConfigurationProperty
+	private SentinelZuulProperties.Order order = new SentinelZuulProperties.Order();
+
+	public Order getOrder() {
+		return order;
+	}
+
+	public SentinelZuulProperties setOrder(Order order) {
+		this.order = order;
+		return this;
+	}
+
+	public static class Order {
+
+		/**
+		 * The order of {@link SentinelZuulPreFilter}.
+		 */
+		private int pre = 10000;
+
+		/**
+		 * The order of {@link SentinelZuulPostFilter}.
+		 */
+		private int post = ZuulConstant.SEND_RESPONSE_FILTER_ORDER;
+
+		/**
+		 * The order of {@link SentinelZuulErrorFilter}.
+		 */
+		private int error = -1;
+
+		public int getPre() {
+			return pre;
+		}
+
+		public void setPre(int pre) {
+			this.pre = pre;
+		}
+
+		public int getPost() {
+			return post;
+		}
+
+		public void setPost(int post) {
+			this.post = post;
+		}
+
+		public int getError() {
+			return error;
+		}
+
+		public void setError(int error) {
+			this.error = error;
+		}
+
+	}
+
+}

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

@@ -0,0 +1,5 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+com.alibaba.cloud.sentinel.gateway.zuul.SentinelZuulAutoConfiguration,\
+com.alibaba.cloud.sentinel.gateway.scg.SentinelSCGAutoConfiguration,\
+com.alibaba.cloud.sentinel.gateway.SentinelGatewayAutoConfiguration
+org.springframework.boot.env.EnvironmentPostProcessor=com.alibaba.cloud.sentinel.gateway.GatewayEnvironmentPostProcessor