本文主要从源码角度介绍golang 熔断器的一种实现。
熔断器像是一个保险丝。当我们依赖的服务出现问题时,可以及时容错。一方面可以减少依赖服务对自身访问的依赖,防止出现雪崩效应;另一方面降低请求频率以方便上游尽快恢复服务。
熔断器的应用也非常广泛。除了在我们应用中,为了请求服务时使用熔断器外,在 web 网关、微服务中,也有非常广泛的应用。本文将从源码角度学习sony 开源的一个熔断器实现 github/sony/gobreaker 。(代码注释可以从 github/lpflpf/gobreaker 查看)
gobreaker是基于《微软云设计模式》一书中的熔断器模式的Golang实现。
下面是模式定义的一个状态机:
熔断器有三种状态,四种状态转移的情况:
gobreaker 是在上述状态机的基础上,实现的一个熔断器。
type CircuitBreaker struct { name string maxRequests uint32 // 最大请求数 (半开启状态会限流) interval time.Duration // 统计周期 timeout time.Duration // 进入熔断后的超时时间 readyToTrip func(counts Counts) bool // 通过Counts 判断是否开启熔断。需要自定义 onStateChange func(name string, from State, to State) // 状态修改时的钩子函数 mutex sync.Mutex // 互斥锁,下面数据的更新都需要加锁 state State // 记录了当前的状态 generation uint64 // 标记属于哪个周期 counts Counts // 计数器,统计了 成功、失败、连续成功、连续失败等,用于决策是否进入熔断 expiry time.Time // 进入下个周期的时间}
其中,如下参数是我们可以自定义的:
熔断器的执行操作,主要包括三个阶段;①请求之前的判定;②服务的请求执行;③请求后的状态和计数的更新
// 熔断器的调用func (cb *CircuitBreaker) Execute(req func() (interface{}, error)) (interface{}, error) { // ①请求之前的判断 generation, err := cb.beforeRequest() if err != nil { return nil, err } defer func() { e := recover() if e != nil { // ③ panic 的捕获 cb.afterRequest(generation, false) panic(e) } }() // ② 请求和执行 result, err := req() // ③ 更新计数 cb.afterRequest(generation, err == nil) return result, err}
请求之前,会判断当前熔断器的状态。如果熔断器以开启,则不会继续请求。如果熔断器半开,并且已达到最大请求阈值,也不会继续请求。
func (cb *CircuitBreaker) beforeRequest() (uint64, error) { cb.mutex.Lock() defer cb.mutex.Unlock() now := time.Now() state, generation := cb.currentState(now) if state == StateOpen { // 熔断器开启,直接返回 return generation, ErrOpenState } else if state == StateHalfOpen && cb.counts.Requests >= cb.maxRequests { // 如果是半打开的状态,并且请求次数过多了,则直接返回 return generation, ErrTooManyRequests } cb.counts.onRequest() return generation, nil}
其中当前状态的计算,是依据当前状态来的。如果当前状态为已开启,则判断是否已经超时,超时就可以 变更状态到半开 ;如果当前状态为关闭状态,则通过周期判断是否进入下一个周期。
func (cb *CircuitBreaker) currentState(now time.Time) (State, uint64) { switch cb.state { case StateClosed: if !cb.expiry.IsZero() && cb.expiry.Before(now) { // 是否需要进入下一个计数周期 cb.toNewGeneration(now) } case StateOpen: if cb.expiry.Before(now) { // 熔断器由开启变更为半开 cb.setState(StateHalfOpen, now) } } return cb.state, cb.generation}
周期长度的设定,也是以据当前状态来的。如果当前正常(熔断器关闭),则设置为一个interval 的周期;如果当前熔断器是开启状态,则设置为超时时间(超时后,才能变更为半开状态)。
每次请求之后,会通过请求结果是否成功,对熔断器做计数。
func (cb *CircuitBreaker) afterRequest(before uint64, success bool) { cb.mutex.Lock() defer cb.mutex.Unlock() now := time.Now() // 如果不在一个周期,就不再计数 state, generation := cb.currentState(now) if generation != before { return } if success { cb.onSuccess(state, now) } else { cb.onFailure(state, now) }}
如果在半开的状态下:
如果在关闭状态下: