Sentinel使用,处理服务的降级熔断限流

文章目录

  • 一、项目采用alibaba-Sentinel处理服务的降级熔断限流
    • Sentinel 具有以下特征:
    • Sentinel 的主要特性:
  • 二、使用
    • 1、引入POM:(父POM已经引入强依赖)
    • 2、利用@ SentinelResource注解,进行资源埋点:
      • 注解包含以下属性:
    • 3、yml配置:
    • 举例
      • 在需要处理的方法上埋点,资源名为:sentinel-findById
      • 控制台就可以看到(控制台单独部署,不依赖任何)
      • 规则定义:(待完善)
      • 异常处理类:
  • 三、在Feign中使用:
    • 1、yml配置 feign打开sentinel支持(注意:这里是指客户端配置,也就是调用方)
    • 2、API模块新建fallback包,
    • 3、实现FallbackFactory接口
    • 4、在Feign接口中 添加fallbackFactory,如下图
  • 四、在spring-cloud-gateway 中集成(待完善)

一、项目采用alibaba-Sentinel处理服务的降级熔断限流

Sentinel 具有以下特征:

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

Sentinel 的主要特性:

Sentinel使用,处理服务的降级熔断限流_第1张图片

二、使用

1、引入POM:(父POM已经引入强依赖)

    
        com.alibaba.cloud
        spring-cloud-starter-alibaba-sentinel
    

2、利用@ 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 逻辑中,而是会原样抛出。
    特别地,若 blockHandler 和 fallback 都进行了配置,则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和 defaultFallback,则被限流降级时会将 BlockException 直接抛出。

3、yml配置:

Spring:
	  cloud:
		sentinel:
		  transport:
			dashboard: 127.0.0.1:8080  #sentinel控制台地址
		  # 取消Sentinel控制台懒加载
		  eager: true

举例

在需要处理的方法上埋点,资源名为:sentinel-findById

	@Override
    @SentinelResource(value = "sentinel-findById", blockHandler = "blockExceptionHandler", blockHandlerClass = {
     
            ExceptionUtil.class})
    public ResponseResult findById(@RequestBody @Valid RequestObject<StorageSelectDTO> requestObject) {
     
        Storage one = storageService.getOne(Wrappers.<Storage>lambdaQuery().eq(Storage::getId, requestObject.getData().getId()));
        return Objects.isNull(one)?ResponseResult.fail(StorageCode.FIND_FAIL):ResponseResult.success(one);
    }

控制台就可以看到(控制台单独部署,不依赖任何)

控制台点击下载
Sentinel使用,处理服务的降级熔断限流_第2张图片

规则定义:(待完善)

异常处理类:

项目中添加fallback包
Sentinel使用,处理服务的降级熔断限流_第3张图片

package cn.geek.storage.fallback;

import cn.geek.common.model.base.BaseCode;
import cn.geek.common.model.pojo.RequestObject;
import cn.geek.common.model.pojo.ResponseResult;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.authority.AuthorityException;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
import com.alibaba.csp.sentinel.slots.system.SystemBlockException;
import lombok.extern.slf4j.Slf4j;

/**
 * @version 1.0
 * @Author Z.Y
 * @Description 此类定义@SentinelResource的属性 blockHandler 和fallbackHandler
 * @Date 2020/4/22 11:19
 */
@Slf4j
public class ExceptionUtil {
     

    /**
     * 对应@SentinelResource的属性 blockHandler
     * @param requestObject
     * @param e
     * @return
     */
    public static ResponseResult blockExceptionHandler(RequestObject requestObject, BlockException e) {
     
        log.info("Oops: " + e.getClass().getCanonicalName());
        // 不同的异常返回不同的提示语
        if (e instanceof FlowException) {
     
            log.info("接口限流了");
            return ResponseResult.fail("接口限流");
        } else if (e instanceof DegradeException) {
     
            log.info("服务降级了");
            return ResponseResult.fail("服务熔断降级了");
        } else if (e instanceof ParamFlowException) {
     
            log.info("热点参数限流了");
            return ResponseResult.fail("热点参数限流了");
        } else if (e instanceof SystemBlockException) {
     
            log.info("触发系统保护规则");
            return ResponseResult.fail("触发系统保护规则");
        } else if (e instanceof AuthorityException) {
     
            log.info("触发系统保护规则");
            return ResponseResult.fail("触发系统保护规则");
        }
        return ResponseResult.fail(BaseCode.CALL_TIME);
    }

