Sentinel使用Nacos存储规则

最新推荐文章于 2024-07-29 14:22:26 发布

田野里的稻草人

最新推荐文章于 2024-07-29 14:22:26 发布

阅读量1.3k

点赞数 1

分类专栏：微服务架构文章标签： Sentinel Nacos Apollo 规则持久化流控规则

本文链接：https://blog.csdn.net/qq_25447799/article/details/123057718

版权

微服务架构专栏收录该内容

14 篇文章 5 订阅

订阅专栏

文章目录

Sentinel使用Nacos存储规则

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

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

准备工作

下面我们将同时使用到Nacos和Sentinel Dashboard，所以可以先把Nacos和Sentinel Dashboard启动起来。

默认配置下启动后，它们的访问地址为：

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

应用配置

第一步：引入Spring Cloud Alibaba的Sentinel模块和Nacos存储扩展依赖：

<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>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
        <version>1.5.2</version>
    </dependency>
</dependencies>

第二步：添加配置信息：

spring.application.name=alibaba-sentinel-datasource-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

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}变量，这样可以根据应用名来区分不同的规则配置。

第三步：创建应用主类，并提供一个rest接口，比如：

@SpringBootApplication
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
    @Slf4j
    @RestController
    static class TestController {
        @GetMapping("/hello")
        public String hello() {
            return "didispace.com";
        }
    }
}

第四步：Nacos中创建限流规则的配置，比如： 在这里插入图片描述

其中：Data ID、Group就是上面第二步中配置的内容。配置格式选择JSON，并在配置内容中填入下面的内容：

