Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - .NET 7 Preview 5 신규 기능 - System.IO.Stream ReadExactly / ReadAtLeast

System.IO.Stream에 반가운 기능이 추가되었군요. ^^

System.IO.Stream - ReadExactly and ReadAtLeast
; https://devblogs.microsoft.com/dotnet/announcing-dotnet-7-preview-5/#readexactly-and-readatleast

TCP 프로토콜의 경우, message-oriented의 UDP와는 달리 stream-oriented 방식이기 때문에 패킷이 분할돼 오는 것을 감안해야 합니다. 예를 들어 볼까요? ^^

여러분들이 프로토콜을 다음과 같은 식으로 만들었다고 가정해 보겠습니다.

int size 0~4바이트: contents 길이
byte [] contents: size에 명시한 만큼의 데이터

그럼 보내는 쪽에서는 처음 4바이트에 contents 버퍼의 데이터 크기를 실어 보내고, 이어서 contents를 보내게 될 것입니다.

// 서버에서 클라이언트로 데이터 송신
string data = "12345";

byte[] contents = Encoding.UTF8.GetBytes(data);
byte[] header = BitConverter.GetBytes(contents.Length);
socket.Send(header);
socket.Send(contents); 

그리고 받는 측에서는 다음과 같이 코딩을 하면,

// 클라이언트에서 서버로부터 데이터 수신
byte[] buf = new byte[4];

socket.Receive(buf, 0, 4, SocketFlags.None);
int len = BitConverter.ToInt32(buf, 0);

buf = new byte[len];
socket.Receive(buf, 0, len, SocketFlags.None); // buf에는 문자열 "12345"가 utf-8 인코딩된 바이트를 수신

대개의 경우 저런 상황이라면 정상적으로 수신이 될 것입니다. 하지만, 서버와 클라이언트를 원격지에 두고 contents의 길이를 늘린다면 이제 상황은 달라집니다.

예를 들어 송신 측에서 1_000_000 바이트의 데이터를 보내도 수신 측의 Receive는 그것을 전부 받지 못하고 분할 수신이 될 수 있습니다. 이런 이유로 인해 Receive의 경우는 대개 다음과 같은 식으로 코딩하는 것이 일반적입니다.

public int Read(byte[] buffer, int offset, int size)
{
    int totalRead = 0;
    int readRemains = size;

    while (true)
    {
        int readLen = 0;

        try
        {
            readLen = _socket.Receive(buffer, offset, readRemains, SocketFlags.None);
        }
        catch (SocketException ex) { }

        if (readLen == 0)
        {
            _socket.Close();
            break;
        }

        totalRead += readLen;

        if (totalRead == size)
        {
            break;
        }

        offset += readLen;
        readRemains -= readLen;
    }

    return totalRead;
}

저렇게 helper 메서드를 하나 만들어 두고 다시 이것을 활용해,

// Read 메서드를 이용한 데이터 수신
byte[] buf = new byte[4];
Read(buf, 0, 4);

int len = BitConverter.ToInt32(buf, 0);
buf = new byte[len];
Read(buf, 0, len);

수신하면 정상적으로 buf 바이트 배열에는 송신자가 약속한 크기의 데이터가 들어가게 됩니다.




.NET 7부터 추가된 Stream 타입의 ReadExactly 메서드가 바로 저런 Read의 부차적인 코드를 없애줍니다. ^^ 그래서 다음과 같은 식으로 코드를 바꿔 처리할 수 있습니다.

// Visual Studio 2022 17.2의 경우 실습 방법

NetworkStream ns = new NetworkStream(socket);
ns.ReadExactly(buf, 0, 4);

len = BitConverter.ToInt32(buf, 0);
buf = new byte[len];
ns.ReadExactly(buf, 0, len);

참 쉽죠? ^^

이와 함께 ReadAtLeast는 이름에서 의미하는 것처럼 최소 지정한 바이트만큼을 읽어들이는 것을 보장합니다. 이건 어느 때 유용할까요? 이전에 예를 든 코드를 다시 보면, 무조건 2번의 Read 메서드를 호출해야만 했는데요, 하지만 여러분들의 응용 프로그램이 대개의 경우 한 번의 Receive로 처리할 정도로 작은 데이터가 주를 이룬다고 가정하면 ReadAtLeast 한 번의 호출로 끝나는 코드를 다음과 같이 만들 수 있습니다.

NetworkStream ns = new NetworkStream(socket);
int readBytes = ns.ReadAtLeast(buf, 4); // 최소 4바이트를 읽어들이지만, 이미 버퍼에 있는 4바이트 이상의 데이터를 더 읽어서 반환하는 것도 가능
len = BitConverter.ToInt32(buf, 0);

if (readBytes < (len + 4))
{
    ns.ReadExactly(buf, 0, len - (readBytes - 4));
}

물론, 비동기 버전도 함께 Stream 레벨에 추가되었습니다. ^^

namespace System.IO;

public partial class Stream
{
    public void ReadExactly(Span<byte> buffer);
    public void ReadExactly(byte[] buffer, int offset, int count);

