golang中g(shù)oroutine由運(yùn)行時(shí)管理，使用go關(guān)鍵字就可以方便快捷的創(chuàng)建一個(gè)goroutine,受限于服務(wù)器硬件內(nèi)存大小，如果不對(duì)goroutine數(shù)量進(jìn)行限制，會(huì)出現(xiàn)Out of Memory錯(cuò)誤。但是goroutine泄漏引發(fā)的血案，想必各位gopher都經(jīng)歷過，通過協(xié)程池限制goroutine數(shù)一個(gè)有效避免泄漏的手段,但是自己手動(dòng)實(shí)現(xiàn)一個(gè)協(xié)程池，總是會(huì)兼顧不到各種場景，比如釋放，處理panic,動(dòng)態(tài)擴(kuò)容等。那么ants是公認(rèn)的優(yōu)秀實(shí)現(xiàn)協(xié)程池。

ants簡介

ants是一個(gè)高性能的 goroutine 池，實(shí)現(xiàn)了對(duì)大規(guī)模 goroutine 的調(diào)度管理、goroutine 復(fù)用，允許使用者在開發(fā)并發(fā)程序的時(shí)候限制 goroutine 數(shù)量，復(fù)用資源，達(dá)到更高效執(zhí)行任務(wù)的效果

功能

• 自動(dòng)調(diào)度海量的 goroutines，復(fù)用 goroutines
• 定期清理過期的 goroutines，進(jìn)一步節(jié)省資源
• 提供了大量有用的接口：任務(wù)提交、獲取運(yùn)行中的 goroutine 數(shù)量、動(dòng)態(tài)調(diào)整 Pool 大小、釋放 Pool、重啟 Pool
• 優(yōu)雅處理 panic，防止程序崩潰
• 資源復(fù)用，極大節(jié)省內(nèi)存使用量；在大規(guī)模批量并發(fā)任務(wù)場景下比原生 goroutine 并發(fā)具有更高的性能
• 非阻塞機(jī)制

1.ants庫結(jié)構(gòu)

學(xué)習(xí)一個(gè)庫先從結(jié)構(gòu)看起吧，pool、pool_func、ants初始化一個(gè)pool等操作都在這里

ants庫代碼結(jié)構(gòu)

• pool.go提供了ants.NewPool(創(chuàng)建協(xié)程池)、Submit(task func())提交任務(wù)
• pool_func.go使用NewPoolWithFunc(創(chuàng)建pool對(duì)象需要帶具體的函數(shù))，并且使用Invoke(args interface{})進(jìn)行調(diào)用,arg就是傳給池函數(shù)func(interface{})的參數(shù)
• options.go使用函數(shù)選項(xiàng)模式進(jìn)行參數(shù)配置
• ants.go給初始化默認(rèn)協(xié)程池對(duì)象defaultAntsPool(默認(rèn)的pool容量是math.MaxInt32)提供了公共函數(shù)

介紹完了主要的庫文件后，我們進(jìn)行逐個(gè)的了解，具體的使用，我們可以結(jié)合官方的使用案例進(jìn)行了解，這里就不進(jìn)行展開了。

2.ants中Pool創(chuàng)建對(duì)象

創(chuàng)建Pool對(duì)象需調(diào)用ants.NewPool(size, options)函數(shù)，返回一個(gè)pool的指針

先看Pool的接口，對(duì)我們創(chuàng)建的Pool先做個(gè)初步印象

Pool結(jié)構(gòu)體

// NewPool generates an instance of ants pool.
func NewPool(size int, options ...Option) (*Pool, error) {
    opts := loadOptions(options...)

    if size <= 0 {
        size = -1
    }

    if expiry := opts.ExpiryDuration; expiry < 0 {
        return nil, ErrInvalidPoolExpiry
    } else if expiry == 0 {
        opts.ExpiryDuration = DefaultCleanIntervalTime
    }

    if opts.Logger == nil {
        opts.Logger = defaultLogger
    }

    p := &Pool{
        capacity: int32(size),
        lock:     internal.NewSpinLock(),
        options:  opts,
    }
    p.workerCache.New = func() interface{} {
        return &goWorker{
            pool: p,
            task: make(chan func(), workerChanCap),
        }
    }
    if p.options.PreAlloc {
        if size == -1 {
            return nil, ErrInvalidPreAllocSize
        }
        p.workers = newWorkerArray(loopQueueType, size)
    } else {
        p.workers = newWorkerArray(stackType, 0)
    }

    p.cond = sync.NewCond(p.lock)

    // Start a goroutine to clean up expired workers periodically.
    go p.purgePeriodically()

    return p, nil
}

