My-Blog

SpringCloud@HystrixCommand进行熔断降级

Hystrix 是 Spring Cloud Netflix 子项目的核心组件之一，具有服务容错及线程隔离等一系列服务保护功能。 能保证服务调用者在调用异常服务时快速返回结果，避免大量的同步等待，并且熔断器能在一段时间后继续侦测请求执行结果，提供恢复服务调用的可能。

何时触发降级

  • 执行方法抛出异常
  • 熔断器打开导致命令短路（保险丝断了）
  • 命令的线程池和队列或信号量的容量超额，命令被拒绝
  • 命令执行超时

测试案例

首先我们导入所需依赖


<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
    <!--<version>2.2.10.RELEASE</version>-->
</dependency>

简单使用如下，当我们调用hello方法时，出现/ by zero异常时，执行降级方法fallbackMethod并返回相应的数据。

注意: 启动类需要增加：@EnableHystrix 注解后才会启用。


@EnableHystrix
@RestController
public class TestController {

    @PostMapping("/hello")
    @HystrixCommand(
            // 指定服务降级处理方法
            fallbackMethod = "fallbackMethod"
    )
    public String hello(String param) {
        System.out.println(1 / 0);
        return "收到";
    }

    public String fallbackMethod(String param) {
        System.out.println("出现了异常：" + param);
        return "你请求我失败了！";
    }

}

附常用配置

例如HystrixCommandProperties配置默认超时为1s，所以在耗时比较长的业务中很容易触发降级，所以可以适当增长超时时间， 如下配置3s内访问成功，超过3s触发降级。

@HystrixCommand(fallbackMethod = "fallbackMethod",

        // 忽略某些异常，不触发服务降级
        ignoreExceptions = {NullPointerException.class},
        // 线程池名称，用于划分线程池（舱壁模式，线程隔离的⼿段）
        threadPoolKey = "hello_method_fallback_pool",

        commandProperties = {
                // 请求超时时间
                @HystrixProperty(name = "execution.isolation.thread.timeoutInMilliseconds", value = "3000"),

                // 判断熔断的最少请求数，默认是10；只有在一个统计窗口内处理的请求数量达到这个阈值，才会进行熔断与否的判断
                @HystrixProperty(name = "circuitBreaker.requestVolumeThreshold", value = "10"),
                // 判断熔断的阈值，表示在一个统计窗口内有50%的请求处理失败，会触发熔断，默认是50
                @HystrixProperty(name = "circuitBreaker.errorThresholdPercentage", value = "50"),

                // 自我修复检测窗口时长，熔断后自动检测服务是否可用，可用后进行恢复调用
                @HystrixProperty(name = "circuitBreaker.sleepWindowInMilliseconds", value = "3000")
        }
)

通过本地、Nacos、Apollo等方式配置线程池、熔断策略（运行时修改可实时生效）

步骤一

自定义一个类，实现HystrixDynamicProperties接口即可， 获取配置值时通过Environment接口读取配置中的数据，代码如下

/**
 * 〈CustomizeHystrixDynamicProperties〉
 *
 * @author devin.ding
 * @date 2024/10/30 22:10
 * @since 1.0.0
 */
public class CustomizeHystrixDynamicProperties implements HystrixDynamicProperties {


    private final Environment environment;

    public CustomizeHystrixDynamicProperties() {
        this.environment = SpringUtil.getBean(Environment.class);
    }

    @Override
    public HystrixDynamicProperty<String> getString(String name, String fallback) {
        return new HystrixDynamicProperty<String>() {

            @Override
            public String get() {
                return environment.getProperty(name, fallback);
            }

            @Override
            public String getName() {
                return name;
            }

            @Override
            public void addCallback(Runnable callback) {

            }
        };
    }

    @Override
    public HystrixDynamicProperty<Integer> getInteger(String name, Integer fallback) {
        return new HystrixDynamicProperty<Integer>() {

            @Override
            public Integer get() {
                String value = environment.getProperty(name);
                if (StrUtil.isNotBlank(value)) {
                    return Integer.valueOf(value);
                }
                return fallback;
            }

            @Override
            public String getName() {
                return name;
            }

            @Override
            public void addCallback(Runnable callback) {

            }
        };
    }

    @Override
    public HystrixDynamicProperty<Long> getLong(String name, Long fallback) {
        return new HystrixDynamicProperty<Long>() {

            @Override
            public Long get() {
                String value = environment.getProperty(name);
                if (StrUtil.isNotBlank(value)) {
                    return Long.valueOf(value);
                }
                return fallback;
            }

            @Override
            public String getName() {
                return name;
            }

            @Override
            public void addCallback(Runnable callback) {

            }
        };
    }

