SpringCloud-Hystrix组件使用方法

SpringCloud Hystrix 组件使用方法攻略

概述

SpringCloud Hystrix 组件是一个用于服务容错和限流的工具，用于帮助我们处理分布式系统的各种问题，提升系统的可用性、稳定性和弹性。本文将详细讲解 Hystrix 组件的使用方法，包括如何在项目中配置 Hystrix、如何编写 Hystrix Command、如何在 Feign 中使用 Hystrix、如何监控 Hystrix 熔断等。

Hystrix 配置

在使用 Hystrix 组件之前，需要在项目中引入 Hystrix 的依赖，并在配置文件中进行相关配置。在 pom.xml 文件中引入 Hystrix 的依赖：

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

在配置文件中，可以配置全局的 Hystrix 相关参数：

hystrix:
  command:
    # 执行隔离策略，默认为线程池隔离
    isolation:
      strategy: THREAD
    # Hystrix 框架的数据统计周期，默认为1秒
    metrics:
      rollingStats:
        timeInMilliseconds: 10000
  threadpool:
    default:
      # 线程池大小，默认为10
      coreSize: 20

编写 Hystrix Command

在使用 Hystrix 的过程中，需要编写 Hystrix Command 类来包装需要被处理的逻辑。Hystrix Command 是一个继承自 HystrixCommand<T> 的类，它需要实现 run() 方法和 getFallback() 方法。

run() 方法是需要使用 Hystrix 进行容错处理的逻辑，我们可以将原本需要处理的逻辑放在 run() 方法中。

getFallback() 方法是处理容错时的备选逻辑，当 run() 方法出现异常或返回空结果时，Hystrix 会调用 getFallback() 方法执行一段备选逻辑。

以下是一个 Hystrix Command 的例子：

public class MyHystrixCommand extends HystrixCommand<String> {

    private final String name;

    public MyHystrixCommand(String name) {
        super(HystrixCommandGroupKey.Factory.asKey("MyGroup"));
        this.name = name;
    }

    @Override
    protected String run() throws Exception {
        // 执行需要进行容错的逻辑
        return "Hello, " + name + "!";
    }

    @Override
    protected String getFallback() {
        // 备选逻辑
        return "Fallback: Hello, world!";
    }
}

在 Feign 中使用 Hystrix

在使用 Feign 进行服务间调用的过程中，可以使用 Hystrix 来进行容错处理。

首先，需要在 Feign 的客户端中添加 @FeignClient 注解，并开启 Hystrix 支持：

@FeignClient(name = "service1", fallback = Service1Fallback.class)
@EnableFeignClients(defaultConfiguration = FeignConfiguration.class)
public interface Service1Client {

    @GetMapping("/service1/hello")
    String hello();
}

其中，fallback 属性指定了当调用服务失败时，Feign 将会调用的备选类。

然后，编写备选类 Service1Fallback：

@Component
public class Service1Fallback implements Service1Client {
    @Override
    public String hello() {
        return "Fallback: Hello, world!";
    }
}

监控 Hystrix 熔断

为了更好地监控 Hystrix 的熔断情况，我们可以使用 Hystrix Dashboard 进行监控。

在项目中添加 Hystrix Dashboard 的依赖：

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

然后，在启动类中添加 @EnableHystrixDashboard 注解开启 Hystrix Dashboard。

通过访问 http://localhost:port/hystrix 可以查看 Hystrix Dashboard，点击页面上方的 Monitor Streams 按钮，输入要监控的 Hystrix 应用的地址即可查看该应用的熔断情况。

示例

以下是一个基于 SpringCloud 的 Hystrix 应用的示例。

依赖

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
</dependency>

配置

spring:
  application:
    name: springcloud-hystrix-example

server:
  port: 8080

eureka:
  client:
    serviceUrl:
      defaultZone: ${EUREKA_DEFAULT_ZONE:http://localhost:8761/eureka/}

hystrix:
  command:
    # 执行隔离策略，默认为线程池隔离
    isolation:
      strategy: THREAD
    # Hystrix 框架的数据统计周期，默认为1秒
    metrics:
      rollingStats:
        timeInMilliseconds: 10000
  threadpool:
    default:
      # 线程池大小，默认为10
      coreSize: 20

访问

通过访问 http://localhost:8080/sayhello/{name} 可以立即返回 Hello, {name}!，如果访问地址为 http://localhost:8080/sayhello/World 将会返回 Hello, World!。同时，在 Hystrix Dashboard 中查看该应用的熔断情况。

代码

@RestController
public class HystrixExampleController {

    /**
     * Hystrix 组件的示例
     * @param name
     * @return
     */
    @GetMapping("/sayhello/{name}")
    public String sayHello(@PathVariable String name) {
        HystrixCommand<String> command = new MyHystrixCommand(name);
        return command.execute();
    }
}

public class MyHystrixCommand extends HystrixCommand<String> {

    private final String name;

    public MyHystrixCommand(String name) {
        super(HystrixCommandGroupKey.Factory.asKey("MyGroup"));
        this.name = name;
    }

    @Override
    protected String run() throws Exception {
        // 执行需要进行容错的逻辑
        return "Hello, " + name + "!";
    }

    @Override
    protected String getFallback() {
        // 备选逻辑
        return "Fallback: Hello, world!";
    }
}