Microsoft MVP성태의 닷넷 이야기
기타: 70. 재현 가능한 최소한의 예제 프로젝트란? [링크 복사], [링크+제목 복사]
조회: 11116
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

재현 가능한 최소한의 예제 프로젝트란?

질문을 할 때는 "재현 가능한 최소한의 예제"를 올려주시는 것이 좋습니다. 예를 하나 들기 위해 아래의 질문에 첨부된 예제를 보겠습니다.

비동기 TCP통신 데이터 문제
; https://www.sysnet.pe.kr/3/0/4946

이 질문에는 프로젝트가 3개 첨부되어 있습니다. 그렇다면 이 프로젝트가 "재현 가능한 최소한의 예제 프로젝트"일까요? 현재 해당 소스 코드는 SerialPort 및 소켓 통신을 비롯해 Queue를 이용한 처리, Windows Form UI 구성 요소 사용과 같은 다양한 소스 코드가 얽혀 있습니다. 이런 상태로 프로젝트를 올려주는 것은 "재현 가능한 최소한의 예제 프로젝트"가 아닙니다.

사실 답변자는 질문자와 함께 해당 프로젝트를 진행하고 있는 상태가 아닙니다. 따라서 사소한 코드 하나까지 눈에 익으려면 시간을 요합니다. 물론 능력있는 분들은 대강 어떤 부분이 핵심인지 금방 파악하시겠지만, 아무튼 저는 아닙니다. 따라서 이런 식으로 코드를 올려 주시면 그만큼 답변자가 이해를 위한 시간을 소모해야 합니다.

결론만 봤을 때 질문자가 궁금한 것은 왜 소켓으로 Receive한 버퍼에 "\0\0\0..." 등의 데이터가 있느냐입니다. 그렇다면, 질문하고자 하는 것과 관련된 소스 코드만 포함하면 됩니다. 즉, 다음과 같은 소스 코드를 담은 단 하나의 프로젝트로 축소해서 자신이 모르는 곳에 주석으로 질문과 함께 올려주면 되는 것입니다.

using System;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            StartServerSocket();

            Thread.Sleep(1000);

            StartClientSocket();

            Console.ReadLine();
        }

        private static void StartClientSocket()
        {
            Thread t1 = new Thread(ServerFunc);
            t1.IsBackground = true;
            t1.Start();
        }

        private static void ServerFunc()
        {
            Socket sock = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);

            var ep = new IPEndPoint(IPAddress.Any, 7001);
            sock.Bind(ep);

            sock.Listen(100);

            Socket Sever_ROBOT_Socket = sock.Accept();

            string args;
            while (true)
            {
                args = Recived_data(Sever_ROBOT_Socket);
                if (args == null)
                {
                    return;
                }
                System.Threading.Thread.Sleep(5000);
                Send_Data(args, Sever_ROBOT_Socket);
            }
        }

        private static void StartServerSocket()
        {
            Thread t1 = new Thread(ClientFunc);
            t1.IsBackground = true;
            t1.Start();
        }

        private static void ClientFunc()
        {
            Socket socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
            var ep = new IPEndPoint(IPAddress.Parse("127.0.0.1"), 7001);
            socket.Connect(ep);

            Send_Data("data", socket);
            string text = Recived_data(socket);

            // 질문: 왜 이곳에서 text의 내용에 "\0\0\0"가 추가되나요?
            Console.WriteLine(text);
        }

        private static void Send_Data(string data, Socket socket)
        {
            var buff = Encoding.GetEncoding("euc-kr").GetBytes(data);
            socket.Send(buff, SocketFlags.None);
        }

        private static string Recived_data(Socket socket)
        {
            byte[] buff = new byte[1024];
            try
            {
                var dataLength = socket.Receive(buff);
                if (dataLength < 1)
                    return null;
            }
            catch (Exception)
            {
            }

            return Encoding.GetEncoding("euc-kr").GetString(buff).Trim();
        }
    }
}

그럼 답변자 입장에서 해당 프로젝트 파일을 비주얼 스튜디오에서 열어 그 즉시 디버거 상태로 실행해 보고 금방 답을 내릴 수 있습니다. 이거저거 살펴볼 필요가 없는 것입니다.




"재현 가능한 최소한의 예제 프로젝트"를 만드는 것은 스스로 답을 찾는 데에도 중요합니다. 범위를 좁히다 보면 자신이 실수한 것이 무엇인지 보이는 경우도 더러 있고, 실수하지 않았다 해도 어떤 것이 문제였는지 알 수 있는 확률도 높아집니다. 물론, 경우에 따라 "재현 가능한" 프로젝트로 축소하는 것이 어려울 수 있습니다. 그런데 따지고 보면 그런 경우라면 저도 사실 답변을 할 수 없는 상황일 때가 많습니다.

