SpringBoot集成Sentinel实现接口流量控制

左手的ㄟ右手 2023-01-23 04:56 24阅读 0赞

![2cb941616b47ceb41e95ebdbb05e1872.png][]

*  Sentinel控制台搭建
 *  Sentinel 客户端
 *   *  项目搭建
     *  如何定义资源
     *  启动控制台
 *  控制台配置规则

Hello,大家好,我是麦洛,今天带大家来了解一下SpringBoot如何继承Sentinel来实现接口流量控制

假如大家有什么问题或者建议,可以关注公众号,回复"加群"就可以获取到我的个人微信二维码,可以拉大家进交流群一起讨论学习;

## Sentinel控制台搭建    ##

在我的上一篇文章[阿里出品的Sentinel到底是个什么玩意?][Sentinel]中,已经介绍过如何准备Sentinel控制台,大家可以直接参考;

## Sentinel 客户端 ##

### 项目搭建 ###

首先我们来创建一个测试项目,这里初始化项目的`url`建议大家填写**阿里云**的地址,会有惊喜????

http://start.aliyun.com

![1b41c380bade31e91ed03e8c862184f2.png][]

接下来就是常规操作,一路next,在下图的位置稍微注意一下

![47c4ce3584ad0d925294bd4bcbd726d8.png][]

> 说明:
> 
> 同大家以前创建项目一样,只需要在这里勾选Sentinel就可以啦????

项目创建好以后,我们发现pom文件中引入了下面的依赖

![0b6d1a7a9a250f7152d68a1862b4214e.png][]

有的小伙伴看网上博客,也会有下面的方式,指定版本号

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

如果你使用我推荐的阿里云的Url,会发现Sentinel的版本号都定义父工程,Cloud的各个组件的兼容性就不要大家操心了

<dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${spring-boot.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

打开项目配置文件,会发现它已经为我们自动加好了配置,真的超级方便????

server.port=8083
    # 应用名称
    spring.application.name=springcloud-sentinel
    # Sentinel 控制台地址
    spring.cloud.sentinel.transport.dashboard=localhost:8080
    # 取消Sentinel控制台懒加载
    # 默认情况下 Sentinel 会在客户端首次调用的时候进行初始化，开始向控制台发送心跳包
    # 配置 sentinel.eager=true 时，取消Sentinel控制台懒加载功能
    spring.cloud.sentinel.eager=true
    # 如果有多套网络，又无法正确获取本机IP，则需要使用下面的参数设置当前机器可被外部访问的IP地址，供admin控制台使用
    # spring.cloud.sentinel.transport.client-ip=# sentinel 配置
    spring.application.name=frms
    spring.cloud.sentinel.transport.dashboard=localhost:8080
    spring.cloud.sentinel.transport.heartbeat-interval-ms=500

### 如何定义资源 ###

#### 编程式定义 ####

官网提供的demo

package com.milo.sentinel;
    
    import com.alibaba.csp.sentinel.Entry;
    import com.alibaba.csp.sentinel.SphU;
    import com.alibaba.csp.sentinel.slots.block.BlockException;
    import com.alibaba.csp.sentinel.slots.block.RuleConstant;
    import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
    import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * 项目入口
     * @author Milo Lee
     * @date 2021-3-20 19:07
     *
     */
    @SpringBootApplication
    public class SentinelApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SentinelApplication.class, args);
    
            // 配置规则.
            initFlowRules();
            while (true) {
                // 1.5.0 版本开始可以直接利用 try-with-resources 特性
                try (Entry entry = SphU.entry("HelloWorld")) {
                    // 被保护的逻辑
                    Thread.sleep(300);
                    System.out.println("hello world");
                } catch (BlockException | InterruptedException ex) {
                    // 处理被流控的逻辑
                    System.out.println("blocked!");
                }
            }
    
        }
    
        private static void initFlowRules(){
            List<FlowRule> rules = new ArrayList<>();
            FlowRule rule = new FlowRule();
            rule.setResource("HelloWorld");
            rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
            // Set limit QPS to 20.
            rule.setCount(20);
            rules.add(rule);
            FlowRuleManager.loadRules(rules);
        }
    
    }

