sentinel集成其他框架

通过前几章我们了解了 sentinel-core 的使用方法和部分实现原理，我们在现实应用中怎样使用 sentinel 呢？
在项目中一个个手动界说资源么，那有点繁琐，也不利于后续的维护。 在 sentinel 中提供了两种方法，一种我们可以通过注解的方式来界说资源，另一种是通过 filter 机制拦截全部流量作为资源。
sentinel 切面

如果项目中引入了 spring-aop，那么在注册 SentinelResourceAspect bean 后，项目中被 @Sentinel 注解修饰过的方法都将被界说为资源。通过阅读以下 SentinelResourceAspect 代码，我们可以了解 @Sentinel 注解的拦截处理处罚逻辑：

1. @Configuration
2. public class AopConfiguration {
3.     @Bean
4.     public SentinelResourceAspect sentinelResourceAspect() {
5.         return new SentinelResourceAspect();
6.     }
7. }
9. @Aspect
10. public class SentinelResourceAspect extends AbstractSentinelAspectSupport {
12.     @Pointcut("@annotation(com.alibaba.csp.sentinel.annotation.SentinelResource)")
13.     public void sentinelResourceAnnotationPointcut() {
14.     }
16.     @Around("sentinelResourceAnnotationPointcut()")
17.     public Object invokeResourceWithSentinel(ProceedingJoinPoint pjp) throws Throwable {
18.         Method originMethod = resolveMethod(pjp);
20.         // 获取方法上的 sentinel 注解定义，转换为资源名
21.         SentinelResource annotation = originMethod.getAnnotation(SentinelResource.class);
22.         String resourceName = getResourceName(annotation.value(), originMethod);
23.         EntryType entryType = annotation.entryType();
24.         int resourceType = annotation.resourceType();
25.         Entry entry = null;
26.         try {
27.             // 进入资源，成功则进行业务处理，失败则抛出异常
28.             entry = SphU.entry(resourceName, resourceType, entryType, pjp.getArgs());
29.             return pjp.proceed();
30.         } catch (BlockException ex) {
31.             // 进入资源被拦截时的处理
32.             return handleBlockException(pjp, annotation, ex);
33.         } catch (Throwable ex) {
34.             // ...
35.             // 其他异常的降级（fallback）处理
36.             if (exceptionBelongsTo(ex, annotation.exceptionsToTrace())) {
37.                 traceException(ex);
38.                 return handleFallback(pjp, annotation, ex);
39.             }
41.             throw ex;
42.         } finally {
43.             // 资源的退出
44.             if (entry != null) {
45.                 entry.exit(1, pjp.getArgs());
46.             }
47.         }
48.     }
49. }

复制代码

sentinel adapter 原理

sentinel 中除了使用 aop 机制将 @Sentinel 注解修饰过的方法资源。还可以通过框架提供的 filter、interceptor 等机制将全部流量拦截，全部作为资源（将全部的流量都作为资源，迟早会突破 sentinel 中的资源上限，所以 sentinel 中支持 url 合并，以缩减资源的数目，后文我们将会先容）。
目前 sentinel adapter 模块支持集成 servlet、spring mvc、dubbo 等 20 种主流框架，对应实现的 adapter 实现原理根本相似。下面我们以 sentinel-web-servlet 为例，讲解 sentinel 怎样和 java servlet 举行集成，其大抵示意图如下：

1，引入 sentinel-web-servlet 依靠后
2，在 web.xml 界说 sentinel filter

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://java.sun.com/xml/ns/javaee" xsi:schemaLocation="https://java.sun.com/xml/ns/javaee https://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
3. <filter>
4.         <filter-name>sentinel-filter</filter-name>
5.         <filter-class>com.alibaba.csp.sentinel.adapter.servlet.CommonFilter</filter-class>
6.     </filter>
7.     <filter-mapping>
8.         <filter-name>myFilter</filter-name>
9.         <url-pattern>/</url-pattern>
10.     </filter-mapping>
11. </web-app>

复制代码

CommonFilter 中的代码逻辑同 SentinelResourceAspect 类似：

1. class CommonFilter {
2.     @Override
3.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
4.             throws IOException, ServletException {
5.         HttpServletRequest sRequest = (HttpServletRequest) request;
6.         Entry urlEntry = null;
8.         try {
9.             String target = FilterUtil.filterTarget(sRequest);
10.             // url 合并，返回为 "" 时代表该请求不被 sentinel 处理
11.             UrlCleaner urlCleaner = WebCallbackManager.getUrlCleaner();
12.             if (urlCleaner != null) {
13.                 target = urlCleaner.clean(target);
14.             }
16.             if (!StringUtil.isEmpty(target)) {
17.                 // 解析请求来源
18.                 String origin = parseOrigin(sRequest);
19.                 String contextName = webContextUnify ? WebServletConfig.WEB_SERVLET_CONTEXT_NAME : target;
20.                 ContextUtil.enter(contextName, origin);
22.                 // 是否将同 url 不同请求方式视为不同资源，如：GET:/foo 和 POST:/foo 是不同资源
23.                 if (httpMethodSpecify) {
24.                     String pathWithHttpMethod = sRequest.getMethod().toUpperCase() + COLON + target;
25.                     urlEntry = SphU.entry(pathWithHttpMethod, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
26.                 } else {
27.                     // 进入资源
28.                     urlEntry = SphU.entry(target, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
29.                 }
30.             }
31.             chain.doFilter(request, response);
32.         } catch (BlockException e) {
33.             HttpServletResponse sResponse = (HttpServletResponse) response;
34.             // Return the block page, or redirect to another URL.
35.             WebCallbackManager.getUrlBlockHandler().blocked(sRequest, sResponse, e);
36.         } catch (IOException | ServletException | RuntimeException e2) {
37.             Tracer.traceEntry(e2, urlEntry);
38.             throw e2;
39.         } finally {
40.             if (urlEntry != null) {
41.                 urlEntry.exit();
42.             }
43.             ContextUtil.exit();
44.         }
45.     }
46. }

复制代码

3，创建对应的配置，用于请求泉源解析、资源合并和阻塞的处理处罚

1. class SentinelConfig {
2.     static {
3.         initConfig();
4.     }
5.    
6.     public static void initConfig() {
7.         // 用于将请求 url 进行合并
8.         // 如：/page/1.html、/page/2.html 合并为 /page/*.html，可以减少资源的个数
9.         WebCallbackManager.setUrlCleaner(new MyUrlCleaner());
10.         // 用于解析请求中的来源，用于资源的白、黑名单访问控制
11.         // 如：解析请求头中的来源 ip，使得部分资源只能被特定来源 ip 访问
12.         // 当然这个来源不一定时 ip，也可以是 refer、host 等其他请求头或自定义请求头
13.         WebCallbackManager.setRequestOriginParser(new MyRequestOriginParser());
14.         // 用于资源访问时被拦截时处理逻辑
15.         // 如：资源访问受限时，返回 429 响应，使得调用方知道系统当前请求过多
16.         WebCallbackManager.setUrlBlockHandler(new MyUrlBlcokHandler());
17.     }
18. }

复制代码

总结

总而言之，sentinel 和我们应用中的框架集成后，要么通过 aop 的机订界说资源，要么通过框架提供的 filter、interceptor 机制拦截请求来界说资源。
这都比较方便的快速将项目中的业务逻辑界说为资源，但我们还需要为资源界说对应的规则，难道我们还是需要手动一个一个界说么？下章我们将先容怎样在 sentinel dashboard 中界说资源规则。
文章编写不易，如有帮助，欢迎 star：github 地址、gitee 地址

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。