    public ValueTask ReadExactlyAsync(Memory<byte> buffer, CancellationToken cancellationToken = default);
    public ValueTask ReadExactlyAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken = default);

    public int ReadAtLeast(Span<byte> buffer, int minimumBytes, bool throwOnEndOfStream = true);
    public ValueTask<int> ReadAtLeastAsync(Memory<byte> buffer, int minimumBytes, bool throwOnEndOfStream = true, CancellationToken cancellationToken = default);
}

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




참고로 이런 helper 메서드는 이미 다른 언어의 라이브러리들도 제공하고 있었습니다. 가령 GoLang의 경우 이와 유사한 ReadFull / ReadAtLeast 함수가 있습니다.

func ReadFull(r Reader, buf []byte) (n int, err error)
; https://pkg.go.dev/io#ReadFull

func ReadAtLeast(r Reader, buf []byte, min int) (n int, err error)
; https://pkg.go.dev/io#ReadAtLeast

또한 닷넷과 GoLang 모두 ReadExactly(ReadFull) 메서드는 ReadAtLeast에 적절한 인자를 전달하는 방식으로 처리를 대행합니다.




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







[최초 등록일: ]
[최종 수정일: 6/17/2022]

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

비밀번호

댓글 작성자
 




1  2  3  4  5  6  7  8  [9]  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13446정성태11/16/20233426닷넷: 2161. .NET Conf 2023 - Day 1 Blazor 개요 정리
13445정성태11/15/20233767Linux: 62. 리눅스/WSL에서 CA 인증서를 저장하는 방법
13444정성태11/15/20233493닷넷: 2160. C# 12 - Experimental 특성 지원
13443정성태11/14/20233378개발 환경 구성: 687. OpenSSL로 생성한 사용자 인증서를 ASP.NET Core 웹 사이트에 적용하는 방법
13442정성태11/13/20233161개발 환경 구성: 686. 비주얼 스튜디오로 실행한 ASP.NET Core 사이트를 WSL 2 인스턴스에서 https로 접속하는 방법
13441정성태11/12/20233636닷넷: 2159. C# - ASP.NET Core 프로젝트에서 서버 Socket을 직접 생성하는 방법파일 다운로드1
13440정성태11/11/20233219Windows: 253. 소켓 Listen 시 방화벽의 Public/Private 제어 기능이 비활성화된 경우
13439정성태11/10/20233980닷넷: 2158. C# - 소켓 포트를 미리 시스템에 등록/예약해 사용하는 방법(Port Exclusion Ranges)파일 다운로드1
13438정성태11/9/20233381닷넷: 2157. C# - WinRT 기능을 이용해 윈도우에서 실행 중인 Media App 제어
13437정성태11/8/20233522닷넷: 2156. .NET 7 이상의 콘솔 프로그램을 (dockerfile 없이) 로컬 docker에 배포하는 방법
13436정성태11/7/20233754닷넷: 2155. C# - .NET 8 런타임부터 (Reflection 없이) 특성을 이용해 public이 아닌 멤버 호출 가능
13435정성태11/6/20233680닷넷: 2154. C# - 네이티브 자원을 포함한 관리 개체(예: 스레드)의 GC 정리
13434정성태11/1/20233437스크립트: 62. 파이썬 - class의 정적 함수를 동적으로 교체
13433정성태11/1/20233003스크립트: 61. 파이썬 - 함수 오버로딩 미지원
13432정성태10/31/20233331오류 유형: 878. 탐색기의 WSL 디렉터리 접근 시 "Attempt to access invalid address." 오류 발생
13431정성태10/31/20233703스크립트: 60. 파이썬 - 비동기 FastAPI 앱을 gunicorn으로 호스팅
13430정성태10/30/20233491닷넷: 2153. C# - 사용자가 빌드한 ICU dll 파일을 사용하는 방법
13429정성태10/27/20233669닷넷: 2152. Win32 Interop - C/C++ DLL로부터 이중 포인터 버퍼를 C#으로 받는 예제파일 다운로드1
13428정성태10/25/20233741닷넷: 2151. C# 12 - ref readonly 매개변수
13427정성태10/18/20233994닷넷: 2150. C# 12 - 정적 문맥에서 인스턴스 멤버에 대한 nameof 접근 허용(Allow nameof to always access instance members from static context)
13426정성태10/13/20234086스크립트: 59. 파이썬 - 비동기 호출 함수(run_until_complete, run_in_executor, create_task, run_in_threadpool)
13425정성태10/11/20233941닷넷: 2149. C# - PLinq의 Partitioner<T>를 이용한 사용자 정의 분할파일 다운로드1
13423정성태10/6/20233971스크립트: 58. 파이썬 - async/await 기본 사용법
13422정성태10/5/20234052닷넷: 2148. C# - async 유무에 따른 awaitable 메서드의 병렬 및 예외 처리
13421정성태10/4/20234130닷넷: 2147. C# - 비동기 메서드의 async 예약어 유무에 따른 차이
13420정성태9/26/20237377스크립트: 57. 파이썬 - UnboundLocalError: cannot access local variable '...' where it is not associated with a value
1  2  3  4  5  6  7  8  [9]  10  11  12  13  14  15  ...