nacos(八): sentinel——基本使用

一、概要
在微服务的架构中，流控是一个重要的任务。sentinel是阿里开源的流量治理组件，针对访问的“资源”或服务路径进行流控，内置了限流、熔断及系统负载保护等功能。
sentinel分为系统库及控制面板（也称“控制台"）两个部分。其中，控制台能运行于java 8及以上版本，不依赖于其它三方资源；而控制面板则是sentinel的管理中心，用户可通过图形化界面对规则进行管理和配置。
 
二、下载sentinel控制面板
Sentinel官网地址：https://sentinelguard.io/zh-cn/index.html
Sentinel项目地址：https://github.com/alibaba/Sentinel
当前版本1.8.8：

 
三、启动sentinel
1) 一般启动：

1. java -jar sentinel-dashboard-1.8.8.jar

复制代码

2) 带参数启动：

1. java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.8.8.jar

复制代码

其中：
-Dserver.port=8080：指定Sentinel控制台程序的端口为8080。
-Dcsp.sentinel.dashboard.server=localhost:8080：Sentinel控制台的访问地址，客户端会自动向该地址发送心跳包。
-Dproject.name=sentinel-dashboard：指定Sentinel控制台程序显示的名称。
3) 带参数启动：

1. nohup java -server -Xms64m -Xmx256m -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=192.168.66.100:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.8.8.jar >> /opt/sentinel.log 2>&1 &

复制代码

启动成功后 ，在浏览器访问http://127.0.0.1:8080，即可看到sentinel的管理界面。并输入用户名sentinel和密码sentinel，即可进入管理，如下图：

 
四、配置项目与sentinel进行通信
当前将多模块项目中的producer(看这里)进行扩展，集成sentinel。
1）在pom.xml中添加依赖

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4.     <modelVersion>4.0.0</modelVersion>
5.     <parent>
6.         <groupId>com.example</groupId>
7.         multimod_nacos</artifactId>
8.         <version>0.0.1-SNAPSHOT</version>
9.     </parent>
10.     producer</artifactId>
11.     <packaging>jar</packaging>
13.     <dependencies>
14.         
15.         <dependency>
16.             <groupId>org.springframework.boot</groupId>
17.             spring-boot-starter</artifactId>
18.         </dependency>
20.         <dependency>
21.             <groupId>org.springframework.boot</groupId>
22.             spring-boot-starter-web</artifactId>
23.         </dependency>
25.         
26.         <dependency>
27.             <groupId>com.alibaba.cloud</groupId>
28.             spring-cloud-starter-alibaba-nacos-discovery</artifactId>
29.         </dependency>
31. <strong>        
32.         <dependency>
33.             <groupId>com.alibaba.cloud</groupId>
34.             spring-cloud-starter-alibaba-sentinel</artifactId>
35.         </dependency></strong>
37.     </dependencies>
39.     <build>
40.         <plugins>
41.             <plugin>
42.                 <groupId>org.apache.maven.plugins</groupId>
43.                 maven-compiler-plugin</artifactId>
44.                 <version>3.8.1</version>
45.                 <configuration>
46.                     <source>1.8</source>
47.                     <target>1.8</target>
48.                     <encoding>UTF-8</encoding>
49.                 </configuration>
50.             </plugin>
51.             <plugin>
52.                 <groupId>org.springframework.boot</groupId>
53.                 spring-boot-maven-plugin</artifactId>
54.                 <version>${spring-boot.version}</version>
55.                 <configuration>
56.                     <mainClass>com.example.producer.ProducerApplication</mainClass>
57.                     <skip>false</skip>
58.                 </configuration>
59.                 <executions>
60.                     <execution>
61.                         <id>repackage</id>
62.                         <goals>
63.                             <goal>repackage</goal>
64.                         </goals>
65.                     </execution>
66.                 </executions>
67.             </plugin>
68.         </plugins>
69.     </build>
71. </project>

复制代码

2）配置application.yml

1. server:
2.   port: 8085
5. spring:
6.   cloud:
7.     nacos:
8.       discovery:
9.         server-addr: 127.0.0.1:8848
10.         username: nacos
11.         password: nacos
12.       config:
13.         server-addr: 127.0.0.1:8848
14.         username: nacos
15.         password: nacos
16.         namespace: public
18.     loadbalancer:
19.       nacos:
20.         enabled: true
22. <strong>    sentinel:
23.       transport:
24.         port: 8719
25.         dashboard: 127.0.0.1:8080</strong>
27.   application:
28.     name: product1

复制代码

配置完成后，启动producer。访问producer中的资源/hello即可在sentinel面板中找到对就的模块。
注意：因为sentinel是lazyload模式，所以单纯的producer启动成功sentinel是不显示的。只有访问了项目的资源，sentinel才会显示对应的项目模块。

 
五、规则配置
在“链路规则”菜单中，可以看到访问过的资源。在资源右侧，可以流控、熔断、热点和授权四种规则。

 关于这四种规则的详细配置，打开设置面版一目了解，就不在此一一赘述，如果感兴趣的小伙伴可查看这里（点击查看）
在使用的过程中，会遇到以下问题：如何对资源进行通配符限制？关于这个问题，只需要在项目中添加一个UrlCleaner类，就可以对访问的url进行规整并以通配符的形式传给sentinel：

 
6、自定义限流方法
 1) 针对单个资源自定义限流方法
先定义一个处理限流的类，类内部定义自定义限流方法：

