C# - DefaultObjectPool<T>의 IDisposable 개체에 대한 풀링 문제
(2021-12-31 업데이트) 덧글에 달린 dimohy 님의 의견을 꼭 읽어 주세요. 이 글에서 설명한 모든 문제가 마이크로소프트가 만들어둔 Microsoft.Extensions.ObjectPool.DisposableObjectPool<T>로 해결이 됩니다. 단지, 해당 클래스의 접근자가 internal이기 때문에 docs 공식 문서에서는 찾아볼 수 없습니다.
지난 글에,
C# - .NET Platform Extension의 ObjectPool<T> 사용법 소개
; https://www.sysnet.pe.kr/2/0/12893
ObjectPool을 간단하게 살펴봤는데요, 제가 아직 이 타입에 대한 이해가 부족한지는 모르겠지만
DefaultObjectPool의 경우 IDisposable 개체를 풀링 시에는 약간의 문제가 있습니다. 말로 설명하면 복잡하니, 곧바로 예제 코드로 작성해 보면,
IPooledObjectPolicy<Socket> policy = new PooledObjectPolicy("localhost", 39_999);
DefaultObjectPool<Socket> pool = new DefaultObjectPool<Socket>(policy, 10);
Socket socket1 = pool.Get(); // PooledObjectPolicy.Create로 생성된 Socket 하나를 가져와서 사용.
Socket socket2 = pool.Get(); // PooledObjectPolicy.Create로 생성된 Socket 하나를 가져와서 사용.
// ...
pool.Return(socket1); // 풀에 반환
pool.Return(socket2); // 풀에 반환
현재, 위의 경우 10개까지 보관할 수 있는 ObjectPool 내에 2개의 Socket 연결 개체가 있을 것입니다. 여기서 문제는, 이제 해당 풀이 필요 없을 시점이 되면, 그 Socket 자원을 Dispose할 수 있는 마땅한 방법이 없다는 점입니다.
물론 명확하게 2개의 개체가 풀에 있다는 것을 알고 있다면 그냥 다음과 같이 정리할 수 있을 것입니다.
for (int i = 0; i < 2; i ++)
{
Socket socket = pool.Get();
socket.Dispose();
}
하지만, 저런 가정은 현실에서 전혀 도움이 되지 않습니다. 더욱 심각한 것은, Pool에 반환되지 않은 개체는 Memory Leak 문제가 발생한다는 점입니다. 가령, 다음과 같이 2개의 max를 가진 풀링 상황에서 풀의 용량 이상에 해당하는 개체를 반환하는 경우,
IPooledObjectPolicy<Socket> policy = new PooledObjectPolicy("localhost", 39_999);
DefaultObjectPool<Socket> pool = new DefaultObjectPool<Socket>(policy, 2);
Socket socket1 = pool.Get(); // PooledObjectPolicy.Create로 생성된 Socket 하나를 가져와서 사용.
Socket socket2 = pool.Get(); // PooledObjectPolicy.Create로 생성된 Socket 하나를 가져와서 사용.
Socket socket3 = pool.Get(); // PooledObjectPolicy.Create로 생성된 Socket 하나를 가져와서 사용.
// ...
pool.Return(socket1); // 풀에 반환
pool.Return(socket2); // 풀에 반환
pool.Return(socket3); // 풀에 반환되지 않음.
// 하지만 사용자 측에서 Dispose 호출 여부를 결정할 수도 없음.
당연히 3번째 개체는 풀에 반환되지 않는데, 그렇다면 그것을 사용자 측에서 소켓 연결을 끊는 작업을 해야 하지만 그것을 처리할 수 있는 방법이 마땅하게 없습니다. 왜냐하면 DefaultObjectPool이 외부에 공개하는 것은 Get, Return 2개뿐이고 부모 클래스에 접근 가능한 protected/public 멤버가 하나도 없기 때문입니다.
또한, Get/Return 메서드를 override해도 딱히 더 사용자 정의할 것이 없습니다.
public class MyPool<T>: DefaultObjectPool<T> where T: class
{
public MyPool(IPooledObjectPolicy<T> policy) : base(policy) { }
public override T Get()
{
return base.Get(); // 해당 개체가 풀링으로부터 온 것인지, 새롭게 생성된 것인지 알 수 없고,
}
public override void Return(T obj)
{
base.Return(obj); // 해당 개체가 풀로 반환이 된 것인지, 무시된 것인지 알 수 없고!
}
}
이로 인해, 풀링이 되지 않을 개체를 해제하기 위한 어떠한 조건도 얻어낼 수 없는 것입니다.
현실적인 기준으로 봤을 때, 사실 개체 풀링은 대부분의 상황에서 Dispose를 요구하는 개체입니다. DB 연결 개체를 포함한 소켓 연결이 그 좋은 사례인데요, 막상 사용하려니 저렇게 자원 해제 문제가 걸리는 것입니다.
이 문제를 해결하기 위한 좋은 방법이 있을까요?
일단, 저는 잘 모르겠고 어쩔 수 없이 다음과 같은 식으로 직접 ObjectPool을 상속해 구현하는 식으로 해결했습니다. (물론, 굳이 ObjectPool을 상속할 필요는 없습니다.)
public class DisposableObjectPool<T> : ObjectPool<T>, IDisposable where T : class, IDisposable
{
int _maxItems = 0;
Queue<T> _queue;
Func<T> _createDelegate;
object _objLock = new object();
public DisposableObjectPool(int maxItems, Func<T> createDelegate)
{
_maxItems = maxItems;
_createDelegate = createDelegate;
_queue = new Queue<T>(_maxItems);
}
public void Dispose()
{
lock (_queue)
{
while (_queue.Count > 0)
{
T result = _queue.Dequeue();
result.Dispose();
}
}
}
public override T Get()
{
lock (_objLock)
{
if (_queue.Count != 0)
{
return _queue.Dequeue();
}
}
return _createDelegate();
}
public override void Return(T item)
{
lock (_queue)
{
if (_queue.Count < _maxItems)
{
_queue.Enqueue(item);
return;
}
}
item.Dispose();
}
}
그래서 대충 이런 식으로 사용하면 됩니다.
static void Main(string[] args)
{
using (DisposableObjectPool<Socket> pool = new DisposableObjectPool<Socket>(1,
() =>
{
Socket socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
socket.Connect("127.0.01", 39999);
return socket;
}))
{
Socket socket1 = pool.Get();
Socket socket2 = pool.Get();
Console.WriteLine(socket1.Connected); // True
Console.WriteLine(socket2.Connected); // True
pool.Return(socket1); // max == 1이므로, 풀에 반환
pool.Return(socket2); // 풀의 용량을 넘었으므로 풀에 반환하지 못하고 Dispose 호출로 자원 해제
Console.WriteLine(socket1.Connected); // True
Console.WriteLine(socket2.Connected); // False
}
}
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]