SpringCloudAlibaba——Sentinel与SpringBoot整合

最新推荐文章于 2024-06-12 16:42:32 发布

Liu_Shihao

最新推荐文章于 2024-06-12 16:42:32 发布

阅读量1.7k

点赞数 3

分类专栏： SpringCloud SpringBoot 文章标签： spring spring boot

本文链接：https://blog.csdn.net/DreamsArchitects/article/details/118293490

版权

SpringBoot 同时被 2 个专栏收录

60 篇文章 4 订阅

订阅专栏

SpringCloud

25 篇文章 3 订阅

订阅专栏

一、介绍

随着微服务的流行，服务和服务之间的稳定性变得越来越重要。 Sentinel 以流量为切入点，从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。

Sentinel 具有以下特征:

丰富的应用场景： Sentinel 承接了阿里巴巴近 10 年的双十一大促流量的核心场景，例如秒杀（即突发流量控制在系统容量可以承受的范围）、消息削峰填谷、实时熔断下游不可用应用等。
完备的实时监控： Sentinel 同时提供实时的监控功能。您可以在控制台中看到接入应用的单台机器秒级数据，甚至 500 台以下规模的集群的汇总运行情况。
广泛的开源生态： Sentinel 提供开箱即用的与其它开源框架/库的整合模块，例如与 Spring Cloud、Dubbo、gRPC 的整合。您只需要引入相应的依赖并进行简单的配置即可快速地接入 Sentinel。
完善的 SPI 扩展点： Sentinel 提供简单易用、完善的 SPI 扩展点。您可以通过实现扩展点，快速的定制逻辑。例如定制规则管理、适配数据源等。

二、如何使用

组件版本关系：
在这里插入图片描述

在这里插入图片描述

2.1 引入依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<!--Sentinel注解支持 @SentinelResource 注解,注解方式埋点不支持 private 方法。-->
<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-annotation-aspectj</artifactId>
    <version>1.8.1</version>
</dependency>
<!--客户端需要引入 Transport 模块来与 Sentinel 控制台进行通信-->
<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-transport-simple-http</artifactId>
    <version>1.8.1</version>
</dependency>

最简单的使用 Sentinel 的例子：
启动类：

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.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 表示资源名。还提供了其它额外的属性如 blockHandler，blockHandlerClass，fallback 用于表示限流或降级的操作。
注：一般推荐将 @SentinelResource 注解加到服务实现上。

2.2 Sentinel 控制台

Sentinel 控制台提供一个轻量级的控制台，它提供机器发现、单机资源实时监控、集群资源汇总，以及规则管理的功能。您只需要对应用进行简单的配置，就可以使用这些功能。

可以从 release 页面下载最新版本的控制台 jar 包。
在这里插入图片描述
Sentinel 控制台是一个标准的 Spring Boot 应用，以 Spring Boot 的方式运行 jar 包即可。
在java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar
如若8080端口冲突，可使用 -Dserver.port=新端口 进行设置。

配置控制台信息：application.yml

spring:
  cloud:
    sentinel:
      transport:
        port: 8719
        dashboard: localhost:8080

这里的 spring.cloud.sentinel.transport.port 端口配置会在应用对应的机器上启动一个 Http Server，该 Server 会与 Sentinel 控制台做交互。比如 Sentinel 控制台添加了一个限流规则，会把规则数据 push 给这个 Http Server 接收，Http Server 再将规则注册到 Sentinel 中。

2.3 Fegin支持

引入依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

配置文件打开 Sentinel 对 Feign 的支持：feign.sentinel.enabled=true
在这里插入图片描述

FeignClient简单使用示例：

@FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class)
public interface EchoService {
    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    String echo(@PathVariable("str") String str);
}

class FeignConfiguration {
    @Bean
    public EchoServiceFallback echoServiceFallback() {
        return new EchoServiceFallback();
    }
}

class EchoServiceFallback implements EchoService {
    @Override
    public String echo(@PathVariable("str") String str) {
        return "echo fallback";
    }
}

EchoService 接口中方法 echo 对应的资源名为 GET:http://service-provider/echo/{str}。

2.4 RestTemplate 支持

Spring Cloud Alibaba Sentinel 支持对 RestTemplate 的服务调用使用 Sentinel 进行保护，在构造 RestTemplate bean的时候需要加上 @SentinelRestTemplate 注解。

@Bean
@SentinelRestTemplate(blockHandler = "handleException", blockHandlerClass = ExceptionUtil.class)
public RestTemplate restTemplate() {
    return new RestTemplate();
}

