01-Sentinel与spring-cloud的整合

  • Post author:
  • Post category:其他




一,

Sentinel

介绍

随着微服务的流行,服务和服务之间的稳定性变得越来越重要。Sentinel 是面向分布式、多语言异构化服务架构的流量治理组件,主要以流量为切入点,从流量路由、流量控制、流量整形、熔断降级、系统自适应过载保护、热点流量防护等多个维度来帮助开发者保障微服务的稳定性,主要作用即是

流量控制



熔断降级

。Sentinel 可以简单的分为 Sentinel 核心库和 Dashboard(配置界面)。



二, Sentinel 两个基本概念


1.资源:


资源是 Sentinel 的关键概念。它可以是 Java 应用程序中的任何内容,例如,由应用程序提供的服务,或由应用程序调用的其它应用提供的服务,甚至可以是一段代码。

只要通过 Sentinel API 定义的代码,就是资源,能够被 Sentinel 保护起来。大部分情况下,可以使用方法签名,URL,甚至服务名称作为资源名来标示资源。


2.规则:


围绕资源的实时状态设定的规则,可以包括流量控制规则、熔断降级规则以及系统保护规则。所有规则可以动态实时调整,即可在sentinel-dashboard控制面板上实时修改。



三,sentinel整合Spring Cloud


参考整合地址

在这里插入图片描述


1.项目引入sentinel的整合依赖包

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

<!-如遇到sentinel依赖包无法下载请添加云启动器阿里巴巴nacos发现-->
<dependencyManagement>
	<dependencies>
		<!-- spring cloud alibaba 2.1.0.RELEASE-->
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-alibaba-dependencies</artifactId>
			<version>2.1.0.RELEASE</version>
			<type>pom</type>
			<scope>import</scope>
		</dependency>
	</dependencies>
</dependencyManagement>

下载后的包为1.6.3

在这里插入图片描述

就是这么简单只需要引入一个依赖即可完成sentinel 和 springcloud的整合。



四,Sentinel-Dashboard 控制台

由于我们项目下载sentinel的核心依赖包是1.6.3的版本,那么我们下载sentinel的控制台也需要下载1.6.3的版本。

下载地址

下载后在解压目录下执行cmd进入dos窗口执行

java -jar sentinel-dashboard-1.6.3.jar –server.port=3080 (3080为自定的端口,默认为8080)

在这里插入图片描述

启动成功后在浏览器输入 127.0.0.1:3080即可,登录入的账号密码都是sentinel

在这里插入图片描述



五, 将项目数据同步到控制面板

在上两步中,项目引入了sentinel的依赖包进行了整合,以及控制面板的启动,但是现在还需要将项目的数据同步到控制面板中实现数据统计。

在项目的yml文件中引入几个简单的配置即可;

spring:
  cloud:
    sentinel:
      transport:
        port: 8719 
        dashboard: localhost:3080  #dashboard 的端口

这里的

spring.cloud.sentinel.transport.port

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

在准备一个简单的接口。

@RestController
@RequestMapping("/sentinel")
public class SentinelTestController {

    private static Logger logger = Logger.getLogger(SentinelTestController.class);

    @GetMapping("/test")
    public String sentinelTest(){
        return "OK";
    }
}

登录sentinel的控制面板进行查看

在这里插入图片描述

这里就完成了sentinel-core,sentinel-dashboard 与 spring-cloud 的整合了 😄 😄 😄



六,Endpoint 支持

在使用 Endpoint 特性之前需要在 Maven 中添加

spring-boot-starter-actuator

依赖,并在配置中允许 Endpoints 的访问。

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

Spring Boot 1.x 中添加配置 management.security.enabled=false。暴露的 endpoint

路径为 /sentinel

Spring Boot 2.x 中添加配置 management.endpoints.web.exposure.include=*。暴露的 endpoint 路径为

/actuator/sentinel

pom文件中引入spring的审计依赖包

<!-- actuator spring的审计的依赖包 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

yml文件配置springboot的暴露

management:
  endpoints:
    web:
      exposure:
        include: '*'

在这里插入图片描述

通过上面两步配置,即可在实时监控里面看到对应数据



七,sentinel定义资源的几种方式


方式一:主流框架的默认适配


为了减少开发的复杂程度,我们对大部分的主流框架,例如 Web Servlet、Dubbo、Spring Cloud、gRPC、Spring WebFlux、Reactor 等都做了适配。您只需要引入对应的依赖即可方便地整合 Sentinel。


方式二:抛出异常的方式定义资源

// 1.5.0 版本开始可以利用 try-with-resources 特性
// 资源名可使用任意有业务语义的字符串,比如方法名、接口名或其它可唯一标识的字符串。
try (Entry entry = SphU.entry("resourceName")) {
  // 被保护的业务逻辑
  // do something here...
} catch (BlockException ex) {
  // 资源访问阻止,被限流或被降级
  // 在此处进行相应的处理操作
}


方式三:返回布尔值方式定义资源

 // 资源名可使用任意有业务语义的字符串
  if (SphO.entry("自定义资源名")) {
    // 务必保证finally会被执行
    try {
      /**
      * 被保护的业务逻辑
      */
    } finally {
      SphO.exit();
    }
  } else {
    // 资源访问阻止,被限流或被降级
    // 进行相应的处理操作
  }


方式四:注解方式定义资源

// 原本的业务方法.
@SentinelResource(value = "sentinelResourceName",blockHandler = "blockHandlerForGetUser",fallback = "exceptionFallback")
public User getUserById(String id) {
    throw new RuntimeException("getUserById command failed");
}

//blockHandler 函数,原方法调用被限流/降级/系统保护的时候调用
//no原函数的请求参数
//返回值需要与调用方法一致
public User blockHandlerForGetUser(String id, BlockException ex) {
    return new User("admin");
}

//fallback资源出现异常的时候调用
//no原函数的请求参数
//返回值需要与调用方法一致
public String exceptionFallback(Integer no, Throwable ex){
    return "no:"+no+" Exception:"+ ex.getMessage();
}


方式五:异步调用支持

try {
    AsyncEntry entry = SphU.asyncEntry(resourceName);

    // 异步调用.
    doAsync(userId, result -> {
        try {
            // 在此处处理异步调用的结果.
        } finally {
            // 在回调结束后 exit.
            entry.exit();
        }
    });
} catch (BlockException ex) {
    // Request blocked.
    // Handle the exception (e.g. retry or fallback).
}

其中第一种可能和注解的方式使用的会比较多,其他的大家可以自己试一下。 😉 😉 😉

》》》》》》》》》》》》》》》》下节将介绍控制面板如何配置流控,降级规则



版权声明:本文为qq_47200599原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。