[
    {
        "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：是否为集群模式
第五步：启动应用。如果可以看到类似下面的日志，代表已经成功从Nacos加载了一条限流规则：

2019-04-16 14:24:42.919 INFO 89484 --- [ main] o.s.c.a.s.c.SentinelDataSourceHandler : [Sentinel Starter] DataSource ds-sentinel-nacos-datasource start to loadConfig
2019-04-16 14:24:42.938 INFO 89484 --- [ main] o.s.c.a.s.c.SentinelDataSourceHandler : [Sentinel Starter] DataSource ds-sentinel-nacos-datasource load 1 FlowRule

通过postman或者curl访问几下localhost:8003/hello接口：

$ curl localhost:8003/hello
didispace.com

此时，在Sentinel Dashboard中就可以看到当前我们启动的alibaba-sentinel-datasource-nacos服务。点击左侧菜单中的流控规则，可以看到已经存在一条记录了，具体如下：这条记录就是上面我们在Nacos中配置的限流规则。在这里插入图片描述

整合了Nacos做规则存储之后

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

Sentinel使用Apollo存储规则

Spring Cloud Alibaba Sentinel中如何将流控规则存储在Apollo中。

准备工作

下面我们将同时使用到Apollo和Sentinel Dashboard，所以可以先把Apollo和Sentinel Dashboard启动起来。

应用配置

第一步：引入Spring Cloud Alibaba的Sentinel模块和Apollo存储扩展：

<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>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-apollo</artifactId>
        <version>1.5.2</version>
    </dependency>
</dependencies>

第二步：在Spring Cloud应用中配置的服务信息，在resource目录下，创建apollo-env.properties文件，内容样例：

local.meta=http://192.168.0.201:8080
dev.meta=http://192.168.0.202:8080

这里需要了解Apollo对多环境的配置，这里设置的是每个环境不同的配置服务地址，需要根据自己的实际情况修改。
第三步：在Spring Cloud应用中添加配置信息：

spring.application.name=sentinel-datasource-apollo
server.port=8002
# apollo config
app.id=${spring.application.name}
# sentinel dashboard
spring.cloud.sentinel.transport.dashboard=localhost:8080
# sentinel datasource apollo
spring.cloud.sentinel.datasource.ds.apollo.namespaceName=application
spring.cloud.sentinel.datasource.ds.apollo.flowRulesKey=sentinel.flowRules
spring.cloud.sentinel.datasource.ds.apollo.rule-type=flow

app.id：Apollo中的创建的项目名称，这里采用spring.application.name参数的引用，从而达到服务名与配置项目名一致的效果
spring.cloud.sentinel.transport.dashboard：sentinel dashboard的访问地址，根据上面准备工作中启动的实例配置
spring.cloud.sentinel.datasource.ds.apollo.namespaceName：Apollo的空间名
spring.cloud.sentinel.datasource.ds.apollo.flowRulesKey：配置规则的key名称
spring.cloud.sentinel.datasource.ds.apollo.rule-type：该参数是spring cloud alibaba升级到0.2.2之后增加的配置，用来定义存储的规则类型。所有的规则类型可查看枚举类：org.springframework.cloud.alibaba.sentinel.datasource.RuleType，每种规则的定义格式可以通过各枚举值中定义的规则对象来查看，比如限流规则可查看：com.alibaba.csp.sentinel.slots.block.flow.FlowRule

**关于Apollo相关配置的对应关系可见下图所示：* 在这里插入图片描述

第四步：创建应用主类，并提供一个rest接口，比如：

@EnableApolloConfig
@SpringBootApplication
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
    @Slf4j
    @RestController
    static class TestController {
        @GetMapping("/hello")
        public String hello() {
            return "didispace.com";
        }
    }
}

其中@EnableApolloConfig注解是开启Apollo的配置加载功能。

第五步：Apollo中配置限流规则，具体可见第三步的截图中的样子。其中，key值的内容是下面的json

[
  {
  "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：是否为集群模式
第六步：启动应用。如果一些顺利，可以看到类似下面的日志，代表已经成功从Nacos加载了一条限流规则：

2019-04-18 23:56:11.278  INFO 29149 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-apollo-datasource start to loadConfig
2019-04-18 23:56:11.279  INFO 29149 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-apollo-datasource load 1 FlowRule

通过postman或者curl访问几下localhost:8002/hello接口：

$ curl localhost:8002/hello
didispace.com

此时，在Sentinel Dashboard中就可以看到当前我们启动的sentinel-datasource-apollo服务。点击左侧菜单中的流控规则，可以看到已经存在一条记录了，这条记录就是上面我们在Apollo中配置的限流规则。

在使用Apollo存储规则配置的时候与Nacos存储一样，对于Sentinel控制台这些数据是只读的，也就是说：

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

限流规则持久化方案的配置数据流向图

在这里插入图片描述

蓝色箭头代表了限流规则由配置中心发起修改的更新路径
橙色箭头代表了限流规则由Sentinel Dashboard发起修改的更新路径

从图中可以很明显的看到，Sentinel Dashboard与业务服务之间本身是可以互通获取最新限流规则的，这在没有整合配置中心来存储限流规则的时候就已经存在这样的机制。最主要的区别是：配置中心的修改都可以实时的刷新到业务服务，从而被Sentinel Dashboard读取到，但是对于这些规则的更新到达各个业务服务之后，并没有一个机制去同步到配置中心，作为配置中心的客户端也不会提供这样的逆向更新方法。

如何改造？

要通过 Sentinel 控制台配置集群流控规则，需要对控制台进行改造。我们提供了相应的接口进行适配。从 Sentinel 1.4.0
开始，我们抽取出了接口用于向远程配置中心推送规则以及拉取规则： DynamicRuleProvider: 拉取规则
DynamicRulePublisher: 推送规则对于集群限流的场景，由于每个集群限流规则都需要唯一的
flowId，因此我们建议所有的规则配置都通过动态规则源进行管理，并在统一的地方生成集群限流规则。
我们提供了新版的流控规则页面，可以针对应用维度推送规则，对于集群限流规则可以自动生成 flowId。用户只需实现
DynamicRuleProvider 和 DynamicRulePublisher 接口，即可实现应用维度推送（URL:
/v2/flow）。

简单的说就是Sentinel Dashboard通过DynamicRuleProvider和DynamicRulePublisher两个接口来获取和更新应用的动态规则。 实现Sentinel Dashboard中修改规则与配置中心存储同步的效果。 配置数据流向图如下：在这里插入图片描述

Sentinel Dashboard中修改规则同步到Nacos
参考文章·;https://blog.didispace.com/spring-cloud-alibaba-sentinel-2-4/

@SentinelResource

@SentinelResource注解最主要的两个用法：限流控制和熔断降级。

value：资源名称，必需项（不能为空）
entryType：entry 类型，可选项（默认为 EntryType.OUT）
blockHandler / blockHandlerClass: blockHandler对应处理BlockException 的函数名称，可选项。blockHandler函数访问范围需要是 public，返回类型需要与原方法相匹配，参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为 BlockException。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 blockHandlerClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。
fallback：fallback 函数名称，可选项，用于在抛出异常的时候提供 fallback 处理逻辑。fallback 函数可以针对所有类型的异常（除了exceptionsToIgnore里面排除掉的异常类型）进行处理。fallback 函数签名和位置要求：
- 返回值类型必须与原函数返回值类型一致；
- 方法参数列表需要和原函数一致，或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
- fallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 fallbackClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。
defaultFallback（since 1.6.0）：默认的 fallback 函数名称，可选项，通常用于通用的 fallback 逻辑（即可以用于很多服务或方法）。默认 fallback 函数可以针对所有类型的异常（除了exceptionsToIgnore里面排除掉的异常类型）进行处理。若同时配置了 fallback 和 defaultFallback，则只有 fallback 会生效。defaultFallback 函数签名要求：
- 返回值类型必须与原函数返回值类型一致；
- 方法参数列表需要为空，或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
- defaultFallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 fallbackClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。
exceptionsToIgnore（since 1.6.0）：用于指定哪些异常被排除掉，不会计入异常统计中，也不会进入 fallback 逻辑中，而是会原样抛出。

注：1.6.0 之前的版本 fallback 函数只针对降级异常（DegradeException）进行处理，不能针对业务异常进行处理。

特别地，若 blockHandler 和 fallback 都进行了配置，则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和defaultFallback，则被限流降级时会将BlockException 直接抛出。