gpool

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

使用场景

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

使用方式

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

接口文档

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

需要注意两点:

  1. New方法的过期时间类型为time.Duration
  2. 对象创建方法(newFunc NewFunc)返回值包含一个error返回,当对象创建失败时可由该返回值反馈原因;
  3. 对象销毁方法(expireFunc...ExpireFunc)为可选参数,用以当对象超时/池关闭时,自动调用自定义的方法销毁对象;

gpool与sync.Pool

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

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

使用示例1,基本使用

  1. package main
  2. import (
  3. "github.com/gogf/gf/container/gpool"
  4. "fmt"
  5. "time"
  6. )
  7. func main () {
  8. // 创建一个对象池,过期时间为1秒
  9. p := gpool.New(time.Second, nil)
  10. // 从池中取一个对象,返回nil及错误信息
  11. fmt.Println(p.Get())
  12. // 丢一个对象到池中
  13. p.Put(1)
  14. // 重新从池中取一个对象,返回1
  15. fmt.Println(p.Get())
  16. // 等待2秒后重试,发现对象已过期,返回nil及错误信息
  17. time.Sleep(2*time.Second)
  18. fmt.Println(p.Get())
  19. }

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

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

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/gogf/gf/container/gpool"
  5. "github.com/gogf/gf/net/gtcp"
  6. "github.com/gogf/gf/os/glog"
  7. "time"
  8. )
  9. func main() {
  10. // 创建对象复用池,对象过期时间为3秒,并给定创建及销毁方法
  11. p := gpool.New(3*time.Second, func() (interface{}, error) {
  12. return gtcp.NewConn("www.baidu.com:80")
  13. }, func(i interface{}) {
  14. glog.Println("expired")
  15. i.(*gtcp.Conn).Close()
  16. })
  17. conn, err := p.Get()
  18. if err != nil {
  19. panic(err)
  20. }
  21. result, err := conn.(*gtcp.Conn).SendRecv([]byte("HEAD / HTTP/1.1\n\n"), -1)
  22. if err != nil {
  23. panic(err)
  24. }
  25. fmt.Println(string(result))
  26. // 丢回池中以便重复使用
  27. p.Put(conn)
  28. // 等待一定时间观察过期方法调用
  29. time.Sleep(4*time.Second)
  30. }

执行后,终端输出结果:

  1. HTTP/1.1 302 Found
  2. Connection: Keep-Alive
  3. Content-Length: 17931
  4. Content-Type: text/html
  5. Date: Wed, 29 May 2019 11:23:20 GMT
  6. Etag: "54d9749e-460b"
  7. Server: bfe/1.0.8.18
  8. 2019-05-29 19:23:24.732 expired