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

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

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

비동기 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]

... 76  77  78  79  80  [81]  82  83  84  85  86  87  88  89  90  ...
NoWriterDateCnt.TitleFile(s)
11911정성태5/23/201917516VS.NET IDE: 136. Visual Studio 2019 - 리눅스 C/C++ 프로젝트에 인텔리센스가 동작하지 않는 경우
11910정성태5/23/201927129Math: 50. C# - MathNet.Numerics의 Matrix(행렬) 연산 [1]파일 다운로드1
11909정성태5/22/201921243.NET Framework: 837. C# - PLplot 사용 예제 [1]파일 다운로드1
11908정성태5/22/201919991.NET Framework: 836. C# - Python range 함수 구현파일 다운로드1
11907정성태5/22/201916702오류 유형: 541. msbuild - MSB4024 The imported project file "...targets" could not be loaded
11906정성태5/21/201916992.NET Framework: 835. .NET Core/C# - 리눅스 syslog에 로그 남기는 방법
11905정성태5/21/201917447.NET Framework: 834. C# - 폴더 경로 문자열에서 "..", "." 표기를 고려한 최종 문자열을 얻는 방법 - 두 번째 이야기
11904정성태5/21/201925884.NET Framework: 833. C# - Open Hardware Monitor를 이용한 CPU 온도 정보 [1]파일 다운로드1
11903정성태5/21/201919687오류 유형: 540. .NET Core - System.PlatformNotSupportedException: The named version of this synchronization primitive is not supported on this platform.
11902정성태5/21/201917782오류 유형: 539. mstest 실행 시 "The directory name is invalid." 오류 발생
11901정성태5/21/201919751오류 유형: 538. msbuild 오류 - Could not find a part of the path '%LOCALAPPDATA%\Temp\2\.NETFramework,Version=v4.0.AssemblyAttributes.cs'
11900정성태5/18/201918726오류 유형: 537. "sfc /scannow" 실행 중 시스템이 부팅되는 현상
11899정성태5/17/201919575Linux: 9. Linux에서 윈도우의 OutputDebugString 대신 사용할 수 있는 syslog [1]
11898정성태5/16/201921384VC++: 130. C++ string의 c_str과 data 함수의 차이점 [3]
11897정성태5/16/201928333오류 유형: 536. Visual Studio - "Developer Pack"을 설치했는데도 "대상 프레임워크" 목록에 나오지 않는 경우 [2]
11896정성태5/15/201923347개발 환경 구성: 440. C#, C++ - double의 Infinity, NaN 표현 방식파일 다운로드1
11895정성태5/12/201921117.NET Framework: 832. ML.NET Model Builder - 회귀(Regression), 다중 분류(Multi-class classification) 예제파일 다운로드1
11894정성태5/10/201922851VS.NET IDE: 135. Visual Studio - ML.NET Model Builder 소개 [5]
11893정성태5/10/201919726오류 유형: 535. C# 6.0 이상의 문법을 컴파일 시 오류가 발생한다면?
11892정성태5/10/201919589웹: 38. HTTP Cookie의 expires 시간 형식(RFC7231)
11891정성태5/9/201922651.NET Framework: 831. (번역글) .NET Internals Cookbook Part 12 - Memory structure, attributes, handles
11890정성태5/8/201917810개발 환경 구성: 439. "Visual Studio Enterprise is required to execute the test." 메시지와 관련된 코드 기록
11889정성태5/8/201918441개발 환경 구성: 438. mstest, QTAgent의 로그 파일 설정 방법
11888정성태5/8/201935796.NET Framework: 830. C# - 비동기 호출을 취소하는 CancellationToken의 간단한 예제 코드 [1]파일 다운로드1
11887정성태5/8/201921462.NET Framework: 829. C# - yield 문을 사용할 수 있는 메서드의 조건
11886정성태5/7/201919254오류 유형: 534. mstest.exe 실행 시 "Visual Studio Enterprise is required to execute the test." 오류 [2]
... 76  77  78  79  80  [81]  82  83  84  85  86  87  88  89  90  ...