Sentinel：1.Sentinel的基本使用（一）流控规则

拼搏现实的明天。 2022-11-19 04:26 279阅读 0赞

### 文章目录 ###

*  1.启动Sentinel-Dashboard，使用Sentinel控制台
 *   *  1.1 下载Sentinel
     *  1.2 安装并启动Sentinel-Dashboard
     *  1.3 登录Sentinel-Dashboard控制台
 *  2.在项目中使用Sentinel：流控规则
 *   *  2.1 引入Sentinel依赖
     *  2.2 改造HelloServiceImpl，在接口sayHello上添加注解@SentinelResource
     *  2.3 新建目录blockhandler，并创建全局兜底类BlockHandler
     *  2.4 在Nacos中修改nacos-sample-provider的配置文件
     *  2.5 启动nacos-sample-provider，然后在Sentinel-Dashboard控制台中可以看到对应的菜单
     *  2.6 为接口sayHello()添加一条流控规则
 *  3.小练习
 *   *   *  本文示例源码：

# 1.启动Sentinel-Dashboard，使用Sentinel控制台 #

## 1.1 下载Sentinel ##

git clone https://github.com/alibaba/Sentinel.git

## 1.2 安装并启动Sentinel-Dashboard ##

官方文档教程：[README.md][]

【注意】

1.  `官方教程中使用的端口是8080，用户可以自定义更改，本文中改成了8849。`
2.  `官方教程中的mvan clean package指令，建议改成mvn clean package -Dmaven.test.skip=true，跳过test包的编译，以免编译失败`

## 1.3 登录Sentinel-Dashboard控制台 ##

Sentinel-Dashboard启动之后，可以通过访问[http://localhost:8849][http_localhost_8849]，账户和密码是sentinel/sentinel，如下图所示：

![image][]

# 2.在项目中使用Sentinel：流控规则 #

在[Nacos：1.Nacos的基本使用（一）服务注册与发现][Nacos_1.Nacos]中，已经创建好了module：nacos-sample-provider，我们继续以它为例来演示Sentinel的基本使用。

## 2.1 引入Sentinel依赖 ##

在主pom.xml文件中添加下面依赖

pom.xml

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        <version>2.1.0.RELEASE</version>
    </dependency>

## 2.2 改造HelloServiceImpl，在接口sayHello上添加注解@SentinelResource ##

HelloServiceImpl.java

package org.wy.provider;
    
    import com.alibaba.csp.sentinel.annotation.SentinelResource;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    import org.wy.provider.blockhandler.BlockHandler;
    
    @RestController
    @RefreshScope
    public class HelloServiceImpl { 
    
        // @Value可以从Nacos配置中心的配置文件中读取对应的配置变量值
        // ${}中的key要与配置文件中的key一致，否则无法读取
        @Value("${testValue}")
        private String testValue;
    
        @GetMapping(value = "/hi")
        // value 是资源名称，要确保与Sentinel服务中设置的一致且唯一，与Spring的AOP中的切点概念很相似
        // blockHandler 是处理BlockException的接口名称，接口默认需要和原方法在同一个类中
        // 如果希望使用其他类的函数，需要指定 blockHandlerClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。
        @SentinelResource(value = "sayHello", blockHandlerClass = BlockHandler.class, blockHandler = "blockHandlerForSayHello")
        public String sayHello(@RequestParam(name = "name") String name) { 
            return "Hello World: " + name;
        }
    
        // 新增一个接口，用于验证"@Value的功能"
        @GetMapping(value = "/testValue")
        public String getValueFromNacosConfigServer() { 
            return "testValue is: " + testValue;
        }
    }

## 2.3 新建目录blockhandler，并创建全局兜底类BlockHandler ##

BlockHandler.java

package org.wy.provider.blockhandler;
    
    import com.alibaba.csp.sentinel.slots.block.BlockException;
    import org.wy.provider.HelloServiceImpl;
    
    import java.util.logging.Logger;
    
    /** * 定义全局兜底的类 * 注意，返回类型和参数要与调用者一致，且都需要添加异常类，并且方法的修饰符必须是public static */
    public class BlockHandler { 
    
        private static Logger logger = Logger.getLogger(HelloServiceImpl.class.toString());
    
        /** * 当sayHello接口访问限流时，就会调用该接口 * 该函数的传参和返回值类型必须与资源点的传参一样， * * @param e * @return */
        public static String blockHandlerForSayHello(String name, BlockException e) { 
            logger.warning("接口[sayHello]的访问被限流了，原因是：" + e.getMessage());
            return "接口[sayHello]的访问被限流了，原因是：" + e.getMessage();
        }
    }

## 2.4 在Nacos中修改nacos-sample-provider的配置文件 ##

修改教程参考：[Nacos：2.Nacos的基本使用（二）配置中心][Nacos_2.Nacos]

nacos-sample-provider-dev.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    # sentinel信息参数
    sentinel:
      instance:
        hostname: localhost
        port: 8849
    
    spring:
      cloud:
        nacos:
          discovery:
            # 服务注册中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
        sentinel:
          transport:
            # sentinel控制台地址
            dashboard: ${ sentinel.instance.hostname}:${ sentinel.instance.port}
    
    # 该服务启动后使用的端口
    server:
      port: 8001
      
    testValue: welcome!!!

## 2.5 启动nacos-sample-provider，然后在Sentinel-Dashboard控制台中可以看到对应的菜单 ##

![image][image 1]

【注意】

1.  `启动nacos-sample-provider服务后，需要先访问一下@SentinelResource注册的资源，才能将对应的资源注册到Sentinel，从而对该资源的访问添加各种规则`

## 2.6 为接口sayHello()添加一条流控规则 ##

![image][image 2]

为了方便演示，设置一条“QPS为1”的流控规则，然后快速点击刷新，即可触发限流，如下图：

![image][image 3]

# 3.小练习 #

读者可以尝试将项目nacos-sample-consumer中的另一个接口：getValueFromNacosConfigServer()，也改造成注册到Sentinel服务中的接口，示例代码在下面，仅供参考。

--------------------

### 本文示例源码： ###

[GitHub：WangYe8613/scanacos][GitHub_WangYe8613_scanacos]

\[commit id：e4b358cd2f59d527fb244f784ac07a2b216e1c4f\]

[README.md]: https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard
[http_localhost_8849]: http://localhost:8849
[image]: /images/20221022/686280fdb82a4a3ab303df6a3b9b798c.png
[Nacos_1.Nacos]: https://blog.csdn.net/w_y_x_y/article/details/115558041?spm=1001.2014.3001.5501
[Nacos_2.Nacos]: https://blog.csdn.net/w_y_x_y/article/details/115560257?spm=1001.2014.3001.5501
[image 1]: /images/20221022/59b0c07093214d108565e54b5310f5a4.png
[image 2]: /images/20221022/96ef0fff066742a68f29afb4d2228cb2.png
[image 3]: /images/20221022/1011b83e0131439d83bc4c312c2c6462.png
[GitHub_WangYe8613_scanacos]: https://github.com/WangYe8613/scanacos.git