Searching...

[TOC]

gpool

对象复用池(并发安全)。将对象进行缓存复用,支持过期时间创建方法销毁方法定义。

使用场景

任何需要支持定时过期的对象复用场景。

使用方式

import "github.com/gogf/gf/g/container/gpool"

接口文档

https://godoc.org/github.com/gogf/gf/g/container/gpool

需要注意两点: 1. New方法的过期时间单位为毫秒; 1. 对象创建方法(newFunc NewFunc)返回值包含一个error返回,当对象创建失败时可由该返回值反馈原因; 1. 对象销毁方法(expireFunc...ExpireFunc)为可选参数,用以当对象超时/池关闭时,自动调用自定义的方法销毁对象;

gpool与sync.Pool

gpoolsync.Pool都可以达到对象复用的作用,但是两者的设计初衷和使用场景不太一样。

sync.Pool的对象生命周期不支持自定义过期时间,究其原因,sync.Pool并不是一个Cache;sync.Pool设计初衷是为了缓解GC压力,sync.Pool中的对象会在GC开始前全部清除;并且sync.Pool不支持对象创建方法及销毁方法。

使用示例1,基本使用

package main

import (
    "github.com/gogf/gf/g/container/gpool"
    "fmt"
    "time"
)

func main () {
    // 创建一个对象池,过期时间为1000毫秒
    p := gpool.New(1000, nil)

    // 从池中取一个对象,返回nil及错误信息
    fmt.Println(p.Get())

    // 丢一个对象到池中
    p.Put(1)

    // 重新从池中取一个对象,返回1
    fmt.Println(p.Get())

    // 等待2秒后重试,发现对象已过期,返回nil及错误信息
    time.Sleep(2*time.Second)
    fmt.Println(p.Get())
}

使用示例2,创建及销毁方法

我们可以给定动态创建及销毁方法。

package main

import (
	"fmt"
	"github.com/gogf/gf/g/container/gpool"
	"github.com/gogf/gf/g/net/gtcp"
	"github.com/gogf/gf/g/os/glog"
	"time"
)

func main() {
	// 创建对象复用池,对象过期时间为3000毫秒,并给定创建及销毁方法
	p := gpool.New(3000, func() (interface{}, error) {
		return gtcp.NewConn("www.baidu.com:80")
	}, func(i interface{}) {
		glog.Println("expired")
		i.(*gtcp.Conn).Close()
	})
	conn, err := p.Get()
	if err != nil {
		panic(err)
	}
	result, err := conn.(*gtcp.Conn).SendRecv([]byte("HEAD / HTTP/1.1\n\n"), -1)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(result))
	// 丢回池中以便重复使用
	p.Put(conn)
	// 等待一定时间观察过期方法调用
	time.Sleep(4*time.Second)
}

执行后,终端输出结果:

HTTP/1.1 302 Found
Connection: Keep-Alive
Content-Length: 17931
Content-Type: text/html
Date: Wed, 29 May 2019 11:23:20 GMT
Etag: "54d9749e-460b"
Server: bfe/1.0.8.18


2019-05-29 19:23:24.732 expired