Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 2개 있습니다.)

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
    }
}

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/31/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 



2021-12-31 12시30분
[dimohy] 'DefaultObjectPoolProvider(인스턴스).Create<T>(policy)' 를 이용하면 T가 'IDisposable'를 구현했을 경우 'DisposableObjectPool<T>'를 사용합니다.

https://source.dot.net/#Microsoft.Extensions.ObjectPool/DefaultObjectPoolProvider.cs
https://source.dot.net/#Microsoft.Extensions.ObjectPool/DisposableObjectPool.cs
[손님]
2021-12-31 01시16분
@dimohy 덕분에 알게 되었습니다. ^^ Microsoft.Extensions.ObjectPool 네임스페이스의 클래스를 자세히 살펴봤어야 했군요. ^^;

그나저나, 그 와중에 제가 작명한 DisposableObjectPool과 이름이 같은데 ^^ 재미있게도 DisposableObjectPool은 internal이고, DefaultObjectPool은 public이라 약간 혼란스러운 듯합니다. 게다가 Create에서 풀링 개체의 상한을 지정할 수 없어서 Provider와 Create 호출을 나눠야 하는 것도 그렇고... 좀 요상하게 만들어진 것 같습니다. ^^;

static void Main(string[] args)
{
    IPooledObjectPolicy<Socket> policy = new PooledObjectPolicy("localhost", 39_999);

    var provider = new DefaultObjectPoolProvider();
    provider.MaximumRetained = 1;

    ObjectPool<Socket> pool = provider.Create(policy);
    {
        Socket socket1 = pool.Get();
        Socket socket2 = pool.Get();

        Console.WriteLine(socket1.Connected); // True
        Console.WriteLine(socket2.Connected); // True

        pool.Return(socket1);
        pool.Return(socket2);

        Console.WriteLine(socket1.Connected); // True
        Console.WriteLine(socket2.Connected); // False

        (pool as IDisposable).Dispose();

        Console.WriteLine(socket1.Connected); // False
        Console.WriteLine(socket2.Connected); // False
    }
}
정성태
2021-12-31 02시08분
[dimohy] 네. 요상한것에 저도 동의합니다;
[손님]

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13234정성태1/28/202340개발 환경 구성: 661. dnSpy를 이용해 소스 코드가 없는 .NET 어셈블리의 코드를 변경하는 방법
13233정성태1/28/202339오류 유형: 840. C# - WebClient로 https 호출 시 "The request was aborted: Could not create SSL/TLS secure channel" 예외 발생
13232정성태1/27/202348스크립트: 43. uwsgi의 --processes와 --threads 옵션
13231정성태1/27/202336오류 유형: 839. python - TypeError: '...' object is not callable
13230정성태1/26/202396개발 환경 구성: 660. WSL 2 내부로부터 호스트 측의 네트워크로 UDP 데이터가 1개의 패킷으로만 제한되는 문제
13229정성태1/25/2023154.NET Framework: 2090. C# - UDP Datagram의 최대 크기
13228정성태1/24/2023139.NET Framework: 2089. C# - WMI 논리 디스크가 속한 물리 디스크의 정보를 얻는 방법 [2]파일 다운로드1
13227정성태1/23/2023113개발 환경 구성: 659. Windows - IP MTU 값을 바꿀 수 있을까요?
13226정성태1/23/2023107.NET Framework: 2088. .NET 5부터 지원하는 GetRawSocketOption 사용 시 주의할 점
13225정성태1/21/2023135개발 환경 구성: 658. Windows에서 실행 중인 소켓 서버를 다른 PC 또는 WSL에서 접속할 수 없는 경우
13224정성태1/21/2023153Windows: 221. Windows - Private/Public/Domain이 아닌 네트워크 어댑터 단위로 방화벽을 on/off하는 방법
13223정성태1/20/2023111오류 유형: 838. RDP 연결 오류 - The two computers couldn't connect in the amount of time allotted
13222정성태1/20/2023108개발 환경 구성: 657. WSL - DockerDesktop.vhdx 파일 위치를 옮기는 방법
13221정성태1/19/2023150Linux: 57. C# - 리눅스 프로세스 메모리 정보파일 다운로드1
13220정성태1/19/2023104오류 유형: 837. NETSDK1045 The current .NET SDK does not support targeting .NET ...
13219정성태1/18/2023189Windows: 220. 네트워크의 인터넷 접속 가능 여부에 대한 판단 기준
13218정성태1/17/2023174VS.NET IDE: 178. Visual Studio 17.5 (Preview 2) - 포트 터널링을 이용한 웹 응용 프로그램의 외부 접근 허용
13217정성태1/13/2023191디버깅 기술: 185. windbg - 64비트 운영체제에서 작업 관리자로 뜬 32비트 프로세스의 덤프를 sos로 디버깅하는 방법
13216정성태1/12/2023154디버깅 기술: 184. windbg - 32비트 프로세스의 메모리 덤프인 경우 !peb 명령어로 나타나지 않는 환경 변수
13215정성태1/11/2023147Linux: 56. 리눅스 - /proc/pid/stat 정보를 이용해 프로세스의 CPU 사용량 구하는 방법
13214정성태1/10/2023262.NET Framework: 2087. .NET 6부터 SourceGenerator와 통합된 System.Text.Json [1]파일 다운로드1
13213정성태1/9/2023201오류 유형: 836. docker 이미지 빌드 시 "RUN apt install ..." 명령어가 실패하는 이유
13212정성태1/8/2023217기타: 85. 단정도/배정도 부동 소수점의 정밀도(Precision)에 따른 형변환 손실
13211정성태1/6/2023178웹: 42. (https가 아닌) http 다운로드를 막는 웹 브라우저
13210정성태1/5/2023280Windows: 219. 윈도우 x64의 경우 0x00000000`7ffe0000 아래의 주소는 왜 사용하지 않을까요?
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...