    @Override
    public HystrixDynamicProperty<Boolean> getBoolean(String name, Boolean fallback) {
        return new HystrixDynamicProperty<Boolean>() {

            @Override
            public Boolean get() {
                String value = environment.getProperty(name);
                if (StrUtil.isNotBlank(value)) {
                    return Boolean.valueOf(value);
                }
                return fallback;
            }

            @Override
            public String getName() {
                return name;
            }

            @Override
            public void addCallback(Runnable callback) {

            }
        };
    }
}

步骤二

然后resources目录中增加META-INF/services文件夹， 里面新增com.netflix.hystrix.strategy.properties.HystrixDynamicProperties文件， 内容为上面代码类的全路径类名，例如：com.**.CustomizeHystrixDynamicProperties。

步骤三

项目对应application.yml或者apollo等配置文件如下

hystrix:
  threadpool:
    default: # 默认的，如果没有匹配到自定义的配置，则使用此配置
      coreSize: 10
      maximumSize: 50
      queueSizeRejectionThreshold: 1000
    threadPoolKey1: # 对应 @HystrixCommand 注解中 threadPoolKey 值
      coreSize: 10
      maximumSize: 50
      queueSizeRejectionThreshold: 1000
  command:
    default: # 默认的，如果没有匹配到自定义的配置，则使用此配置
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 4000
      circuitBreaker:
        requestVolumeThreshold: 10
        errorThresholdPercentage: 50
        sleepWindowInMilliseconds: 3000
    commandKey1: # 对应 @HystrixCommand 注解中 commandKey 值
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 13000
      circuitBreaker:
        requestVolumeThreshold: 5
        errorThresholdPercentage: 10
        sleepWindowInMilliseconds: 6000

底层见如下类方法

com.netflix.hystrix.HystrixCommandProperties#HystrixCommandProperties
com.netflix.hystrix.HystrixThreadPoolProperties#HystrixThreadPoolProperties

执行隔离策略

HystrixCommand支持两种隔离策略：线程池隔离和信号量隔离，默认使用线程池隔离策略，以下是两者的简要对比：

线程池信号量
线程开启一个子线程执行调用线程上执行
开销排队、调度、线程切换无线程切换，开销低
异步支持不支持
并发受限于线程池大小受限于信号量上限，默认10
超时支持不支持

MDC链路追踪、上下文无法传递问题

在使用HystrixCommand时，由于HystrixCommand默认会在独立的线程中执行，所以在使用MDC以及其他ThreadLocal传递信息时， 会无法正常传递，解决方法如下：

方案1

使用信号量隔离策略，将HystrixCommand的执行策略设置为SEMAPHORE，从而保证MDC等上下文的传递。 与默认THREAD区别是，SEMAPHORE是在调用线程中执行，而THREAD是在新线程中执行。

@HystrixCommand(
        fallbackMethod = "fallbackMethod",
        commandProperties = {
                @HystrixProperty(name = "execution.isolation.strategy", value = "SEMAPHORE")
        }
)

方案2

使用HystrixConcurrencyStrategy自定义策略，手动将MDC等上下文传递到新线程中。

import com.netflix.hystrix.strategy.HystrixPlugins;
import com.netflix.hystrix.strategy.concurrency.HystrixConcurrencyStrategy;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import java.util.Map;
import java.util.concurrent.Callable;

@Component
public class CustomizedHystrixConcurrencyStrategy extends HystrixConcurrencyStrategy {

    public CustomizedHystrixConcurrencyStrategy() {
        HystrixPlugins.reset();
        HystrixPlugins.getInstance().registerConcurrencyStrategy(this);
        // 以上可以改为SPI方式注册
        // `resources`目录下增加`META-INF/services`文件夹，
        // 增加文件`com.netflix.hystrix.strategy.concurrency.HystrixConcurrencyStrategy`
        // 文件内容为此类的全路径类名，例如：com.**.CustomizedHystrixConcurrencyStrategy
    }

    @Override
    public <T> Callable<T> wrapCallable(Callable<T> callable) {
        Map<String, String> map = MDC.getCopyOfContextMap();
        if (map == null) {
            return callable;
        }
        return () -> {
            try {
                MDC.setContextMap(map);
                return callable.call();
            } finally {
                MDC.clear();
            }
        };
    }

}

方案3

使用InheritableThreadLocal或者TransmittableThreadLocal，具体使用细节就不一一说明了。 如果遇到源码无法修改，例如使用MDC以及RequestContextHolder.getRequestAttributes()时，则需要使用以上两种方式了。

更新日期:
作者: devin.ding, qwding