support jax-rs

sentinel-adapter/pom.xml

@@ -27,6 +27,7 @@
         <module>sentinel-spring-cloud-gateway-adapter</module>
         <module>sentinel-spring-webmvc-adapter</module>
         <module>sentinel-zuul2-adapter</module>
+        <module>sentinel-jax-rs-adapter</module>
     </modules>
 
     <dependencyManagement>

sentinel-adapter/sentinel-jax-rs-adapter/README.md

@@ -0,0 +1,79 @@
+# Sentinel for jax-rs
+
+Sentinel provides filter integration to enable flow control for web requests.
+Add the following dependency in `pom.xml` (if you are using Maven):
+
+```xml
+<dependency>
+    <groupId>com.alibaba.csp</groupId>
+    <artifactId>sentinel-jax-rs-adapter</artifactId>
+    <version>x.y.z</version>
+</dependency>
+```
+
+## SentinelJaxRsProviderFilter
+
+the `SentinelJaxRsProviderFilter` is auto activated in pure jax-rs application.
+
+For Spring web applications you can configure with Spring bean:
+
+```java
+@Configuration
+public class FilterConfig {
+
+    @Bean
+    public SentinelJaxRsProviderFilter sentinelJaxRsProviderFilter() {
+        return new SentinelJaxRsProviderFilter();
+    }
+}
+```
+
+## DefaultExceptionMapper
+
+Sentinel provides DefaultExceptionMapper to map Throwable to Response(with Status.INTERNAL_SERVER_ERROR), in order to let SentinelJaxRsProviderFilter to be called and exit the sentinel entry.
+
+according to `3.3.4 Exceptions` of [jaxrs-2_1-final-spec](https://download.oracle.com/otn-pub/jcp/jaxrs-2_1-final-eval-spec/jaxrs-2_1-final-spec.pdf):
+>Checked exceptions and throwables that have not been mapped and cannot be thrown directly MUSTbe wrapped in a container-specific exception that is then thrown and allowed to propagate to the un-derlying container.
+
+if WebApplicationException or its subclasses is thrown, there are automated converted to Response and can enter response filter.
+
+if throw exception which is not WebApplicationException or its subclass, and not matched by custom exception mapper, then the response filter cannot be called. for this case, I thank a default exception mapper maybe introduced.
+
+according to `4.4 Exception Mapping Providers` of [jaxrs-2_1-final-spec](https://download.oracle.com/otn-pub/jcp/jaxrs-2_1-final-eval-spec/jaxrs-2_1-final-spec.pdf):
+>When choosing an exception mapping provider to map an exception,  an implementation MUST use theprovider whose generic type is the nearest superclass of the exception.  If two or more exception providers are applicable, the one with the highest priority MUST be chosen as described in Section 4.1.3.
+
+if user also provide custom exception mapper of `Throwable`, then user has the responsibility to convert it to response and then the response filter can be called.
+
+as describe in `6.7.1 exceptions` of [jaxrs-2_1-final-spec](https://download.oracle.com/otn-pub/jcp/jaxrs-2_1-final-eval-spec/jaxrs-2_1-final-spec.pdf):
+>A response mapped from an exception MUST be processed using the ContainerResponsefilter chain and theWriteTointerceptor chain (if an entity is present in the mapped response).
+
+## SentinelJaxRsClientTemplate
+
+For jax-rs client, we provide `SentinelJaxRsClientTemplate` you can use it like this:
+
+```
+        Response response = SentinelJaxRsClientTemplate.execute(resourceName, new Supplier<Response>() {
+            @Override
+            public Response get() {
+                return client.target(host).path(url).request()
+                        .get();
+            }
+        });
+```
+
+or executeAsync like this:
+
+```
+        Future<Response> future = SentinelJaxRsClientTemplate.executeAsync(resourceName, new Supplier<Future<Response>>() {
+            @Override
+            public Future<Response> get() {
+                return client.target(host).path(url).request()
+                        .async()
+                        .get();
+            }
+        });
+```
+
+When a request is blocked, Sentinel jax-rs filter will return Response with status of TOO_MANY_REQUESTS indicating the request is rejected.
+
+You can customize it by implement your own `SentinelJaxRsFallback` and register to `SentinelJaxRsConfig`.

sentinel-adapter/sentinel-jax-rs-adapter/pom.xml

@@ -0,0 +1,74 @@
+<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.alibaba.csp</groupId>
+        <artifactId>sentinel-adapter</artifactId>
+        <version>1.8.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>sentinel-jax-rs-adapter</artifactId>
+    <packaging>jar</packaging>
+
+    <properties>
+        <javax.ws.rs-api.version>2.1.1</javax.ws.rs-api.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.alibaba.csp</groupId>
+            <artifactId>sentinel-core</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>javax.ws.rs</groupId>
+            <artifactId>javax.ws.rs-api</artifactId>
+            <version>${javax.ws.rs-api.version}</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <version>2.2.6.RELEASE</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>2.2.6.RELEASE</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.rest-assured</groupId>
+            <artifactId>rest-assured</artifactId>
+            <version>4.3.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.resteasy</groupId>
+            <artifactId>resteasy-spring-boot-starter</artifactId>
+            <version>4.5.1.Final</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <configuration>
+                    <forkMode>always</forkMode>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

sentinel-adapter/sentinel-jax-rs-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/jaxrs/SentinelJaxRsClientTemplate.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 1999-2020 Alibaba Group Holding Ltd.
+ *
+ * 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.csp.sentinel.adapter.jaxrs;
+
+import com.alibaba.csp.sentinel.*;
+import com.alibaba.csp.sentinel.adapter.jaxrs.config.SentinelJaxRsConfig;
+import com.alibaba.csp.sentinel.adapter.jaxrs.future.FutureWrapper;
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import com.alibaba.csp.sentinel.util.function.Supplier;
+
+import javax.ws.rs.core.Response;
+import java.util.concurrent.Future;
+
+
+/**
+ * wrap jax-rs client execution with sentinel
+ * <pre>
+ *         Response response = SentinelJaxRsClientTemplate.execute(resourceName, new Supplier<Response>() {
+ *
+ *             @Override
+ *             public Response get() {
+ *                 return client.target(host).path(url).request()
+ *                         .get();
+ *             }
+ *         });
+ * </pre>
+ * @author sea
+ */
+public class SentinelJaxRsClientTemplate {
+
+    /**
+     * execute supplier with sentinel
+     * @param resourceName
+     * @param supplier
+     * @return
+     */
+    public static Response execute(String resourceName, Supplier<Response> supplier) {
+        Entry entry = null;
+        try {
+            entry = SphU.entry(resourceName, ResourceTypeConstants.COMMON_WEB, EntryType.OUT);
+            return supplier.get();
+        } catch (BlockException ex) {
+            return SentinelJaxRsConfig.getJaxRsFallback().fallbackResponse(resourceName, ex);
+        } finally {
+            System.out.println("entry exit");
+            if (entry != null) {
+                entry.exit();
+            }
+        }
+    }
+
+    /**
+     * execute supplier with sentinel
+     * @param resourceName
+     * @param supplier
+     * @return
+     */
+    public static Future<Response> executeAsync(String resourceName, Supplier<Future<Response>> supplier) {
+        try {
+            AsyncEntry entry = SphU.asyncEntry(resourceName, ResourceTypeConstants.COMMON_WEB, EntryType.OUT);
+            return new FutureWrapper<>(entry, supplier.get());
+        } catch (BlockException ex) {
+            return SentinelJaxRsConfig.getJaxRsFallback().fallbackFutureResponse(resourceName, ex);
+        }
+    }
+}

sentinel-adapter/sentinel-jax-rs-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/jaxrs/SentinelJaxRsProviderFilter.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright 1999-2020 Alibaba Group Holding Ltd.
+ *
+ * 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.csp.sentinel.adapter.jaxrs;
+
+import com.alibaba.csp.sentinel.*;
+import com.alibaba.csp.sentinel.adapter.jaxrs.config.SentinelJaxRsConfig;
+import com.alibaba.csp.sentinel.context.ContextUtil;
+import com.alibaba.csp.sentinel.slots.block.BlockException;
+import com.alibaba.csp.sentinel.util.StringUtil;
+
+import javax.ws.rs.container.*;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.ext.Provider;
+import java.io.IOException;
+
+/**
+ * @author sea
+ */
+@Provider
+public class SentinelJaxRsProviderFilter implements ContainerRequestFilter, ContainerResponseFilter {
+
+    private static final String SENTINEL_JAX_RS_PROVIDER_CONTEXT_NAME = "sentinel_jax_rs_provider_context";
+
+
+    private static final String SENTINEL_JAX_RS_PROVIDER_ENTRY_PROPERTY = "sentinel_jax_rs_provider_entry_property";
+
+    @Context
+    private ResourceInfo resourceInfo;
+
+    @Override
+    public void filter(ContainerRequestContext containerRequestContext) throws IOException {
+
+        try {
+            String resourceName = getResourceName(containerRequestContext, resourceInfo);
+
+            if (StringUtil.isNotEmpty(resourceName)) {
+                // Parse the request origin using registered origin parser.
+                String origin = parseOrigin(containerRequestContext);
+                String contextName = getContextName(containerRequestContext);
+                ContextUtil.enter(contextName, origin);
+                Entry entry = SphU.entry(resourceName, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
+
+                containerRequestContext.setProperty(SENTINEL_JAX_RS_PROVIDER_ENTRY_PROPERTY, entry);
+            }
+        } catch (BlockException e) {
+            try {
+                containerRequestContext.abortWith(SentinelJaxRsConfig.getJaxRsFallback().fallbackResponse(containerRequestContext.getUriInfo().getPath(), e));
+            } finally {
+                ContextUtil.exit();
+            }
+        }
+    }
+
+    @Override
+    public void filter(ContainerRequestContext containerRequestContext, ContainerResponseContext containerResponseContext) throws IOException {
+        Entry entry = (Entry) containerRequestContext.getProperty(SENTINEL_JAX_RS_PROVIDER_ENTRY_PROPERTY);
+        if (entry != null) {
+            entry.exit();
+        }
+        containerRequestContext.removeProperty(SENTINEL_JAX_RS_PROVIDER_ENTRY_PROPERTY);
+        ContextUtil.exit();
+    }
+
+    public String getResourceName(ContainerRequestContext containerRequestContext, ResourceInfo resourceInfo) {
+        return SentinelJaxRsConfig.getResourceNameParser().parse(containerRequestContext, resourceInfo);
+    }
+
+    protected String getContextName(ContainerRequestContext request) {
+        return SENTINEL_JAX_RS_PROVIDER_CONTEXT_NAME;
+    }
+
+    protected String parseOrigin(ContainerRequestContext request) {
+        return SentinelJaxRsConfig.getRequestOriginParser().parseOrigin(request);
+    }
+}

sentinel-adapter/sentinel-jax-rs-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/jaxrs/config/SentinelJaxRsConfig.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 1999-2020 Alibaba Group Holding Ltd.
+ *
+ * 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.csp.sentinel.adapter.jaxrs.config;
+
+import com.alibaba.csp.sentinel.adapter.jaxrs.fallback.DefaultSentinelJaxRsFallback;
+import com.alibaba.csp.sentinel.adapter.jaxrs.fallback.SentinelJaxRsFallback;
+import com.alibaba.csp.sentinel.adapter.jaxrs.request.DefaultRequestOriginParser;
+import com.alibaba.csp.sentinel.adapter.jaxrs.request.DefaultResourceNameParser;
+import com.alibaba.csp.sentinel.adapter.jaxrs.request.RequestOriginParser;
+import com.alibaba.csp.sentinel.adapter.jaxrs.request.ResourceNameParser;
+
+/**
+ *  @author sea
+ */
+public class SentinelJaxRsConfig {
+
+    private static volatile ResourceNameParser resourceNameParser = new DefaultResourceNameParser();
+
+    private static volatile RequestOriginParser requestOriginParser = new DefaultRequestOriginParser();
+
+    private static volatile SentinelJaxRsFallback jaxRsFallback = new DefaultSentinelJaxRsFallback();
+
+    public static ResourceNameParser getResourceNameParser() {
+        return resourceNameParser;
+    }
+
+    public static void setResourceNameParser(ResourceNameParser resourceNameParser) {
+        SentinelJaxRsConfig.resourceNameParser = resourceNameParser;
+    }
+
+    public static RequestOriginParser getRequestOriginParser() {
+        return requestOriginParser;
+    }
+
+    public static void setRequestOriginParser(RequestOriginParser originParser) {
+        SentinelJaxRsConfig.requestOriginParser = originParser;
+    }
+
+    public static SentinelJaxRsFallback getJaxRsFallback() {
+        return jaxRsFallback;
+    }
+
+    public static void setJaxRsFallback(SentinelJaxRsFallback jaxRsFallback) {
+        SentinelJaxRsConfig.jaxRsFallback = jaxRsFallback;
+    }
+
+    private SentinelJaxRsConfig() {
+    }
+}