Spring Cloud Alibaba（4）Sentinel使用nacos对存储规则持久化 带源码

目录

 

背景

源码地址

博文参考：

持久化支持方式

 整合nacos存储规则

sentinel规则修改

---

背景

spring cloud微服务应用sentinel做限流，每次sentinel dashboard服务重启后，限流的规则丢失，这里就需要对限流规则作持久化处理。

源码地址

https://gitee.com/acelee723/acelee-alibaba-sentinel-nacos

博文参考：

http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/

持久化支持方式

Sentinel自身就支持了多种不同的数据源来持久化规则配置，目前包括以下几种方式：

• 文件配置
• Nacos配置
• ZooKeeper配置
• Apollo配置

 整合nacos存储规则

1.启动Nacos、Sentinel Dashboard，对应访问地址如下：

• Nacos：http://localhost:8848/nacos/
• Sentinel Dashboard：http://localhost:8080/

2.新建一个spring boot项目acelee-alibaba-sentinel-nacos，在pom.xml文件里添加sentinel、nacos依赖

<?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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.aceleeyy</groupId>
    <artifactId>acelee-alibaba-sentinel-nacos</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>acelee-alibaba-sentinel-nacos</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            <version>0.9.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-datasource-nacos</artifactId>
            <version>1.6.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.在application.properties里添加sentinel、nacos配置 

• spring.cloud.sentinel.transport.dashboard：sentinel dashboard的访问地址，根据上面准备工作中启动的实例配置
• spring.cloud.sentinel.datasource.ds.nacos.server-addr：nacos的访问地址，，根据上面准备工作中启动的实例配置
• spring.cloud.sentinel.datasource.ds.nacos.groupId：nacos中存储规则的groupId
• spring.cloud.sentinel.datasource.ds.nacos.dataId：nacos中存储规则的dataId
• spring.cloud.sentinel.datasource.ds.nacos.rule-type：该参数是spring cloud alibaba升级到0.2.2之后增加的配置，用来定义存储的规则类型。所有的规则类型可查看枚举类：org.springframework.cloud.alibaba.sentinel.datasource.RuleType，每种规则的定义格式可以通过各枚举值中定义的规则对象来查看，比如限流规则可查看：com.alibaba.csp.sentinel.slots.block.flow.FlowRule

这里对于dataId使用了${spring.application.name}变量，这样可以根据应用名来区分不同的规则配置。

注意：由于版本迭代关系，Github Wiki中的文档信息不一定适用所有版本。比如：在这里适用的0.2.1版本中，并没有spring.cloud.sentinel.datasource.ds2.nacos.rule-type这个参数。所以，读者在使用的时候，可以通过查看org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration和org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties两个类来分析具体的配置内容，会更为准确。

spring.application.name=acelee-alibaba-sentinel-nacos
server.port=8003

# sentinel dashboard
spring.cloud.sentinel.transport.dashboard=localhost:8080

# sentinel datasource nacos ：http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/
spring.cloud.sentinel.datasource.ds.nacos.server-addr=localhost:8848
spring.cloud.sentinel.datasource.ds.nacos.dataId=${spring.application.name}-sentinel
spring.cloud.sentinel.datasource.ds.nacos.groupId=DEFAULT_GROUP
spring.cloud.sentinel.datasource.ds.nacos.rule-type=flow

4.新建controller包，在包里新建HelloController.java类，增加hello接口

package com.aceleeyy.aceleealibabasentinelnacos.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "aceleeyy.com";
    }

}

5.Nacos里配置列表页面新建配置，配置限流规则

• 1）Data ID就是上面application.properties中配置对应的nacos.dataId
• 2）Group就是上面application.properties中配置对应的nacos.groupId
• 3）配置格式选择JSON
• 4）并在配置内容中填入下面的内容：

[
    {
        "resource": "/hello",
        "limitApp": "default",
        "grade": 1,
        "count": 5,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    }
]

 可以看到上面配置规则是一个数组类型，数组中的每个对象是针对每一个保护资源的配置对象，每个对象中的属性解释如下：

• resource：资源名，即限流规则的作用对象
• limitApp：流控针对的调用来源，若为 default 则不区分调用来源
• grade：限流阈值类型（QPS 或并发线程数）；0代表根据并发数量来限流，1代表根据QPS来进行流量控制
• count：限流阈值
• strategy：调用关系限流策略
• controlBehavior：流量控制效果（直接拒绝、Warm Up、匀速排队）
• clusterMode：是否为集群模式

这里我们只做简单的配置解释，以便于理解这里的配置作用。实际上这里还有非常多可配置选项和规则，更复杂的配置后面我们一起来学习。

6.点击发布按钮，可以看到nacos配置列表多了一条记录

7.启动项目，如果一切顺利，可以看到控制台打印如下日志，证明sentinel的限流规则从nacos中获取，且对/hello接口作了qps为5的限流

  8.访问http://localhost:8003/hello ，返回：aceleeyy.com

9.打开sentinel控制台，刷新页面，可以看到对/hello接口的实时监控，没有的话，刷新几次/hello接口

10。打开sentinel流控规则页面，可以看到新增了一条限流记录，配置值分别对应nacos里的json数据配置

11.验证限流规则，多次调用/hello接口，在快速刷新后返回：

Blocked by Sentinel (flow limiting)

证明sentinel使用nacos对限流规则持久化成功

sentinel规则修改

在完成了上面的整合之后，对于接口流控规则的修改就存在两个地方了：Sentinel控制台、Nacos控制台。

这个时候，需要注意当前版本的Sentinel控制台不具备同步修改Nacos配置的能力，而Nacos由于可以通过在客户端中使用Listener来实现自动更新。所以，在整合了Nacos做规则存储之后，需要知道在下面两个地方修改存在不同的效果：

• Sentinel控制台中修改规则：仅存在于服务的内存中，不会修改Nacos中的配置值，重启后恢复原来的值。
• Nacos控制台中修改规则：服务的内存中规则会更新，Nacos中持久化规则也会更新，重启后依然保持。

---

欢迎关注博主博客，后期博主会持续更新spring cloud alibaba 系列文章，敬请期待！