定义一个名 `TablePool` class,用于管理一个对象池。对象池是一种用于优化内存使用的技术,通过重用对象而不是频繁地创建和销毁对象,从而减少内存分配和垃圾回收的开销。
设计思路
- **初始化**:
-
`initialize` 方法初始化对象池,接受三个参数:`capacity`(池子的容量,即最多可以缓存多少个对象)、`newFunc`(创建新对象的函数)和 `rlsFunc`(释放对象的函数)。
-
根据提供的 `capacity`,预先创建一定数量的对象并存储在队列 `_ts` 中。
- **获取对象**:
- `getObj` 方法从对象池中获取一个对象。如果池子中有对象,则从队列的头部取出一个对象;如果池子为空且提供了 `newFunc`,则调用 `newFunc` 创建一个新的对象;否则返回一个空表。
- **释放对象**:
- `releaseObj` 方法将一个对象放回池子中。如果提供了 `rlsFunc`,则在放回之前调用 `rlsFunc` 释放对象。如果对象已经在队列的尾部,则记录错误信息,因为这意味着对象被重复释放。
- **销毁对象池**:
- `release` 方法用于销毁对象池,将所有成员变量置为 `nil`。
用途
对象池通常用于需要频繁创建和销毁对象的场景,例如游戏开发中的游戏对象、数据库连接池等。通过使用对象池,可以显著减少内存分配和垃圾回收的开销,提高程序的性能。
注意事项
-
**对象重用**:对象池中的对象在被取出后,应确保在释放之前不会被修改,以避免数据不一致的问题。
-
**错误处理**:在 `releaseObj` 方法中,如果尝试释放的对象已经在队列的尾部,会记录错误信息。这通常意味着对象被重复释放,需要检查代码逻辑。
-
**线程安全**:如果对象池在多线程环境中使用,需要确保线程安全,避免多个线程同时访问和修改对象池。
Lua
---@class TablePool
local TablePool = SimpleClassUtil:class()
---@param capacity number
---@param newFunc fun() : table
---@param rlsFunc fun(t : table) void
function TablePool:initialize(capacity, newFunc, rlsFunc)
local cap = capacity or 4
---@type Queue
self._ts = Queue:new()
self._newFunc = newFunc -- or _defaultNew
self._rlsFunc = rlsFunc
if newFunc then
for i = 1, cap do
self._ts:pushBack(newFunc())
end
else
for i = 1, cap do
self._ts:pushBack({})
end
end
end
---@return table @从池子里获取的table
function TablePool:getObj()
if self._ts then
local cnt = self._ts:size()
if cnt <= 0 then
if self._newFunc then
return self._newFunc()
else
return {}
end
else
return self._ts:popFront()
end
end
end
---@param item table @一定是Get返回的table
function TablePool:releaseObj(item)
if self._ts then
if self._rlsFunc then
self._rlsFunc(item)
end
if self._ts:peekBack() == item then
Logger.error("Try Release item to TablePool Failed! You try Release same item twice.", item)
else
self._ts:pushBack(item)
end
end
end
---@overload fun()
function TablePool:release(obsolete)
if obsolete then
Logger.error("TablePool:release has Changed Name to TablePool:releaseObj!")
self:releaseObj(obsolete)
return
end
self._newFunc = nil
self._rlsFunc = nil
self._ts = nil
end
return TablePool