组件分享之后端组件——在Go中实现的断路器gobreaker

背景

近期正在探索前端、后端、系统端各类常用组件与工具，对其一些常见的组件进行再次整理一下，形成标准化组件专题，后续该专题将包含各类语言中的一些常用组件。欢迎大家进行持续关注。

组件基本信息

• 组件：gobreaker
• 开源协议：MIT license

内容

本节我们分享一个在Go中实现的断路器gobreaker

1、安装

go get github.com/sony/gobreaker

2、使用

var cb *breaker.CircuitBreaker

func Get(url string) ([]byte, error) {
    body, err := cb.Execute(func() (interface{}, error) {
        resp, err := http.Get(url)
        if err != nil {
            return nil, err
        }

        defer resp.Body.Close()
        body, err := ioutil.ReadAll(resp.Body)
        if err != nil {
            return nil, err
        }

        return body, nil
    })
    if err != nil {
        return nil, err
    }

    return body.([]byte), nil
}

3、具体说明

CircuitBreaker 结构是一个状态机，用于防止发送可能失败的请求。该函数NewCircuitBreaker创建一个新的CircuitBreaker.

func NewCircuitBreaker(st Settings) *CircuitBreaker

您可以CircuitBreaker通过 struct进行配置Settings：

type Settings struct {
    Name          string
    MaxRequests   uint32
    Interval      time.Duration
    Timeout       time.Duration
    ReadyToTrip   func(counts Counts) bool
    OnStateChange func(name string, from State, to State)
    IsSuccessful  func(err error) bool
}

• Name是CircuitBreaker 的名称

• MaxRequestsCircuitBreaker是半开时允许通过的最大请求数。如果MaxRequests为 0，CircuitBreaker则只允许 1 个请求。

• Interval是CircuitBreaker关闭状态的循环周期，用于清除内部计数，稍后将在本节中描述。如果Interval为0，断路器在闭合状态下不清除内部计数。

• Timeout表示断路器处于半开状态的时间。“Timeout”为“0”时，“CircuitBreaker”的超时值设置为60秒。

• ReadyToTripCounts每当请求在关闭状态下失败时，都会使用 的副本调用。如果ReadyToTrip返回true，CircuitBreaker将被置于打开状态。如果ReadyToTrip是nil，则使用默认值ReadyToTrip。ReadyToTrip当连续失败次数超过 5 次时，默认返回 true。

• OnStateChange每当状态CircuitBreaker改变时调用。

• IsSuccessful使用从请求返回的错误调用。如果IsSuccessful返回 true，则错误被视为成功。否则该错误被视为失败。如果IsSuccessful为 nil，IsSuccessful则使用默认值，对所有非 nil 错误返回 false。

该结构Counts包含请求的数量及其成功/失败：

type Counts struct {
    Requests             uint32
    TotalSuccesses       uint32
    TotalFailures        uint32
    ConsecutiveSuccesses uint32
    ConsecutiveFailures  uint32
}

CircuitBreakerCounts在状态变化或关闭状态间隔时 清除内部。Counts忽略清除前发送的请求的结果。
CircuitBreaker可以包装任何函数来发送请求：

func (cb *CircuitBreaker) Execute(req func() (interface{}, error)) (interface{}, error)

如果CircuitBreaker接受了给定的请求，则Execute方法运行该请求。如果CircuitBreaker拒绝请求，Execute立即返回一个错误。否则，Execute将返回请求的结果。如果请求中出现恐慌，CircuitBreaker会将其作为错误处理，并再次引发相同的恐慌。

更多使用方面的信息可以参考官方提供的相关说明文档和案例

本文声明：

88x31.png
知识共享许可协议
本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。