Golang实现熔断器模式与电路状态控制的插件库go-tripper的使用

Tripper简介

Tripper是一个用于Go语言的熔断器包，允许您控制和监控电路状态。

安装

使用go get安装Tripper：

go get github.com/rajnandan1/go-tripper

使用方法

在Go代码中导入Tripper包：

import "github.com/rajnandan1/go-tripper"

添加电路

使用ConfigureCircuit函数添加电路：

基于计数的电路

// 添加一个电路，如果在1分钟内失败次数超过10次将触发熔断
// 最小计数为100
circuitOptions := tripper.CircuitOptions{
    Name:              "example-circuit",
    Threshold:         10,
    ThresholdType:     tripper.ThresholdCount,
    MinimumCount:      100,
    IntervalInSeconds: 60,
    OnCircuitOpen:     onCircuitOpenCallback,
    OnCircuitClosed:   onCircuitClosedCallback,
}

circuit, err := tripper.ConfigureCircuit(circuitOptions)
if err != nil {
    fmt.Println("Failed to add circuit:", err)
    return
}

基于百分比的电路

// 添加一个电路，如果在1分钟内失败率超过10%将触发熔断
// 最小计数为100
circuitOptions := tripper.CircuitOptions{
    Name:              "example-circuit",
    Threshold:         10,
    ThresholdType:     tripper.ThresholdPercentage,
    MinimumCount:      100,
    IntervalInSeconds: 60,
    OnCircuitOpen:     onCircuitOpenCallback,
    OnCircuitClosed:   onCircuitClosedCallback,
}

circuit, err := tripper.ConfigureCircuit(circuitOptions)
if err != nil {
    fmt.Println("Failed to add circuit:", err)
    return
}

基于连续错误的电路

// 添加一个电路，如果在1分钟内连续出现10次错误将触发熔断
// 最小计数为100
circuitOptions := tripper.CircuitOptions{
    Name:              "example-circuit",
    Threshold:         10,
    ThresholdType:     tripper.ThresholdConsecutive,
    MinimumCount:      100,
    IntervalInSeconds: 60,
    OnCircuitOpen:     onCircuitOpenCallback,
    OnCircuitClosed:   onCircuitClosedCallback,
}

circuit, err := tripper.ConfigureCircuit(circuitOptions)
if err != nil {
    fmt.Println("Failed to add circuit:", err)
    return
}

带回调函数的电路

func onCircuitOpenCallback(x tripper.CallbackEvent){
    fmt.Println("Callback OPEN")
    fmt.Println(x.FailureCount)
    fmt.Println(x.SuccessCount)
    fmt.Println(x.Timestamp)
}
func onCircuitClosedCallback(x tripper.CallbackEvent){
    fmt.Println("Callback Closed")
    fmt.Println(x.FailureCount)
    fmt.Println(x.SuccessCount)
    fmt.Println(x.Timestamp)
}
circuitOptions := tripper.CircuitOptions{
    Name:              "example-circuit",
    Threshold:         10,
    ThresholdType:     tripper.ThresholdCount,
    MinimumCount:      100,
    IntervalInSeconds: 60,
    OnCircuitOpen:     onCircuitOpenCallback,
    OnCircuitClosed:   onCircuitClosedCallback,
}

circuit, err := tripper.ConfigureCircuit(circuitOptions)
if err != nil {
    fmt.Println("Failed to add circuit:", err)
    return
}

电路选项

电路会在IntervalInSeconds后重置

更新电路状态

根据事件的成功与否使用UpdateStatus函数更新电路状态：

circuit.UpdateStatus(true)  // 成功事件
circuit.UpdateStatus(false) // 失败事件

检查电路状态

使用IsCircuitOpen函数检查电路是打开还是关闭：

isOpen := circuit.IsCircuitOpen()
if isOpen {
    fmt.Println("Circuit is open")
} else {
    fmt.Println("Circuit is closed")
}

示例：使用熔断器的HTTP请求

以下是一个使用Tripper处理HTTP请求并实现熔断器的完整示例：

package main

import (
    "fmt"
    "time"

    "github.com/rajnandan1/go-tripper"
)

func main() {
    // 配置电路选项
    circuitOptions := tripper.CircuitOptions{
        Name:              "MyServiceMonitor",
        Threshold:         50, // 触发电路打开的阈值(百分比)
        ThresholdType:     tripper.ThresholdPercentage,
        MinimumCount:      10,  // 监控所需的最小事件数
        IntervalInSeconds: 60,  // 监控时间间隔(秒)
        OnCircuitOpen: func(event tripper.CallbackEvent) {
            fmt.Println("Circuit opened:", event)
        },
        OnCircuitClosed: func(event tripper.CallbackEvent) {
            fmt.Println("Circuit closed:", event)
        },
    }

    // 创建新电路
    circuit, err := tripper.ConfigureCircuit(circuitOptions)
    if err != nil {
        fmt.Println("Error creating circuit:", err)
        return
    }

    // 模拟调用服务
    for i := 0; i < 20; i++ {
        success := i%2 == 0 // 模拟每隔一次调用失败
        circuit.UpdateStatus(success)
        time.Sleep(time.Second)
    }

    // 检查电路是否打开
    if circuit.IsCircuitOpen() {
        fmt.Println("Circuit is open!")
    } else {
        fmt.Println("Circuit is closed.")
    }
}

许可证

本项目使用MIT许可证。