1. package com.example.producer.component;
3. import com.alibaba.csp.sentinel.slots.block.BlockException;
4. import org.springframework.stereotype.Component;
6. import java.io.IOException;
8. @Component
9. public class GlobalBlockHandler {
10.     public static String handleBlock(<strong>String id,</strong>BlockException ex) throws IOException {
11.         return "Global block handler: " + ex.getMessage();
12.     }
14.     public static String handleFlow(<strong>String id,</strong> Throwable ex) throws IOException {
15.         return "Global flow handler: " + ex.getMessage();
16.     }
17. }

复制代码

再用@SentinelResource注解标注对应的类资源：

1. @RestController
2. public class HelloController {
4.     @RequestMapping("/hello")
5.     @SentinelResource(value = "hello",
6.            <strong> fallback </strong><strong>= "handleFlow",
7.             fallbackClass = com.example.producer.component.GlobalBlockHandler.class</strong><strong>,</strong>
8.             blockHandler = "handleBlock",
9.             blockHandlerClass = com.example.producer.component.GlobalBlockHandler.class)
10.     public String Hello(<strong>String id</strong>){
12.         return "hello world "+id;
13.     }
16. }

复制代码

这里要注意的是，自定义限流方法的参数，一定要跟controller里资源方法一致。
另外，需要重点注意的是，在sentinel控制面板内限流设置的时候，要使用资源名称去限流，自定义的限流方法才会生效；如果使用路径限流，自定义限流不生效。

2）自定义全局限流方法 

1. @Component
2. public class MyBlockExceptionHandler implements BlockExceptionHandler {
3. ​
4.     @Override
5.     public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
6.         log.info("UrlBlockHandler.....................................");
7.         // 自定义封装的类，可以定义
8.         Result restObject = null;
9. ​
10.         if (e instanceof FlowException) {
11.             // 限流
12.             restObject = ResultUtils.wrapFail(5001,"接口限流");
13.         } else if (e instanceof DegradeException) {
14.             // 降级
15.             restObject = ResultUtils.wrapFail(5002,"服务降级");
16.         } else if (e instanceof ParamFlowException) {
17.             // 热点参数
18.             restObject = ResultUtils.wrapFail(5003,"热点参数限流");
19.         } else if (e instanceof SystemBlockException) {
20.             // 系统保护
21.             restObject = ResultUtils.wrapFail(5004,"触发系统保护规则");
22.         } else if (e instanceof AuthorityException) {
23.             // 授权规则
24.             restObject = ResultUtils.wrapFail(5005,"授权规则不通过");
25.         }
26. ​
27.         //返回json数据
28.         response.setStatus(200);
29.         response.setCharacterEncoding("utf-8");
30.         response.setContentType(MediaType.APPLICATION_JSON_VALUE);
31.         //springmvc 的一个json转换类 （jackson）
32.         new ObjectMapper().writeValue(response.getWriter(), restObject);
33.     }
34. }

复制代码

重点注意：只有对路径进行限流设置，全局的限流方法才能生效；如果是针对资源名称进行限流设置，全局限流方法不被触发。
3）全局系统异常实现全局自定义限流方法

1. import com.alibaba.csp.sentinel.slots.block.authority.AuthorityException;
2. import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
3. import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
4. import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
5. import org.springframework.http.HttpStatus;
6. import org.springframework.web.bind.annotation.ExceptionHandler;
7. import org.springframework.web.bind.annotation.ResponseBody;
8. import org.springframework.web.bind.annotation.RestControllerAdvice;
10. import java.util.HashMap;
11. import java.util.Map;
14. @RestControllerAdvice
15. public class CustomExceptionHandler {
17.     /**
18.      * 限流全局异常
19.      */
20.     @ExceptionHandler(FlowException.class)
21.     public Map handlerFlowException(){
22.         return new HashMap(){{
23.             put("code", HttpStatus.TOO_MANY_REQUESTS.value());
24.             put("msg", "被限流");
25.         }};
26.     }
28.     /**
29.      * 熔断全局异常
30.      */
31.     @ExceptionHandler(DegradeException.class)
32.     public Map handlerDegradeException(){
33.         return new HashMap(){{
34.             put("code", HttpStatus.TOO_MANY_REQUESTS.value());
35.             put("msg", "被熔断");
36.         }};
37.     }
39.     /**
40.      * 热点限流异常
41.      */
42.     @ExceptionHandler(ParamFlowException.class)
43.     public Map handlerparamFlowException(){
44.         return new HashMap(){{
45.             put("code", HttpStatus.TOO_MANY_REQUESTS.value());
46.             put("msg", "热点限流");
47.         }};
48.     }
50.     /**
51.      *  Sentinel 权限拦截全局异常
52.      */
53.     @ExceptionHandler(AuthorityException.class)
54.     @ResponseBody
55.     public Map handlerAuthorityException(){
56.         return new HashMap(){{
57.             put("code", HttpStatus.UNAUTHORIZED.value());
58.             put("msg", "暂无权限");
59.         }};
60.     }
61. }

复制代码

重点注意的是，在sentinel控制面板内限流设置的时候，要使用资源名称去限流，全局系统异常自定义的限流方法才会生效；如果使用路径限流，则不生效。
 
好了，到这里sentinel的基本使用以及自定义的限流方法已进行了较为详细的讨论。下一篇，让我们一起了解sentinel规则的持久化：)
 

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！