C# : using문의 기능과 활용

알게 된 배경

 C++에서 개발을 하다가 C#을 접하게 되었을 때 익숙하면서도 생소한 문법이 using문이었다. C++에서도 namespace를 선언할 경우 'using namespace [이름];' 형태의 문법을 사용하고 C#에서도 마찬가지로 최상단에 'using System;' 형태로 기본적으로 작성이 되어 있기 때문이다.

 하지만, 입문을 제대로 하지 않은 상태에서 파일, 네트워크 등 IO(입출력)에 해당되는 MSDN 문서를 보면 코드의 메서드 안에서 사용되는 using문을 쉽게 볼 수 있다. 하지만, 기존에 using 사용되던 키워드(?)와 다른 기능이라서 처음에 쉽게 사용하기 어렵다.

 특히나 예외처리 문법의 finally 문의 기능과 유사했기 때문에 필자의 경우 예제를 보기 전까지는 제대로 활용을 하지 못 했었다.

using문의 의미

 키보드와 콘솔 화면 출력을 제외한 대부분의 IO(입출력)의 경우 실제로 stream이나 unmanagement 메모리 공간을 할당하고 해제 하는 패턴 혹은 Stream Open 과 Stream Close 하는 패턴으로 코드를 작성해야 한다.

 C++의 경우 소멸자가 유용하게 사용되는데, C# 역시 소멸자를 제공하지만, IDisposeable 인터패이스를 상속하여 Dispose라는 메서드를 override하여 Unmanagement 메모리 해제나 Stream Close를 구현하도록 권장을 하고 있다. 그리고 이렇게 구현된 Dispose 메서드는 using문의 Scope에서 벗어나면, 호출이 하도록 하여 자연스럽게 C++의 소멸자와 비슷한 기능을 수행한다.

using문 예시

using System;
using System.IO;

class FileRead
{
    var imgFilePath = @".\img.jpg";
    using(var imgFileStream = new FileStream(imgFilePath, FileMode.Open))
    {
        var tmpImg = Image.FromStream(imgFileStream);
        // ... 중략
    }
}

예외처리의 finally문과의 관계

 IO처리에 있어서 항상 염두해야 하는 문법은 예외 처리이다. 이는 파일 입출력의 경우 파일을 읽을 때 파일이 없는 경우, 통신중에 네트워크 연결이 끊어진 경우 등 비정상적인 동작을 대비해서 작성하는 문법이다.

 여기서 finally 문의 경우 예외가 발생하던 안하던 간에 반드시 실행되는 내용을 작성을 하도록 되어 있다. 가령 Stream Open 한뒤에 작업중에 예외가 발생해서 파일을 닫아야 하지만, 예외 발생 하지 않은 경우에도 닫아야 하는 경우에 사용된다.

try-catch-finally문 예시

using System;
using System.IO;

class FileRead
{
    var imgFilePath = @".\img.jpg";
    try
    {
        var imgFileStream = new FileStream(imgFilePath, FileMode.Open);
        var tmpImg = Image.FromStream(imgFileStream);
        // ... 중략
    }
    catch(Exception ex)
    {
        // ... 예외 처리
    }
    finally
    {
        imgFileStream.Close();
        // ... 혹은 imgFileStream.Dispose() 호출
    }
}

 여기서 생각을 가만히 해보면 finally문이 using문과 역할의 유사점을 느낄 수 있다. 오히려 finally문의 경우 Close 같은 메서드를 직접 호출하는 반면, using문은 IDisposeable을 상속 받은 객체의 경우 자동으로 Scope를 벗어나면 Dispose() 메서드를 호출한다.

 그리고 MS의 대부분 Stream에 관련된 클래스들은 Dispose() 메서드에 이러한 기능들이 정의 되어 있다. 따라서 IO 구현시 가능하면 using문을 사용하는 것이 실수를 예방하기에 좋은 편이다.

using문/try-catch 패턴 예시

using System;
using System.IO;

class FileRead
{
    var imgFilePath = @".\img.jpg";
    using(var imgFileStream = new FileStream(imgFilePath, FileMode.Open))
    {
        try
        {
            var tmpImg = Image.FromStream(imgFileStream);
            // ... 중략
        }
        catch(Exception ex)
        {
            // ... 예외 처리
        }
    }
}

 위의 패턴으로만 보았을 때 using문-try-catch 패턴이 깔끔해보인다. 하지만, 처음 using문에서 사용할 객체를 만드는 순간에 발생하는 예외의 경우 처리가 안되는 패턴이기 때문에 이를 피하기 위해서 파일 존재 여부 검사와 같은 추가 코드가 필요하다.

참고자료

도서: C# 7과 닷넷 코어 2.0