Microsoft MVP성태의 닷넷 이야기
기타: 70. 재현 가능한 최소한의 예제 프로젝트란? [링크 복사], [링크+제목 복사],
조회: 24973
글쓴 사람
정성태 (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]

... 91  92  93  94  95  96  97  98  99  100  101  [102]  103  104  105  ...
NoWriterDateCnt.TitleFile(s)
11380정성태11/30/201718239디버깅 기술: 109. windbg - (x64에서의 인자 값 추적을 이용한) Thread.Abort 시 대상이 되는 스레드를 식별하는 방법
11379정성태11/30/201718972오류 유형: 435. System.Web.HttpException - Session state has created a session id, but cannot save it because the response was already flushed by the application.
11378정성태11/29/201720459.NET Framework: 701. 한글이 포함된 바이트 배열을 나눈 경우 한글이 깨지지 않도록 다시 조합하는 방법 [1]파일 다운로드1
11377정성태11/29/201719665.NET Framework: 700. CommonOpenFileDialog 사용 시 사용자가 선택한 파일 목록을 구하는 방법 [3]파일 다운로드1
11376정성태11/28/201724018VS.NET IDE: 123. Visual Studio 편집기의 \r\n (crlf) 개행을 \n으로 폴더 단위로 설정하는 방법
11375정성태11/28/201718880오류 유형: 434. Visual Studio로 ASP.NET 디버깅 중 System.Web.HttpException - Could not load type 오류
11374정성태11/27/201723911사물인터넷: 14. 라즈베리 파이 - (윈도우의 NT 서비스처럼) 부팅 시 시작하는 프로그램 설정 [1]
11373정성태11/27/201722934오류 유형: 433. Raspberry Pi/Windows 다중 플랫폼 지원 컴파일 관련 오류 기록
11372정성태11/25/201725953사물인터넷: 13. 윈도우즈 사용자를 위한 라즈베리 파이 제로 W 모델을 설정하는 방법 [4]
11371정성태11/25/201719632오류 유형: 432. Hyper-V 가상 스위치 생성 시 Failed to connect Ethernet switch port 0x80070002 오류 발생
11370정성태11/25/201719491오류 유형: 431. Hyper-V의 Virtual Switch 생성 시 "External network" 목록에 특정 네트워크 어댑터 항목이 없는 경우
11369정성태11/25/201721626사물인터넷: 12. Raspberry Pi Zero(OTG)를 다른 컴퓨터에 연결해 가상 키보드 및 마우스로 쓰는 방법 (절대 좌표, 상대 좌표, 휠) [1]
11368정성태11/25/201727238.NET Framework: 699. UDP 브로드캐스트 주소 255.255.255.255와 192.168.0.255의 차이점과 이를 고려한 C# UDP 서버/클라이언트 예제 [2]파일 다운로드1
11367정성태11/25/201727258개발 환경 구성: 337. 윈도우 운영체제의 route 명령어 사용법
11366정성태11/25/201718909오류 유형: 430. 이벤트 로그 - Cryptographic Services failed while processing the OnIdentity() call in the System Writer Object.
11365정성태11/25/201721157오류 유형: 429. 이벤트 로그 - User Policy could not be updated successfully
11364정성태11/24/201722985사물인터넷: 11. Raspberry Pi Zero(OTG)를 다른 컴퓨터에 연결해 가상 마우스로 쓰는 방법 (절대 좌표) [2]
11363정성태11/23/201723031사물인터넷: 10. Raspberry Pi Zero(OTG)를 다른 컴퓨터에 연결해 가상 마우스 + 키보드로 쓰는 방법 (두 번째 이야기)
11362정성태11/22/201719562오류 유형: 428. 윈도우 업데이트 KB4048953 - 0x800705b4 [2]
11361정성태11/22/201722402오류 유형: 427. 이벤트 로그 - Filter Manager failed to attach to volume '\Device\HarddiskVolume??' 0xC03A001C
11360정성태11/22/201722162오류 유형: 426. 이벤트 로그 - The kernel power manager has initiated a shutdown transition.
11359정성태11/16/201721654오류 유형: 425. 윈도우 10 Version 1709 (OS Build 16299.64) 업그레이드 시 발생한 문제 2가지
11358정성태11/15/201726360사물인터넷: 9. Visual Studio 2017에서 Raspberry Pi C++ 응용 프로그램 제작 [1]
11357정성태11/15/201726794개발 환경 구성: 336. 윈도우 10 Bash 쉘에서 C++ 컴파일하는 방법
11356정성태11/15/201728440사물인터넷: 8. Raspberry Pi Zero(OTG)를 다른 컴퓨터에 연결해 가상 마우스 + 키보드로 쓰는 방법 [4]
11355정성태11/15/201724331사물인터넷: 7. Raspberry Pi Zero(OTG)를 다른 컴퓨터에 연결해 가상 마우스로 쓰는 방법 [2]파일 다운로드2
... 91  92  93  94  95  96  97  98  99  100  101  [102]  103  104  105  ...