@SentinelRestTemplate 注解的属性支持限流(blockHandler, blockHandlerClass)和降级(fallback, fallbackClass)的处理。

其中 blockHandler 或 fallback 属性对应的方法必须是对应 blockHandlerClass 或 fallbackClass 属性中的静态方法。

该方法的参数跟返回值跟 org.springframework.http.client.ClientHttpRequestInterceptor#interceptor 方法一致，其中参数多出了一个 BlockException 参数用于获取 Sentinel 捕获的异常。

比如上述 @SentinelRestTemplate 注解中 ExceptionUtil 的 handleException 属性对应的方法声明如下：

public class ExceptionUtil {
    public static ClientHttpResponse handleException(HttpRequest request, byte[] body, ClientHttpRequestExecution execution, BlockException exception) {
        ...
    }
}

注意：应用启动的时候会检查 @SentinelRestTemplate 注解对应的限流或降级方法是否存在，如不存在会抛出异常。

@SentinelRestTemplate 注解的限流(blockHandler, blockHandlerClass)和降级(fallback, fallbackClass)属性不强制填写。

当使用 RestTemplate 调用被 Sentinel 熔断后，会返回 RestTemplate request block by sentinel 信息，或者也可以编写对应的方法自行处理返回信息。这里提供了 SentinelClientHttpResponse 用于构造返回信息。

Sentinel RestTemplate 限流的资源规则提供两种粒度：

httpmethod:schema://host:port/path：协议、主机、端口和路径
httpmethod:schema://host:port：协议、主机和端口

例如：以 https://www.taobao.com/test 这个 url 并使用 GET 方法为例。对应的资源名有两种粒度，分别是 GET:https://www.taobao.com 以及 GET:https://www.taobao.com/test

2.5 网关限流

Sentinel 支持对 Spring Cloud Gateway、Zuul 等主流的 API Gateway 进行限流。
在这里插入图片描述

Sentinel 1.6.0 引入了 Sentinel API Gateway Adapter Common 模块，此模块中包含网关限流的规则和自定义 API 的实体和管理逻辑：

