Polish #615, add gateway example

spring-cloud-alibaba-examples/pom.xml

@@ -22,6 +22,8 @@
         <module>sentinel-example/sentinel-dubbo-example/sentinel-dubbo-consumer-example</module>
         <module>sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api</module>
         <module>sentinel-example/sentinel-webflux-example</module>
+        <module>sentinel-example/sentinel-spring-cloud-gateway-example</module>
+        <module>sentinel-example/sentinel-zuul-example</module>
         <module>nacos-example/nacos-discovery-example</module>
         <module>nacos-example/nacos-config-example</module>
         <module>nacos-example/nacos-gateway-example</module>

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/pom.xml

@@ -0,0 +1,82 @@
+<?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>org.springframework.cloud</groupId>
+        <artifactId>spring-cloud-alibaba-examples</artifactId>
+        <version>0.9.1.BUILD-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+
+    <artifactId>sentinel-spring-cloud-gateway-example</artifactId>
+    <packaging>jar</packaging>
+    <description>Example demonstrating how to use sentinel with spring cloud gateway</description>
+
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-webflux</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-gateway</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-alibaba-sentinel-zuul</artifactId>
+        </dependency>
+
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-nacos</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-zookeeper</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-apollo</artifactId>-->
+        <!--</dependency>-->
+        <!-- define in spring-boot-autoconfigure module -->
+        <!--<dependency>-->
+        <!--<groupId>com.fasterxml.jackson.dataformat</groupId>-->
+        <!--<artifactId>jackson-dataformat-xml</artifactId>-->
+        <!--</dependency>-->
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <version>${maven-deploy-plugin.version}</version>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/MySCGConfiguration.java

