Merge pull request #632 from fangjian0423/master

[Sentinel] Support Gateway

spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelAutoConfiguration.java

@@ -16,6 +16,12 @@
 
 package org.springframework.cloud.alibaba.sentinel.custom;
 
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Map.Entry;
+
 import javax.annotation.PostConstruct;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -31,8 +37,14 @@ import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConver
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
 import org.springframework.util.StringUtils;
 
+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.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig;
 import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
 import com.alibaba.csp.sentinel.config.SentinelConfig;
@@ -46,8 +58,15 @@ import com.alibaba.csp.sentinel.slots.system.SystemRule;
 import com.alibaba.csp.sentinel.transport.config.TransportConfig;
 import com.alibaba.csp.sentinel.util.AppNameUtil;
 
+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;
 
 /**
@@ -152,81 +171,164 @@ public class SentinelAutoConfiguration {
 
 	@Bean
 	public SentinelDataSourceHandler sentinelDataSourceHandler(
-			DefaultListableBeanFactory beanFactory) {
-		return new SentinelDataSourceHandler(beanFactory);
+			DefaultListableBeanFactory beanFactory, SentinelProperties sentinelProperties,
+			Environment env) {
+		return new SentinelDataSourceHandler(beanFactory, sentinelProperties, env);
 	}
 
 	@ConditionalOnClass(ObjectMapper.class)
+	@Configuration
 	protected static class SentinelConverterConfiguration {
 
-		private ObjectMapper objectMapper = new ObjectMapper();
+		static class ApiPredicateItemDeserializer
+				extends StdDeserializer<ApiPredicateItem> {
+			private Map<String, Class<? extends ApiPredicateItem>> registry = new HashMap<String, Class<? extends ApiPredicateItem>>();
 
-		public SentinelConverterConfiguration() {
-			objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,
-					false);
+			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);
+			}
 		}
 
-		@Bean("sentinel-json-flow-converter")
-		public JsonConverter jsonFlowConverter() {
-			return new JsonConverter(objectMapper, FlowRule.class);
+		@Configuration
+		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-flow-converter")
+			public JsonConverter jsonFlowConverter() {
+				return new JsonConverter(objectMapper, FlowRule.class);
+			}
+
+			@Bean("sentinel-json-degrade-converter")
+			public JsonConverter jsonDegradeConverter() {
+				return new JsonConverter(objectMapper, DegradeRule.class);
+			}
+
+			@Bean("sentinel-json-system-converter")
+			public JsonConverter jsonSystemConverter() {
+				return new JsonConverter(objectMapper, SystemRule.class);
+			}
+
+			@Bean("sentinel-json-authority-converter")
+			public JsonConverter jsonAuthorityConverter() {
+				return new JsonConverter(objectMapper, AuthorityRule.class);
+			}
+
+			@Bean("sentinel-json-param-flow-converter")
+			public JsonConverter jsonParamFlowConverter() {
+				return new JsonConverter(objectMapper, ParamFlowRule.class);
+			}
+
+			@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);
+			}
 		}
 
-		@Bean("sentinel-json-degrade-converter")
-		public JsonConverter jsonDegradeConverter() {
-			return new JsonConverter(objectMapper, DegradeRule.class);
+		@ConditionalOnClass(XmlMapper.class)
+		@Configuration
+		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-flow-converter")
+			public XmlConverter xmlFlowConverter() {
+				return new XmlConverter(xmlMapper, FlowRule.class);
+			}
+
+			@Bean("sentinel-xml-degrade-converter")
+			public XmlConverter xmlDegradeConverter() {
+				return new XmlConverter(xmlMapper, DegradeRule.class);
+			}
+
+			@Bean("sentinel-xml-system-converter")
+			public XmlConverter xmlSystemConverter() {
+				return new XmlConverter(xmlMapper, SystemRule.class);
+			}
+
+			@Bean("sentinel-xml-authority-converter")
+			public XmlConverter xmlAuthorityConverter() {
+				return new XmlConverter(xmlMapper, AuthorityRule.class);
+			}
+
+			@Bean("sentinel-xml-param-flow-converter")
+			public XmlConverter xmlParamFlowConverter() {
+				return new XmlConverter(xmlMapper, ParamFlowRule.class);
+			}
+
+			@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);
+			}
+
 		}
-
-		@Bean("sentinel-json-system-converter")
-		public JsonConverter jsonSystemConverter() {
-			return new JsonConverter(objectMapper, SystemRule.class);
-		}
-
-		@Bean("sentinel-json-authority-converter")
-		public JsonConverter jsonAuthorityConverter() {
-			return new JsonConverter(objectMapper, AuthorityRule.class);
-		}
-
-		@Bean("sentinel-json-param-flow-converter")
-		public JsonConverter jsonParamFlowConverter() {
-			return new JsonConverter(objectMapper, ParamFlowRule.class);
-		}
-
-	}
-
-	@ConditionalOnClass(XmlMapper.class)
-	protected static class SentinelXmlConfiguration {
-
-		private XmlMapper xmlMapper = new XmlMapper();
-
-		public SentinelXmlConfiguration() {
-			xmlMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
-		}
-
-		@Bean("sentinel-xml-flow-converter")
-		public XmlConverter xmlFlowConverter() {
-			return new XmlConverter(xmlMapper, FlowRule.class);
-		}
-
-		@Bean("sentinel-xml-degrade-converter")
-		public XmlConverter xmlDegradeConverter() {
-			return new XmlConverter(xmlMapper, DegradeRule.class);
-		}
-
-		@Bean("sentinel-xml-system-converter")
-		public XmlConverter xmlSystemConverter() {
-			return new XmlConverter(xmlMapper, SystemRule.class);
-		}
-
-		@Bean("sentinel-xml-authority-converter")
-		public XmlConverter xmlAuthorityConverter() {
-			return new XmlConverter(xmlMapper, AuthorityRule.class);
-		}
-
-		@Bean("sentinel-xml-param-flow-converter")
-		public XmlConverter xmlParamFlowConverter() {
-			return new XmlConverter(xmlMapper, ParamFlowRule.class);
-		}
-
 	}
 
 }

spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelDataSourceHandler.java

@@ -1,29 +1,30 @@
 package org.springframework.cloud.alibaba.sentinel.custom;
 
-import com.alibaba.csp.sentinel.datasource.AbstractDataSource;
-import com.alibaba.csp.sentinel.datasource.ReadableDataSource;
-import com.alibaba.csp.sentinel.slots.block.AbstractRule;
+import java.lang.reflect.Field;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.SmartInitializingSingleton;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.cloud.alibaba.sentinel.SentinelProperties;
 import org.springframework.cloud.alibaba.sentinel.datasource.config.AbstractDataSourceProperties;
 import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter;
 import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter;
+import org.springframework.core.env.Environment;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ReflectionUtils;
 import org.springframework.util.StringUtils;
 
-import java.lang.reflect.Field;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
+import com.alibaba.csp.sentinel.datasource.AbstractDataSource;
+import com.alibaba.csp.sentinel.datasource.ReadableDataSource;
 
 /**
  * Sentinel {@link ReadableDataSource} Handler Handle the configurations of
@@ -47,12 +48,16 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton {
 
 	private final DefaultListableBeanFactory beanFactory;
 
-	public SentinelDataSourceHandler(DefaultListableBeanFactory beanFactory) {
-		this.beanFactory = beanFactory;
-	}
+	private final SentinelProperties sentinelProperties;
 
-	@Autowired
-	private SentinelProperties sentinelProperties;
+	private final Environment env;
+
+	public SentinelDataSourceHandler(DefaultListableBeanFactory beanFactory,
+			SentinelProperties sentinelProperties, Environment env) {
+		this.beanFactory = beanFactory;
+		this.sentinelProperties = sentinelProperties;
+		this.env = env;
+	}
 
 	@Override
 	public void afterSingletonsInstantiated() {
@@ -68,6 +73,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton {
 						}
 						AbstractDataSourceProperties abstractDataSourceProperties = dataSourceProperties
 								.getValidDataSourceProperties();
+						abstractDataSourceProperties.setEnv(env);
 						abstractDataSourceProperties.preCheck(dataSourceName);
 						registerBean(abstractDataSourceProperties, dataSourceName
 								+ "-sentinel-" + validFields.get(0) + "-datasource");
@@ -189,7 +195,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton {
 	}
 
 	private void logAndCheckRuleType(AbstractDataSource dataSource, String dataSourceName,
-			Class<? extends AbstractRule> ruleClass) {
+			Class ruleClass) {
 		Object ruleConfig;
 		try {
 			ruleConfig = dataSource.loadConfig();
@@ -199,8 +205,8 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton {
 					+ " loadConfig error: " + e.getMessage(), e);
 			return;
 		}
-		if (ruleConfig instanceof List) {
-			List convertedRuleList = (List) ruleConfig;
+		if (ruleConfig instanceof List || ruleConfig instanceof Set) {
+			Collection convertedRuleList = (Collection) ruleConfig;
 			if (CollectionUtils.isEmpty(convertedRuleList)) {
 				log.warn("[Sentinel Starter] DataSource {} rule list is empty.",
 						dataSourceName);