golang通用链接池的实现

golang的channel除了goroutine通讯以外还有不少其余的功能，本文将实现一种基于channel的通用链接池。

更新

• 添加超时处理，须要实现GetActiveTime方法获取最后活跃时间。

何为通用？

链接池的实现不依赖具体的实例，而依赖某个接口，本文的链接池选用的是io.Closer接口，只要是实现了该接口的对象均可以被池管理。
固然，你能够实现基于interface{}的链接池，这样任何对象均可以被管理。

实现原理

将链接句柄存入channel中，因为缓存channel的特性，获取链接时若是池中有链接，将直接返回，若是池中没有链接，将阻塞或者新建链接（没超过最大限制的状况下）。
因为面向接口编程，全部建立链接的逻辑是不清楚的，这里须要传入一个函数，该函数返回一个io.Closer对象。

实现

因为并发问题，在须要操做池中互斥数据的时候须要加锁。

package pool

import (
    "errors"
    "io"
    "sync"
    "time"
)

var (
    ErrInvalidConfig = errors.New("invalid pool config")
    ErrPoolClosed    = errors.New("pool closed")
)

type Poolable interface {
    io.Closer
    GetActiveTime() time.Time
}

type factory func() (Poolable, error)

type Pool interface {
    Acquire() (Poolable, error) // 获取资源
    Release(Poolable) error     // 释放资源
    Close(Poolable) error       // 关闭资源
    Shutdown() error            // 关闭池
}

type GenericPool struct {
    sync.Mutex
    pool        chan Poolable
    maxOpen     int  // 池中最大资源数
    numOpen     int  // 当前池中资源数
    minOpen     int  // 池中最少资源数
    closed      bool // 池是否已关闭
    maxLifetime time.Duration
    factory     factory // 建立链接的方法
}

func NewGenericPool(minOpen, maxOpen int, maxLifetime time.Duration, factory factory) (*GenericPool, error) {
    if maxOpen <= 0 || minOpen > maxOpen {
        return nil, ErrInvalidConfig
    }
    p := &GenericPool{
        maxOpen:     maxOpen,
        minOpen:     minOpen,
        maxLifetime: maxLifetime,
        factory:     factory,
        pool:        make(chan Poolable, maxOpen),
    }

    for i := 0; i < minOpen; i++ {
        closer, err := factory()
        if err != nil {
            continue
        }
        p.numOpen++
        p.pool <- closer
    }
    return p, nil
}

func (p *GenericPool) Acquire() (Poolable, error) {
    if p.closed {
        return nil, ErrPoolClosed
    }
    for {
        closer, err := p.getOrCreate()
        if err != nil {
            return nil, err
        }
        // 若是设置了超时且当前链接的活跃时间+超时时间早于如今，则当前链接已过时
        if p.maxLifetime > 0 && closer.GetActiveTime().Add(p.maxLifetime).Before(time.Now()) {
            p.Close(closer)
            continue
        }
        return closer, nil
    }
}

func (p *GenericPool) getOrCreate() (Poolable, error) {
    select {
    case closer := <-p.pool:
        return closer, nil
    default:
    }
    p.Lock()
    if p.numOpen >= p.maxOpen {
        closer := <-p.pool
        p.Unlock()
        return closer, nil
    }
    // 新建链接
    closer, err := p.factory()
    if err != nil {
        p.Unlock()
        return nil, err
    }
    p.numOpen++
    p.Unlock()
    return closer, nil
}

// 释放单个资源到链接池
func (p *GenericPool) Release(closer Poolable) error {
    if p.closed {
        return ErrPoolClosed
    }
    p.Lock()
    p.pool <- closer
    p.Unlock()
    return nil
}

// 关闭单个资源
func (p *GenericPool) Close(closer Poolable) error {
    p.Lock()
    closer.Close()
    p.numOpen--
    p.Unlock()
    return nil
}

// 关闭链接池，释放全部资源
func (p *GenericPool) Shutdown() error {
    if p.closed {
        return ErrPoolClosed
    }
    p.Lock()
    close(p.pool)
    for closer := range p.pool {
        closer.Close()
        p.numOpen--
    }
    p.closed = true
    p.Unlock()
    return nil
}

结论

基于该链接池，能够管理全部io.Closer对象。好比memcached,redis等等，很是方便！

项目地址

https://github.com/goctx/generic-pool