@@ -0,0 +1,48 @@
+/*
+ * 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.cloud.examples;
+
+import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.MediaType;
+import org.springframework.web.reactive.function.server.ServerResponse;
+import org.springframework.web.server.ServerWebExchange;
+import reactor.core.publisher.Mono;
+
+import static org.springframework.web.reactive.function.BodyInserters.fromObject;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@Configuration
+public class MySCGConfiguration {
+
+    @Bean
+    public BlockRequestHandler blockRequestHandler() {
+        return new BlockRequestHandler() {
+            @Override
+            public Mono<ServerResponse> handleRequest(ServerWebExchange exchange, Throwable t) {
+                return ServerResponse.status(444)
+                    .contentType(MediaType.APPLICATION_JSON_UTF8)
+                    .body(fromObject("SCS Sentinel block"));
+            }
+        };
+    }
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/RulesWebFluxController.java

@@ -0,0 +1,54 @@
+/*
+ * 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.cloud.examples;
+
+import java.util.List;
+import java.util.Set;
+
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
+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.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+import reactor.core.publisher.Mono;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@RestController
+public class RulesWebFluxController {
+
+    @GetMapping("/api")
+    public Mono<Set<ApiDefinition>> apiRules() {
+        return Mono.just(GatewayApiDefinitionManager.getApiDefinitions());
+    }
+
+    @GetMapping("/gateway")
+    public Mono<Set<GatewayFlowRule>> apiGateway() {
+        return Mono.just(GatewayRuleManager.getRules());
+    }
+
+    @GetMapping("/flow")
+    public Mono<List<FlowRule>> apiFlow() {
+        return Mono.just(FlowRuleManager.getRules());
+    }
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SentinelSpringCloudGatewayApplication.java

@@ -0,0 +1,33 @@
+/*
+ * 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.cloud.examples;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@SpringBootApplication
+public class SentinelSpringCloudGatewayApplication {
+
+    public static void main(String[] args) {
+        //GatewayCallbackManager.setRequestOriginParser(s -> "123");
+        SpringApplication.run(SentinelSpringCloudGatewayApplication.class, args);
+    }
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/resources/api.json

@@ -0,0 +1,32 @@
+[
+  {
+    "apiName": "some_customized_api",
+    "predicateItems": [
+      {
+        "pattern": "/product/baz"
+      },
+      {
+        "pattern": "/product/foo/**",
+        "matchStrategy": 1
+      },
+      {
+        "items": [
+          {
+            "pattern": "/spring-cloud/**"
+          },
+          {
+            "pattern": "/spring-cloud-alibaba/**"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "apiName": "another_customized_api",
+    "predicateItems": [
+      {
+        "pattern": "/ahas"
+      }
+    ]
+  }
+]

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/resources/application.yaml

@@ -0,0 +1,37 @@
+server:
+  port: 18085
+spring:
+  application:
+    name: sentinel-spring-cloud-gateway
+  cloud:
+    gateway:
+      enabled: true
+      discovery:
+        locator:
+          lower-case-service-id: true
+      routes:
+      # Add your routes here.
+      - id: aliyun_route
+        uri: https://www.aliyun.com/
+        predicates:
+        - Path=/product/**
+      - id: httpbin_route
+        uri: https://httpbin.org
+        predicates:
+        - Path=/httpbin/**
+        filters:
+        - RewritePath=/httpbin/(?<segment>.*), /$\{segment}
+
+    sentinel:
+      datasource.ds2.file:
+        file: "classpath: gateway.json"
+        ruleType: gateway
+      datasource.ds1.file:
+        file: "classpath: api.json"
+        ruleType: api
+      transport:
+        dashboard: localhost:9999
+      filter:
+        enabled: true
+
+management.endpoints.web.exposure.include: "*"

spring-cloud-alibaba-examples/sentinel-example/sentinel-spring-cloud-gateway-example/src/main/resources/gateway.json

@@ -0,0 +1,22 @@
+[
+  {
+    "resource": "some_customized_api",
+    "count": 1
+  },
+  {
+    "resource": "httpbin_route",
+    "count": 0,
+    "paramItem": {
+      "parseStrategy": 2,
+      "fieldName": "Spring-Cloud-Alibaba"
+    }
+  },
+  {
+    "resource": "httpbin_route",
+    "count": 0,
+    "paramItem": {
+      "parseStrategy": 3,
+      "fieldName": "name"
+    }
+  }
+]

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

@@ -0,0 +1,82 @@
+<?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>org.springframework.cloud</groupId>
+        <artifactId>spring-cloud-alibaba-examples</artifactId>
+        <version>0.9.1.BUILD-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+
+    <artifactId>sentinel-zuul-example</artifactId>
+    <packaging>jar</packaging>
+    <description>Example demonstrating how to use sentinel with zuul</description>
+
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-alibaba-sentinel-zuul</artifactId>
+        </dependency>
+
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-nacos</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-zookeeper</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-apollo</artifactId>-->
+        <!--</dependency>-->
+        <!-- define in spring-boot-autoconfigure module -->
+        <!--<dependency>-->
+        <!--<groupId>com.fasterxml.jackson.dataformat</groupId>-->
+        <!--<artifactId>jackson-dataformat-xml</artifactId>-->
+        <!--</dependency>-->
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <version>${maven-deploy-plugin.version}</version>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/RulesController.java

@@ -0,0 +1,53 @@
+/*
+ * 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.cloud.examples;
+
+import java.util.List;
+import java.util.Set;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
+import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
+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.slots.block.flow.FlowRule;
+import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@RestController
+public class RulesController {
+
+	@GetMapping("/api")
+	public Set<ApiDefinition> apiRules() {
+		return GatewayApiDefinitionManager.getApiDefinitions();
+	}
+
+	@GetMapping("/gateway")
+	public Set<GatewayFlowRule> apiGateway() {
+		return GatewayRuleManager.getRules();
+	}
+
+	@GetMapping("/flow")
+	public List<FlowRule> apiFlow() {
+		return FlowRuleManager.getRules();
+	}
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SentinelZuulApplication.java

@@ -0,0 +1,34 @@
+/*
+ * 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.cloud.examples;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@SpringBootApplication
+@EnableZuulProxy
+public class SentinelZuulApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SentinelZuulApplication.class, args);
+    }
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ZuulConfiguration.java

@@ -0,0 +1,68 @@
+/*
+ * 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.cloud.examples;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.callback.RequestOriginParser;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.BlockResponse;
+import com.alibaba.csp.sentinel.adapter.gateway.zuul.fallback.ZuulBlockFallbackProvider;
+
+/**
+ * @author <a href="mailto:fangjian0423@gmail.com">Jim</a>
+ */
+@Configuration
+public class ZuulConfiguration {
+
+	@Bean
+	public ZuulBlockFallbackProvider zuulBlockFallbackProvider1() {
+		return new ZuulBlockFallbackProvider() {
+			@Override
+			public String getRoute() {
+				return "*";
+			}
+
+			@Override
+			public BlockResponse fallbackResponse(String route, Throwable cause) {
+				if (route.equals("my-service3")) {
+					return new BlockResponse(433, "Sentinel Block3", route);
+				}
+				else if (route.equals("my-service4")) {
+					return new BlockResponse(444, "my-service4", route);
+				}
+				else {
+					return new BlockResponse(499, "Sentinel Block 499", route);
+				}
+			}
+		};
+	}
+
+	@Bean
+	public RequestOriginParser requestOriginParser() {
+	    return new RequestOriginParser() {
+
+            @Override
+            public String parseOrigin(HttpServletRequest request) {
+                return "123";
+            }
+        };
+    }
+
+}

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/resources/api.json

