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

1  2  3  4  5  6  7  8  [9]  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13404정성태8/29/20233476오류 유형: 876. Windows - 키보드의 등호(=, Equals sign) 키가 눌리지 않는 경우
13403정성태8/21/20233315오류 유형: 875. The following signatures couldn't be verified because the public key is not available: NO_PUBKEY EB3E94ADBE1229CF
13402정성태8/20/20233385닷넷: 2137. ILSpy의 nuget 라이브러리 버전 - ICSharpCode.Decompiler
13401정성태8/19/20233599닷넷: 2136. .NET 5+ 환경에서 P/Invoke의 성능을 높이기 위한 SuppressGCTransition 특성 [1]
13400정성태8/10/20233449오류 유형: 874. 파이썬 - pymssql을 윈도우 환경에서 설치 불가
13399정성태8/9/20233455닷넷: 2135. C# - 지역 변수로 이해하는 메서드 매개변수의 값/참조 전달
13398정성태8/3/20234250스크립트: 55. 파이썬 - pyodbc를 이용한 SQL Server 연결 사용법
13397정성태7/23/20233760닷넷: 2134. C# - 문자열 연결 시 string.Create를 이용한 GC 할당 최소화
13396정성태7/22/20233468스크립트: 54. 파이썬 pystack 소개 - 메모리 덤프로부터 콜 스택 열거
13395정성태7/20/20233387개발 환경 구성: 685. 로컬에서 개발 중인 ASP.NET Core/5+ 웹 사이트에 대해 localhost 이외의 호스트 이름으로 접근하는 방법
13394정성태7/16/20233344오류 유형: 873. Oracle.ManagedDataAccess.Client - 쿼리 수행 시 System.InvalidOperationException
13393정성태7/16/20233508닷넷: 2133. C# - Oracle 데이터베이스의 Sleep 쿼리 실행하는 방법
13392정성태7/16/20233387오류 유형: 872. Oracle - ORA-01031: insufficient privileges
13391정성태7/14/20233460닷넷: 2132. C# - sealed 클래스의 메서드를 callback 호출했을 때 인라인 처리가 될까요?
13390정성태7/12/20233421스크립트: 53. 파이썬 - localhost 호출 시의 hang 현상
13389정성태7/5/20233453개발 환경 구성: 684. IIS Express로 호스팅하는 웹을 WSL 환경에서 접근하는 방법
13388정성태7/3/20233575오류 유형: 871. 윈도우 탐색기에서 열리지 않는 zip 파일 - The Compressed (zipped) Folder '[...].zip' is invalid. [1]파일 다운로드1
13387정성태6/28/20233596오류 유형: 870. _mysql - Commands out of sync; you can't run this command now
13386정성태6/27/20233669Linux: 61. docker - 원격 제어를 위한 TCP 바인딩 추가
13385정성태6/27/20233885Linux: 60. Linux - 외부에서의 접속을 허용하기 위한 TCP 포트 여는 방법
13384정성태6/26/20233628.NET Framework: 2131. C# - Source Generator로 해결하는 enum 박싱 문제파일 다운로드1
13383정성태6/26/20233376개발 환경 구성: 683. GPU 런타임을 사용하는 Colab 노트북 설정
13382정성태6/25/20233426.NET Framework: 2130. C# - Win32 API를 이용한 윈도우 계정 정보 (예: 마지막 로그온 시간)파일 다운로드1
13381정성태6/25/20233817오류 유형: 869. Fatal Python error: init_fs_encoding: failed to get the Python codec of the filesystem encoding
13380정성태6/24/20233256스크립트: 52. 파이썬 3.x에서의 동적 함수 추가
13379정성태6/23/20233285스크립트: 51. 파이썬 2.x에서의 동적 함수 추가
1  2  3  4  5  6  7  8  [9]  10  11  12  13  14  15  ...