Steeltoe Circuit Breaker 使用与安装指南

1. 项目目录结构及介绍

Steeltoe Circuit Breaker 是一个适用于 .NET 微服务架构中的断路器模式实现，它帮助应用在面对依赖服务故障时保持弹性。以下是一个典型的项目目录结构概述，基于从 https://github.com/SteeltoeOSS/CircuitBreaker.git 获取的基础项目模板可能包含的内容：

├── src                                  # 主要源码目录
│   ├── Steeltoe.CircuitBreaker.Hystrix   # 断路器核心实现，可能包含Hystrix的相关类和接口
│   ├── Steeltoe.CircuitBreaker.Resilience4j # 若采用Resilience4j，此目录将包含相关适配或集成代码
│   └── YourApplication                  # 应用示例项目
│       ├── Controllers                 # 包含控制器，展示如何使用断路器
│       ├── Models                      # 数据模型定义
│       ├── Startup.cs                 # 应用程序的启动配置文件
│       └── appsettings.json            # 配置文件
├── test                                 # 测试目录，包含单元测试和集成测试案例
│   ├── YourApplication.Tests
└── README.md                            # 项目介绍和快速入门指南

• src: 包含项目的核心库和你的应用程序代码。
• YourApplication: 示例应用程序，展示了如何集成并使用断路器。
  • Controllers: 控制器层，用于演示如何在HTTP请求中应用断路器策略。
  • Startup.cs: ASP.NET Core应用程序的入口点，用于配置中间件、服务等。
  • appsettings.json: 存储应用配置，包括断路器的具体配置参数。

2. 项目的启动文件介绍

Startup.cs

在.NET项目中，Startup.cs 文件是配置应用程序的关键文件，它负责设置应用程序的服务容器以及中间件管道。对于使用 Steeltoe Circuit Breaker 的应用，这一文件通常包含以下几个关键部分：

• ConfigureServices(IServiceCollection services):

  • 注册 Steeltoe Circuit Breaker 的服务，这可能涉及到添加Hystrix或Resilience4j的配置和服务。
  • 示例代码可能包含对 Steeltoe 相关服务的添加，如：

    services.AddSteeltoeCircuitBreaker(config => {
        config.AddHystrixCommand("MyService", options => {
            options.SetCommandKey(new CommandKey("service-command"));
            options.SetExecutionIsolationStrategy(IsolationStrategy.Thread);
            options.SetRequestVolumeThreshold(5);
            options.SetSleepWindowInMilliseconds(5000);
            options.SetErrorPercentageThreshold(50);
        });
    });
    

• Configure(IApplicationBuilder app, IWebHostEnvironment env):

  • 设置路由和任何其他中间件，例如日志记录或身份验证，以及如何应用断路器到特定的API端点。

3. 项目的配置文件介绍

appsettings.json

应用程序的配置文件通常命名为 appsettings.json，用于存储非敏感的全局配置数据。当使用 Steeltoe Circuit Breaker 时，该文件可以包含相关的断路器设置，例如：

{
  "Logging": { ... }, // 日志配置
  "Steeltoe": {
    "CircuitBreaker": {
      "Hystrix": {
        "Commands": [
          {
            "Name": "MyService",
            "RequestVolumeThreshold": 5,
            "SleepWindowInMilliseconds": 5000,
            "ErrorThresholdPercentage": 50,
            "ExecutionIsolationStrategy": "Thread"
          }
        ]
      }
    }
  }
}

• CircuitBreaker: 定义了断路器的具体配置。
• Commands: 列出了不同服务命令的配置，每个命令可以通过其名称进行识别，并且有具体的阈值、睡眠窗口和其他策略细节。

请注意，这些是示例性的结构和步骤，实际的项目结构、启动文件内容和配置文件可能会根据具体版本的 Steeltoe 和使用的断路器框架（Hystrix 或 Resilience4j）有所不同。务必参考最新的官方文档来获取最精确的信息。