ants.NewPool創(chuàng)建Pool過程

• 接收size參數(shù)作為pool的容量，如果size<=0，那么不對(duì)池子容量進(jìn)行限制
• loadOptions對(duì)Pool的配置，比如是否阻塞模式，
• workerCache這個(gè)sync.Pool對(duì)象的New方法，在調(diào)用sync.Pool的Get()方法時(shí)，如果為nil，則返回workerCache.New()的結(jié)果
• 是否初始化Pool是進(jìn)行內(nèi)存預(yù)分配(size > 0)，來創(chuàng)建不同的worker(stack、loopQueue兩種模式)
• 使用p.lock鎖創(chuàng)建一個(gè)條件變量
• 開啟一個(gè)協(xié)程定期清理過期的workers

3.ants中的PoolWithFunc

ants.PoolWithFunc創(chuàng)建PoolWithFunc和New.Pool整體的結(jié)構(gòu)很像，多了個(gè)poolFunc func(interface{})字段,也就是提交到池子的函數(shù)，然后workers的類型不一樣

4.理解worker

可以查看出pool中的worker在整個(gè)流程起著很重要的作用，也就是ants中為每個(gè)任務(wù)都是由 worker 對(duì)象來處理的，每個(gè)work都會(huì)創(chuàng)建一個(gè)goroutine來處理任務(wù)，ants中的worker結(jié)構(gòu)如下

type goWorker struct {
    //work的所屬者
    pool *Pool

    //任務(wù)通道，通過這個(gè)發(fā)送給goWorker
    task chan func()

    //將work放入到隊(duì)列時(shí)更新
    recycleTime time.Time
}

從ants.Pool創(chuàng)建對(duì)象Pool的過程第四步可以看出，通過newWorkerArray創(chuàng)建workers，因?yàn)閣orkerArray是個(gè)接口，有如下方法。

type workerArray interface {
    len() int
    isEmpty() bool
    insert(worker *goWorker) error
    detach() *goWorker
    retrieveExpiry(duration time.Duration) []*goWorker
    reset()
}

通過newWorkerArray，返回實(shí)現(xiàn)了workerArray接口的workerStack，這里newWorkerArray其實(shí)是用了個(gè)工廠方法來實(shí)現(xiàn)的，根據(jù)傳入的類型，并不需要知道具體實(shí)現(xiàn)了接口的結(jié)構(gòu)體，只要實(shí)現(xiàn)了workerArray接口就可以返回實(shí)現(xiàn)者的結(jié)構(gòu)體，然后調(diào)用具體的實(shí)現(xiàn)

5.提交任務(wù)Submit

Submit(task func())接收一個(gè)func作為參數(shù)，將task通過通道task將類型為func的函數(shù)給到goWorker，然后調(diào)用retrieveWorker返回一個(gè)可用的worker給task

func (p *Pool) retrieveWorker() (w *goWorker) {
    spawnWorker := func() {
        w = p.workerCache.Get().(*goWorker)
        w.run()
    }

    p.lock.Lock()

    w = p.workers.detach()
    if w != nil { // first try to fetch the worker from the queue
        p.lock.Unlock()
    } else if capacity := p.Cap(); capacity == -1 || capacity > p.Running() {
        // if the worker queue is empty and we don't run out of the pool capacity,
        // then just spawn a new worker goroutine.
        p.lock.Unlock()
        spawnWorker()
    } else { // otherwise, we'll have to keep them blocked and wait for at least one worker to be put back into pool.
        if p.options.Nonblocking {
            p.lock.Unlock()
            return
        }
    retry:
        if p.options.MaxBlockingTasks != 0 && p.blockingNum >= p.options.MaxBlockingTasks {
            p.lock.Unlock()
            return
        }
        p.blockingNum++
        p.cond.Wait() // block and wait for an available worker
        p.blockingNum--
        var nw int
        if nw = p.Running(); nw == 0 { // awakened by the scavenger
            p.lock.Unlock()
            if !p.IsClosed() {
                spawnWorker()
            }
            return
        }
        if w = p.workers.detach(); w == nil {
            if nw < capacity {
                p.lock.Unlock()
                spawnWorker()
                return
            }
            goto retry
        }

        p.lock.Unlock()
    }
    return
}