GatewayFlowRule：网关限流规则，针对 API Gateway 的场景定制的限流规则，可以针对不同 route 或自定义的 API 分组进行限流，支持针对请求中的参数、Header、来源 IP 等进行定制化的限流。
ApiDefinition：用户自定义的 API 定义分组，可以看做是一些 URL 匹配的组合。比如我们可以定义一个 API 叫 my_api，请求 path 模式为 /foo/** 和 /baz/** 的都归到 my_api 这个 API 分组下面。限流的时候可以针对这个自定义的 API 分组维度进行限流。

2.5.1 Zuul 支持

引入依赖：


<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>

同时请将 spring.cloud.sentinel.filter.enabled 配置项置为 false（若在网关流控控制台上看到了 URL 资源，就是此配置项没有置为 false）。
Sentinel 提供了 Zuul 1.x 的适配模块，可以为 Zuul Gateway 提供两种资源维度的限流：

route 维度：即在 Spring 配置文件中配置的路由条目，资源名为对应的 -route ID（对应 RequestContext 中的 proxy 字段）
自定义 API 维度：用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组
使用时需引入以下模块（以 Maven 为例）：

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-zuul-adapter</artifactId>
    <version>版本</version>
</dependency>

2.5.2 Spring Cloud Gateway 支持

引入依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

同时请将 spring.cloud.sentinel.filter.enabled 配置项置为 false（若在网关流控控制台上看到了 URL 资源，就是此配置项没有置为 false）。

*注意：网关流控规则数据源类型是 gw-flow，若将网关流控规则数据源指定为 flow 则不生效。

从 1.6.0 版本开始，Sentinel 提供了 Spring Cloud Gateway 的适配模块，可以提供两种资源维度的限流：

route 维度：即在 Spring 配置文件中配置的路由条目，资源名为对应的 routeId
自定义 API 维度：用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组
使用时需引入以下模块（以 Maven 为例）：

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
    <version>版本</version>
</dependency>

2.6 Endpoint 支持

在使用 Endpoint 特性之前需要在 Maven 中添加 spring-boot-starter-actuator 依赖，并在配置中允许 Endpoints 的访问。

Spring Boot 1.x 中添加配置 management.security.enabled=false。暴露的 endpoint 路径为 /sentinel
Spring Boot 2.x 中添加配置 management.endpoints.web.exposure.include=*。暴露的 endpoint 路径为 /actuator/sentinel

Sentinel Endpoint 里暴露的信息非常有用。包括当前应用的所有规则信息、日志目录、当前实例的 IP，Sentinel Dashboard 地址，Block Page，应用与 Sentinel Dashboard 的心跳频率等等信息。

2.7 配置

下表显示当应用的 ApplicationContext 中存在对应的Bean的类型时，会进行自动化设置：

存在Bean的类型	操作	作用
`UrlCleaner`	`WebCallbackManager.setUrlCleaner(urlCleaner)`	资源清理(资源（比如将满足 /foo/:id 的 URL 都归到 /foo/* 资源下）)
`UrlBlockHandler`	`WebCallbackManager.setUrlBlockHandler(urlBlockHandler)`	自定义限流处理逻辑
`RequestOriginParser`	`WebCallbackManager.setRequestOriginParser(requestOriginParser)`	设置来源信息

Spring Cloud Alibaba Sentinel 提供了这些配置选项:

配置项	含义	默认值
`spring.application.name` or `project.name`	Sentinel项目名
`spring.cloud.sentinel.enabled`	Sentinel自动化配置是否生效	true
`spring.cloud.sentinel.eager`	是否提前触发 Sentinel 初始化	false
`spring.cloud.sentinel.transport.port`	应用与Sentinel控制台交互的端口，应用本地会起一个该端口占用的HttpServer	8719
`spring.cloud.sentinel.transport.dashboard`	Sentinel 控制台地址
`spring.cloud.sentinel.transport.heartbeat-interval-ms`	应用与Sentinel控制台的心跳间隔时间
`spring.cloud.sentinel.transport.client-ip`	此配置的客户端IP将被注册到 Sentinel Server 端
`spring.cloud.sentinel.filter.order`	Servlet Filter的加载顺序。Starter内部会构造这个filter	Integer.MIN_VALUE
`spring.cloud.sentinel.filter.url-patterns`	数据类型是数组。表示Servlet Filter的url pattern集合	/*
`spring.cloud.sentinel.filter.enabled`	Enable to instance CommonFilter	true
`spring.cloud.sentinel.metric.charset`	metric文件字符集	UTF-8
`spring.cloud.sentinel.metric.file-single-size`	Sentinel metric 单个文件的大小
`spring.cloud.sentinel.metric.file-total-count`	Sentinel metric 总文件数量
`spring.cloud.sentinel.log.dir`	Sentinel 日志文件所在的目录
`spring.cloud.sentinel.log.switch-pid`	Sentinel 日志文件名是否需要带上 pid	false
`spring.cloud.sentinel.servlet.block-page`	自定义的跳转 URL，当请求被限流时会自动跳转至设定好的 URL
`spring.cloud.sentinel.flow.cold-factor`	WarmUp 模式中的冷启动因子	3
`spring.cloud.sentinel.zuul.order.pre`	SentinelZuulPreFilter 的 order	10000
`spring.cloud.sentinel.zuul.order.post`	SentinelZuulPostFilter 的 order	1000
`spring.cloud.sentinel.zuul.order.error`	SentinelZuulErrorFilter 的 order	-1
`spring.cloud.sentinel.scg.fallback.mode`	Spring Cloud Gateway 流控处理逻辑 (选择 `redirect` or `response`)
`spring.cloud.sentinel.scg.fallback.redirect`	Spring Cloud Gateway 响应模式为 'redirect' 模式对应的重定向 URL
`spring.cloud.sentinel.scg.fallback.response-body`	Spring Cloud Gateway 响应模式为 'response' 模式对应的响应内容
`spring.cloud.sentinel.scg.fallback.response-status`	Spring Cloud Gateway 响应模式为 'response' 模式对应的响应码	429
`spring.cloud.sentinel.scg.fallback.content-type`	Spring Cloud Gateway 响应模式为 'response' 模式对应的 content-type	application/json

Note	请注意。这些配置只有在 Servlet 环境下才会生效，RestTemplate 和 Feign 针对这些配置都无法生效

https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel

https://github.com/alibaba/Sentinel/wiki/网关限流

Liu_Shihao

关注

3
点赞
踩
2

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringCloudAlibaba——Sentinel与SpringBoot整合

目录一、介绍二、如何使用2.1 引入依赖2.2 Sentinel 控制台2.3 Fegin支持2.4 RestTemplate 支持2.5 网关限流2.5.1 Zuul 支持2.5.2 Spring Cloud Gateway 支持2.6 Endpoint 支持2.7 配置一、介绍随着微服务的流行，服务和服务之间的稳定性变得越来越重要。 Sentinel 以流量为切入点，从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。Sentinel 具有以下特征:丰富的应用场景： Sentin
复制链接

扫一扫