#### 注解式定义 ####

@SpringBootApplication
    public class Application {
    
        public static void main(String[] args) {
            SpringApplication.run(ServiceApplication.class, args);
        }
    }
    
    @Service
    public class TestService {
    
        @SentinelResource(value = "sayHello")
        public String sayHello(String name) {
            return "Hello, " + name;
        }
    }
    
    @RestController
    public class TestController {
    
        @Autowired
        private TestService service;
    
        @GetMapping(value = "/hello/{name}")
        public String apiHello(@PathVariable String name) {
            return service.sayHello(name);
        }
    }

`@SentinelResource` 注解用来标识资源是否被限流、降级。上述例子上该注解的属性 `sayHello` 表示资源名。

### 启动控制台 ###

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

![734225e1fd773bd6b0251ea968acfa54.png][]

## 控制台配置规则 ##

控制台的操作我们用编程式定义的例子来演示,大家启动我们的服务

![2e6448a2154c7f8c23727085c760b45e.png][]

我们会发现除了**sentinel-dashboard**之外,多了一个**milolee-sentinel**,这个就是我们的服务,它的名称其实对应我们配置文件定义的应用名称:

# 应用名称
    spring.application.name=milolee-sentinel

点击机器列表,这这里如果能发现你的机器,那就是成功上线了

![b4fab4d725d9b140682acf5af8cc1ac4.png][]

#### 实时监控 ####

![f8de685554f93a159cc45cc19d4a2cc1.png][]

#### 簇点链路 ####

![4d8cb9b74de18b89934087fbeab2abd7.png][]

#### 流控规则配置 ####

给我们的资源`HelloWorld`配置流控规则，它的`QPS`(每秒请求数)为1，如图：

![4e6fb3d0012192fb842c72204a3994be.png][]

通过查看实时监控,我们发现已经生效

![fc42a668c5f927549222d1c7d7a01655.png][]

#### 降级规则配置 ####

给我们的资源`HelloWorld`添加一个降级规则配置，如果`QPS`大于1，且平均响应时间大于`20ms`，则接口下来接口在2秒钟无法访问，之后自动恢复。

![bf1b1d367edaec1d6726b086d44741a4.png][]

目前这些规则**仅在内存态生效**，应用重启之后，该规则会丢失。后续文章我们会继续学习动态规则

![a17c1f71156c78b92ece091ea9aa2dba.png][]

????关于控制台的使用,大家可以参考官方文档,比较详细https://sentinelguard.io/zh-cn/docs/dashboard.html

谢谢大家的阅读,如果有什么疑问或者建议,可以点击下方留言板,给我留言!

![d63a2ec120b13ce6b599ddd691f83d63.png][]

![66fc869e06beeb984e3004bf269ceed5.png][]

![f5e5179efd1c459cbed44dfa8d2945fa.png][]

往期推荐

[阿里出品的Sentinel到底是个什么玩意?][Sentinel]

[从Nacos客户端视角来分析一下配置中心实现原理][Nacos]

[听句劝! Nacos集群搭建可以看看这篇教程][Nacos 1]

[你所不知道的Nacos实现原理][Nacos 2]

[SpringCloud集成Nacos实现服务发现和配置管理][SpringCloud_Nacos]

[Spring Cloud Alibaba -Nacos入门讲解][Spring Cloud Alibaba -Nacos]

![3b44e69368ee5707d2ce7033368dcd4a.gif][]