결론은, 코드로 인한 문제라면 정말로 "재현 가능한 최소한의, 문제의 핵심만을 담은 예제 프로젝트"를 실어달라는 것입니다. 그렇지 않다면 저도 답변하지 않습니다.




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 6/27/2021]

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

비밀번호

댓글 작성자
 



2018-02-06 06시57분
[예제작성자] 코드를 이런식으로 줄여달라는 말씀이셨군요. 이부분은 미처 생각을 못했습니다. 죄송합니다.
두개의 소켓통신을 하는데 하나의 소켓은 정상적이지만 다른 하나의 소켓은 그런식으로 나와서 질문을 드렸던건데 본질적인 답은 얻지 못했지만 해결은 되었습니다.(동일한 send, receive)
[손님]
2018-02-07 12시04분
넵. 이런 식으로 줄여 주셔야 문제에 집중해서 답변을 드릴 수 있습니다. 그냥 만드시던 거 주시면 눈에 안 들어옵니다. ^^
정성태
2018-03-19 12시38분
[행인1] 좋은 글입니다 함정은 줄이다 보면 스스로 문제를 발견할 가능성이 커진다는 점이겠지요?
[손님]

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13176정성태11/29/20229오류 유형: 828. gunicorn - ModuleNotFoundError: No module named 'flask'
13175정성태11/29/202212오류 유형: 827. Python - ImportError: cannot import name 'html5lib' from 'pip._vendor'
13174정성태11/28/202256.NET Framework: 2073. C# - VMMap처럼 스택 메모리의 reserve/guard/commit 상태 출력파일 다운로드1
13173정성태11/27/202288.NET Framework: 2072. 닷넷 응용 프로그램의 스레드 스택 크기 변경
13172정성태11/25/202296.NET Framework: 2071. 닷넷에서 ESP/RSP 레지스터 값을 구하는 방법파일 다운로드1
13171정성태11/25/202292Windows: 214. 윈도우 - 스레드 스택의 "red zone"
13170정성태11/24/2022164Windows: 213. 윈도우 - 싱글 스레드는 컨텍스트 스위칭이 없을까요?
13169정성태11/23/2022189Windows: 212. 윈도우의 Protected Process (Light) 보안 [1]파일 다운로드2
13168정성태11/22/2022152제니퍼 .NET: 31. 제니퍼 닷넷 적용 사례 (9) - DB 서비스에 부하가 걸렸다?!
13167정성태11/21/2022165.NET Framework: 2070. .NET 7 - Console.ReadKey와 리눅스의 터미널 타입
13166정성태11/20/2022122개발 환경 구성: 651. Windows 사용자 경험으로 WSL 환경에 dotnet 런타임/SDK 설치 방법
13165정성태11/18/2022123개발 환경 구성: 650. Azure - "scm" 프로세스와 엮인 서비스 모음
13164정성태11/18/2022305개발 환경 구성: 649. Azure - 비주얼 스튜디오를 이용한 AppService 원격 디버그 방법
13163정성태11/17/2022154개발 환경 구성: 648. 비주얼 스튜디오에서 안드로이드 기기 인식하는 방법
13162정성태11/15/2022460.NET Framework: 2069. .NET 7 - AOT(ahead-of-time) 컴파일
13161정성태11/14/2022327.NET Framework: 2068. C# - PublishSingleFile로 배포한 이미지의 역어셈블 가능 여부 (난독화 필요성) [2]
13160정성태11/11/2022402.NET Framework: 2067. C# - PublishSingleFile 적용 시 native/managed 모듈 통합 옵션
13159정성태11/10/2022529.NET Framework: 2066. C# - PublishSingleFile과 관련된 옵션 [2]
13158정성태11/9/2022409오류 유형: 826. Workload definition 'wasm-tools' in manifest 'microsoft.net.workload.mono.toolchain' [...] conflicts with manifest 'microsoft.net.workload.mono.toolchain.net7'
13157정성태11/8/2022583.NET Framework: 2065. C# - Mutex의 비동기 버전파일 다운로드1
13156정성태11/7/2022603.NET Framework: 2064. C# - Mutex와 Semaphore/SemaphoreSlim 차이점파일 다운로드1
13155정성태11/4/20221115디버깅 기술: 183. TCP 동시 접속 (연결이 아닌) 시도를 1개로 제한한 서버
13154정성태11/3/2022607.NET Framework: 2063. .NET 5+부터 지원되는 GC.GetGCMemoryInfo파일 다운로드1
13153정성태11/2/2022529.NET Framework: 2062. C# - 코드로 재현하는 소켓 상태(SYN_SENT, SYN_RECV)
13152정성태11/1/2022503.NET Framework: 2061. ASP.NET Core - DI로 추가한 클래스의 초기화 방법
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...