The Go Commons Pool is a generic object pool for Golang, direct rewrite from Apache Commons Pool.

1. Support custom PooledObjectFactory.
2. Rich pool configuration option, can precise control pooled object lifecycle. see ObjectPoolConfig.
   • Pool LIFO (last in, first out) or FIFO (first in, first out)
   • Pool cap config
   • Pool object validate config
   • Pool object borrow block and max waiting time config
   • Pool object eviction config
   • Pool object abandon config

Configuration option table, more detail description see ObjectPoolConfig

//use create func
pool := NewObjectPoolWithDefaultConfig(NewPooledObjectFactorySimple(
		func() (interface{}, error) {
			return &MyPoolObject{}, nil
		}))
obj, _ := pool.BorrowObject()
pool.ReturnObject(obj)
	
//use custom Object factory

type MyObjectFactory struct {
}

func (f *MyObjectFactory) MakeObject() (*PooledObject, error) {
	return NewPooledObject(&MyPoolObject{}), nil
}

func (f *MyObjectFactory) DestroyObject(object *PooledObject) error {
	//do destroy
	return nil
}

func (f *MyObjectFactory) ValidateObject(object *PooledObject) bool {
	//do validate
	return true
}

func (f *MyObjectFactory) ActivateObject(object *PooledObject) error {
	//do activate
	return nil
}

func (f *MyObjectFactory) PassivateObject(object *PooledObject) error {
	//do passivate
	return nil
}

pool := NewObjectPoolWithDefaultConfig(new(MyObjectFactory))
pool.Config.MaxTotal = 100
obj, _ := pool.BorrowObject()
pool.ReturnObject(obj)

more example please see pool_test.go and example_test.go

PooledObjectFactory.MakeObject must return a pointer, not value. The following code will complain error.

pool := NewObjectPoolWithDefaultConfig(NewPooledObjectFactorySimple(
	func() (interface{}, error) {
		return "hello", nil
	}))
obj, _ := pool.BorrowObject()
pool.ReturnObject(obj)

The right way is:

pool := NewObjectPoolWithDefaultConfig(NewPooledObjectFactorySimple(
	func() (interface{}, error) {
		var stringPointer = new(string)
		*stringPointer = "hello"
		return stringPointer, nil
	}))

more example please see example_test.go

• testify for test

The results of running the pool_perf_test is almost equal to the java version PerformanceTest

go test --perf=true

• Direct use pool.Config.xxx to change pool config
• Default config value is same as java version
• If TimeBetweenEvictionRunsMillis changed after ObjectPool created, should call ObjectPool.StartEvictor to take effect. Java version do this on set method.
• No KeyedObjectPool
• No ProxiedObjectPool
• No pool stats (TODO)

FAQ

• Choose one open issue you want to solve, if not create one and describe what you want to change.
• Fork the repository on GitHub.
• Write code to solve the issue.
• Create PR and link to the issue.
• Make sure test and coverage pass.
• Wait maintainers to merge.

• Go Commons Pool发布以及Golang多线程编程问题总结
• Go Commons Pool 1.0 发布

Go Commons Pool is available under the Apache License, Version 2.0.