[2cb941616b47ceb41e95ebdbb05e1872.png]: /images/20221004/779a0ff3fd6f4686aac6e167b6ef2371.png
[Sentinel]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926f2ff9e5e63955cce37fd5d6cee8e65197bcf34641072f2d4e8c3a86ebf2d213d6c0912f&idx=1&mid=2247488235&scene=21&sn=c609ede84c29991d370fe23f591e37b4#wechat_redirect
[1b41c380bade31e91ed03e8c862184f2.png]: /images/20221004/221e9cf045a14dd1af9ac23b68ad6d43.png
[47c4ce3584ad0d925294bd4bcbd726d8.png]: /images/20221004/7557c45f8e4b4ce2a2026dab8fc4a0b9.png
[0b6d1a7a9a250f7152d68a1862b4214e.png]: /images/20221004/8ba188a229c743dc8c897db2c9f62ac8.png
[734225e1fd773bd6b0251ea968acfa54.png]: /images/20221004/fcc4b781223f4ad2b3190c500df2b5d8.png
[2e6448a2154c7f8c23727085c760b45e.png]: /images/20221004/c889350e7938416692a908f55e0c4c44.png
[b4fab4d725d9b140682acf5af8cc1ac4.png]: /images/20221004/b19f45ce481e4d58bcd451b94770d763.png
[f8de685554f93a159cc45cc19d4a2cc1.png]: /images/20221004/b36454f9ec974c498e63db3272dedccd.png
[4d8cb9b74de18b89934087fbeab2abd7.png]: /images/20221004/ff673d866baf40069e35d92617697f92.png
[4e6fb3d0012192fb842c72204a3994be.png]: /images/20221004/0b374bd749244617a1c1dc37b0b4d1ff.png
[fc42a668c5f927549222d1c7d7a01655.png]: /images/20221004/50e685a29401428c98678625d3e1b521.png
[bf1b1d367edaec1d6726b086d44741a4.png]: /images/20221004/369ea43102fe4817a70b2b4c7b14eaec.png
[a17c1f71156c78b92ece091ea9aa2dba.png]: /images/20221004/28806c5848894a83a559400e7c5f1f9e.png
[d63a2ec120b13ce6b599ddd691f83d63.png]: /images/20221004/0668d66a71ca4aedacf60c10feb4eb65.png
[66fc869e06beeb984e3004bf269ceed5.png]: /images/20221004/ff3b4b590681432398c793deadf9e6f3.png
[f5e5179efd1c459cbed44dfa8d2945fa.png]: /images/20221004/5475ff723e2245f3bf7cf86240923a67.png
[Nacos]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926f60f9e5e6769513396beed7bcec8eb758fdfe3d73163be758e7cf55d7f184cd19451e51&idx=1&mid=2247488164&scene=21&sn=4e8bb1eb8b520d326f759224880dc22e#wechat_redirect
[Nacos 1]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926c01f9e5e517008648e0c2fa8369ebc5172f650caf2e58bb0ec7e37745117acb38f87379&idx=1&mid=2247487941&scene=21&sn=26b4d994cd38f908278dece935e32dc1#wechat_redirect
[Nacos 2]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926cfaf9e5e5ec7e41cd40eb067dc6c34d2655c8697147f9d49b0847e729a4a4f6c3946026&idx=1&mid=2247487806&scene=21&sn=188a41b917f92ba9a689f1107798b9df#wechat_redirect
[SpringCloud_Nacos]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926ccbf9e5e5ddfa75e50d3c408b32c82ddc044159f755b47445252edb0b390582ce4fd634&idx=1&mid=2247487759&scene=21&sn=5935737e34baebb6c62077762671d17c#wechat_redirect
[Spring Cloud Alibaba -Nacos]: http://mp.weixin.qq.com/s?__biz=Mzg3MDA4Mzc1NQ%3D%3D&chksm=ce926d23f9e5e435e7197cc363832a16bcd736d368b747a6e4a1f62f9db0e6cef7e25087b798&idx=1&mid=2247487719&scene=21&sn=05f25f33c9e08eb4beca33b7da9e6a2c#wechat_redirect
[3b44e69368ee5707d2ce7033368dcd4a.gif]: /images/20221004/5fbf0b21127b4f81ad0fc8072bff3183.png