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

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

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

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

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

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

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

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();
        }
    }
}

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




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

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




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 1/5/2023]

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

비밀번호

댓글 작성자
 



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

... 46  47  48  49  50  51  52  53  54  55  56  57  58  59  [60]  ...
NoWriterDateCnt.TitleFile(s)
12132정성태1/28/202012239.NET Framework: 883. C#으로 구현하는 Win32 API 후킹(예: Sleep 호출 가로채기)파일 다운로드1
12131정성태1/27/202012295개발 환경 구성: 467. LocaleEmulator를 이용해 유니코드를 지원하지 않는(한글이 깨지는) 프로그램을 실행하는 방법 [1]
12130정성태1/26/20209768VS.NET IDE: 142. Visual Studio에서 windbg의 "Open Executable..."처럼 EXE를 직접 열어 디버깅을 시작하는 방법
12129정성태1/26/202015326.NET Framework: 882. C# - 키움 Open API+ 사용 시 Registry 등록 없이 KHOpenAPI.ocx 사용하는 방법 [3]
12128정성태1/26/202010113오류 유형: 591. The code execution cannot proceed because mfc100.dll was not found. Reinstalling the program may fix this problem.
12127정성태1/25/20209992.NET Framework: 881. C# DLL에서 제공하는 Win32 export 함수의 내부 동작 방식(VT Fix up Table)파일 다운로드1
12126정성태1/25/202010816.NET Framework: 880. C# - PE 파일로부터 IMAGE_COR20_HEADER 및 VTableFixups 테이블 분석파일 다운로드1
12125정성태1/24/20208696VS.NET IDE: 141. IDE0019 - Use pattern matching
12124정성태1/23/202010526VS.NET IDE: 140. IDE1006 - Naming rule violation: These words must begin with upper case characters: ...
12123정성태1/23/202011990웹: 39. Google Analytics - gtag 함수를 이용해 페이지 URL 수정 및 별도의 이벤트 생성 방법 [2]
12122정성태1/20/20208986.NET Framework: 879. C/C++의 UNREFERENCED_PARAMETER 매크로를 C#에서 우회하는 방법(IDE0060 - Remove unused parameter '...')파일 다운로드1
12121정성태1/20/20209567VS.NET IDE: 139. Visual Studio - Error List: "Could not find schema information for the ..."파일 다운로드1
12120정성태1/19/202010987.NET Framework: 878. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 네 번째 이야기(IL 코드로 직접 구현)파일 다운로드1
12119정성태1/17/202011008디버깅 기술: 160. Windbg 확장 DLL 만들기 (3) - C#으로 만드는 방법
12118정성태1/17/202011664개발 환경 구성: 466. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 세 번째 이야기 [1]
12117정성태1/15/202010638디버깅 기술: 159. C# - 디버깅 중인 프로세스를 강제로 다른 디버거에서 연결하는 방법파일 다운로드1
12116정성태1/15/202011110디버깅 기술: 158. Visual Studio로 디버깅 시 sos.dll 확장 명령어를 (비롯한 windbg의 다양한 기능을) 수행하는 방법
12115정성태1/14/202010888디버깅 기술: 157. C# - PEB.ProcessHeap을 이용해 디버깅 중인지 확인하는 방법파일 다운로드1
12114정성태1/13/202012750디버깅 기술: 156. C# - PDB 파일로부터 심벌(Symbol) 및 타입(Type) 정보 열거 [1]파일 다운로드3
12113정성태1/12/202013374오류 유형: 590. Visual C++ 빌드 오류 - fatal error LNK1104: cannot open file 'atls.lib' [1]
12112정성태1/12/20209976오류 유형: 589. PowerShell - 원격 Invoke-Command 실행 시 "WinRM cannot complete the operation" 오류 발생
12111정성태1/12/202013213디버깅 기술: 155. C# - KernelMemoryIO 드라이버를 이용해 실행 프로그램을 숨기는 방법(DKOM: Direct Kernel Object Modification) [16]파일 다운로드1
12110정성태1/11/202011809디버깅 기술: 154. Patch Guard로 인해 블루 스크린(BSOD)가 발생하는 사례 [5]파일 다운로드1
12109정성태1/10/20209734오류 유형: 588. Driver 프로젝트 빌드 오류 - Inf2Cat error -2: "Inf2Cat, signability test failed."
12108정성태1/10/20209741오류 유형: 587. Kernel Driver 시작 시 127(The specified procedure could not be found.) 오류 메시지 발생
12107정성태1/10/202010693.NET Framework: 877. C# - 프로세스의 모든 핸들을 열람 - 두 번째 이야기
... 46  47  48  49  50  51  52  53  54  55  56  57  58  59  [60]  ...