執(zhí)行過程分析：

• spawnWorker是一個(gè)func,從p.workerCache這個(gè)sync.Pool獲取一個(gè)goWorker對(duì)象（在New.Pool中有講到），用sync.Locker上鎖
• 調(diào)用p.workers.detach方法（前面提到p.workers實(shí)現(xiàn)了workerArray接口）
• 如果獲取到了goWorker對(duì)象就直接返回
• 如果worker隊(duì)列為空，并且Pool還有容量，那么調(diào)用spawnWorker，調(diào)用worker的run方法啟動(dòng)一個(gè)新的協(xié)程處理任務(wù)
• run方法的實(shí)現(xiàn)如下，從goWorker的channel中遍歷待執(zhí)行的func(),執(zhí)行，并且在執(zhí)行完后調(diào)用revertWorker放回workers

func (w *goWorker) run() {
    w.pool.incRunning()
    go func() {

        for f := range w.task {
            if f == nil {
                return
            }
            f()
            if ok := w.pool.revertWorker(w); !ok {
                return
            }
        }
    }()
}

6.釋放和重啟Pool

釋放和重啟Pool分別調(diào)用了Release和Reboot,這兩個(gè)函數(shù)都在ants.Pool這個(gè)文件中可以找到，具體實(shí)現(xiàn)這里做個(gè)簡單說明

• Release調(diào)用p.workers.reset()結(jié)束loopQueue或wokerStack中的 goroutine。都是通過發(fā)送nil到goWorker的task通道中，然后重置各個(gè)字段的值
• Reboot調(diào)用purgePeriodically，檢測到Pool關(guān)閉了就直接退出了

7.細(xì)節(jié)

task緩沖通道

下面這個(gè)是NewPool變量workerCachesyn類型sync.Pool創(chuàng)建goWorker對(duì)象的代碼

p.workerCache.New = func() interface{} {
        return &goWorker{
            pool: p,
            task: make(chan func(), workerChanCap),
        }
    }

workerChanCap作為容量，這個(gè)變量定義在ants.go文件中的定義如下：

// workerChanCap determines whether the channel of a worker should be a buffered channel
    // to get the best performance. Inspired by fasthttp at
    // https://github.com/valyala/fasthttp/blob/master/workerpool.go#L139
    workerChanCap = func() int {
        // Use blocking channel if GOMAXPROCS=1.
        // This switches context from sender to receiver immediately,
        // which results in higher performance (under go1.5 at least).
        if runtime.GOMAXPROCS(0) == 1 {
            return 0
        }

        // Use non-blocking workerChan if GOMAXPROCS>1,
        // since otherwise the sender might be dragged down if the receiver is CPU-bound.
        return 1
    }()

ants參考了著名的 Web框架fasthttp的實(shí)現(xiàn)。當(dāng)GOMAXPROCS為 1時(shí)（即操作系統(tǒng)線程數(shù)為1），向通道task發(fā)送會(huì)掛起發(fā)送 goroutine，將執(zhí)行流程轉(zhuǎn)向接收goroutine，這能提升接收處理性能。如果GOMAXPROCS大于1，ants使用帶緩沖的通道，為了防止接收 goroutine 是 CPU密集的，導(dǎo)致發(fā)送 goroutine 被阻塞。

自旋鎖 SpinLock

在NewPool中l(wèi)ock,其實(shí)給lock初始化了一個(gè)自旋鎖，這里是利用atomic.CompareAndSwapUint32()這個(gè)原子操作實(shí)現(xiàn)的，在加鎖失敗后不會(huì)等待，而是繼續(xù)嘗試，提高了加鎖減鎖的性能

在開發(fā)中剛好遇到需要ants，這次也做個(gè)記錄作為分享，其實(shí)慢慢的會(huì)發(fā)現(xiàn)三方庫的xx_test用例是最好的學(xué)習(xí)例子，希望能和大家一起知其然知其所以然，加油！

到此這篇關(guān)于golang中ants協(xié)程池使用和實(shí)現(xiàn)邏輯的文章就介紹到這了,更多相關(guān)golang ants協(xié)程池內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！