    /**
     * 对应@SentinelResource的属性 fallbackHandler
     * @param requestObject
     * @param e
     * @return
     */
    public static ResponseResult fallbackHandler(RequestObject requestObject, Throwable e) {
     
        log.info("Oops: " + e.getClass().getCanonicalName());
        // 不同的异常返回不同的提示语
        if (e instanceof FlowException) {
     
            log.info("接口限流了");
            return ResponseResult.fail("接口限流");
        } else if (e instanceof DegradeException) {
     
            log.info("服务降级了");
            return ResponseResult.fail("服务熔断降级了");
        } else if (e instanceof ParamFlowException) {
     
            log.info("热点参数限流了");
            return ResponseResult.fail("热点参数限流了");
        } else if (e instanceof SystemBlockException) {
     
            log.info("触发系统保护规则");
            return ResponseResult.fail("触发系统保护规则");
        } else if (e instanceof AuthorityException) {
     
            log.info("触发系统保护规则");
            return ResponseResult.fail("触发系统保护规则");
        }
        return ResponseResult.fail(BaseCode.CALL_TIME);
    }
}

三、在Feign中使用:

1、yml配置 feign打开sentinel支持(注意:这里是指客户端配置,也就是调用方)

feign:
	sentinel:
		enabled: true

2、API模块新建fallback包,

Sentinel使用,处理服务的降级熔断限流_第4张图片

3、实现FallbackFactory接口

package cn.geek.storage.feigapi.fallback;

import cn.geek.common.model.base.BaseCode;
import cn.geek.common.model.pojo.RequestObject;
import cn.geek.common.model.pojo.ResponseResult;
import cn.geek.storage.feigapi.api.StorageApi;
import cn.geek.storage.feigapi.dto.StorageSelectDTO;
import cn.geek.storage.feigapi.entity.Storage;
import feign.hystrix.FallbackFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

/**
 * @version 1.0
 * @Author Z.Y
 * @Description 熔断
 * @Date 2020/4/21 19:57
 */
@Component
@Slf4j
public class StorageApiFallbackFactory implements FallbackFactory<StorageApi> {
     


    @Override
    public StorageApi create(Throwable throwable) {
     
        return new StorageApi() {
     
            @Override
            public ResponseResult findById(RequestObject<StorageSelectDTO> requestObject) {
     
                log.info("findById熔断!",throwable);
                return ResponseResult.fail(BaseCode.REQUEST_TIME_OUT);
            }

            @Override
            public ResponseResult insert(RequestObject<Storage> requestObject) {
     
                log.info("insert熔断!",throwable);
                return ResponseResult.fail(BaseCode.REQUEST_TIME_OUT);
            }

            @Override
            public ResponseResult deleteById(RequestObject<Storage> requestObject) {
     
                log.info("deleteById熔断!",throwable);
                return ResponseResult.fail(BaseCode.REQUEST_TIME_OUT);
            }

            @Override
            public ResponseResult update(RequestObject<Storage> requestObject) {
     
                log.info("update熔断!",throwable);
                return ResponseResult.fail(BaseCode.REQUEST_TIME_OUT);
            }

            @Override
            public ResponseResult findPage(RequestObject<StorageSelectDTO> requestObject) {
     
                log.info("findPage熔断!",throwable);
                return ResponseResult.fail("服务熔断降级!");
            }
        };
    }
}

4、在Feign接口中 添加fallbackFactory,如下图

四、在spring-cloud-gateway 中集成(待完善)

你可能感兴趣的:(微服务,Sentinel,spring,boot,分布式,spring,java)