@@ -0,0 +1,32 @@
+[
+  {
+    "apiName": "some_customized_api",
+    "predicateItems": [
+      {
+        "pattern": "/product/baz"
+      },
+      {
+        "pattern": "/product/foo/**",
+        "matchStrategy": 1
+      },
+      {
+        "items": [
+          {
+            "pattern": "/spring-cloud/**"
+          },
+          {
+            "pattern": "/spring-cloud-alibaba/**"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "apiName": "another_customized_api",
+    "predicateItems": [
+      {
+        "pattern": "/ahas"
+      }
+    ]
+  }
+]

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/resources/application.yaml

@@ -0,0 +1,40 @@
+server:
+  port: 18086
+spring:
+  application:
+    name: sentinel-zuul
+  cloud:
+    sentinel:
+      datasource.ds2.file:
+        file: "classpath: gateway.json"
+        ruleType: gateway
+      datasource.ds1.file:
+        file: "classpath: api.json"
+        ruleType: api
+      transport:
+        dashboard: localhost:9999
+      filter:
+        enabled: false
+
+management.endpoints.web.exposure.include: "*"
+
+
+zuul.routes.my-service.path: "/product/foo/**"
+zuul.routes.my-service.service-id: "my-service"
+
+zuul.routes.my-service2.path: "/my-service2/**"
+zuul.routes.my-service2.service-id: "my-service2"
+
+zuul.routes.my-service3.path: "/my-service3/**"
+zuul.routes.my-service3.service-id: "my-service3"
+
+zuul.routes.my-service4.path: "/my-service4/**"
+zuul.routes.my-service4.service-id: "my-service4"
+
+
+spring.cloud.sentinel.zuul.order.pre: 2000
+spring.cloud.sentinel.zuul.order.post: 500
+spring.cloud.sentinel.zuul.order.error: -100
+
+
+spring.cloud.sentinel.zuul.enabled: true

spring-cloud-alibaba-examples/sentinel-example/sentinel-zuul-example/src/main/resources/gateway.json

@@ -0,0 +1,26 @@
+[
+  {
+    "resource": "some_customized_api",
+    "count": 0
+  },
+  {
+    "resource": "my-service2",
+    "count": 0
+  },
+  {
+    "resource": "my-service3",
+    "count": 0,
+    "paramItem": {
+      "parseStrategy": 2,
+      "fieldName": "Spring-Cloud-Alibaba"
+    }
+  },
+  {
+    "resource": "my-service4",
+    "count": 0,
+    "paramItem": {
+      "parseStrategy": 3,
+      "fieldName": "name"
+    }
+  }
+]