[C#] TCP 채팅 프로그램 #1 Server 구현

해당 게시글은 아래 개발환경을 사용하여 작성됨

IDE : VisualStudio 2022

Framework : .NET 7.0

Language : C# 11

 

1. TCP

• TCP에 대한 내용은 아래 게시글을 참고

[C#] 네트워크 통신 - TCP&UDP

 

2. 프로젝트 생성

• TCP_Server 프로젝트를 생성
  • 프로젝트명 : TCP_Server
  • 솔루션명 : TCP_Project
  • 프레임워크 : .NET 7.0

Step 1. 프로젝트 구성

Step 2. 프레임워크 선택

 

 

 

3. 디자인

• 아래 이미지와 같이 컨트롤러들을 배치한다.

Form1 디자인

 

4. C# - TCP Server 코드 작성하기

• 4.1 ~ 4.10를 참고하여 TCP Server 코드를 작성한다.

 

4.1 네임스페이스 작성

• 해당 프로젝트에서 사용할 네임스페이스를 선언한다.

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

 

4.2 전역변수 선언

• 해당 프로젝트에서 사용할 전역 변수들을 선언한다.

TcpListener server = null; // 서버
TcpClient clientSocket = null; // 소켓

string date; // 날짜
private Dictionary<TcpClient, string> clientList = new Dictionary<TcpClient, string>(); // 각 클라이언트 마다 리스트에 추가
private int PORT = 5000; // 포트 정보

 

4.3 IP&Port 설정

• Server가 실행되는 PC 또는 서버의 IP를 가져오는 메서드 작성
• Client와 통신에 사용할 Port 지정

private int PORT = 5000; // 포트 정보

/// <summary>
/// Form Load 이벤트
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void Form1_Load(object sender, EventArgs e)
{
    InitForm();
    this.Text = "Server";
    txtIP.Text = "";
    txtIP.Text = GetLocalIP();
    txtPort.Text = PORT.ToString();
}

/// <summary>
/// IP 가져오기
/// </summary>
/// <returns></returns>
private string GetLocalIP()
{
    IPHostEntry host = Dns.GetHostEntry(Dns.GetHostName());
    string localIP = string.Empty;

    for (int i = 0; i < host.AddressList.Length; i++)
    {
        if (host.AddressList[i].AddressFamily == AddressFamily.InterNetwork)
        {
            localIP = host.AddressList[i].ToString();
            break;
        }
    }

    return localIP;
}

private void InitForm()
{
    txtIP.Text = "";
    txtPort.Text = "";
    txtMessage.Text = "";
    richTextBox1.Text = "";
    listBox1.Items.Clear();
}

 

4.4 HandleClient 작성

• 클래스명 : HandleClient.cs

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Net.Sockets;
using System.Text;
using System.Threading.Tasks;

namespace TCPIP_Server
{
    internal class HandleClient
    {
        TcpClient clientSocket = null;
        public Dictionary<TcpClient, string> clientList = null;

        public void startClient(TcpClient clientSocket, Dictionary<TcpClient, string> clientList)
        {
            this.clientSocket = clientSocket;
            this.clientList = clientList;

            Thread t_hanlder = new Thread(doChat);
            t_hanlder.IsBackground = true;
            t_hanlder.Start();
        }

        public delegate void MessageDisplayHandler(string message, string userName);
        public event MessageDisplayHandler OnReceived;

        public delegate void DisconnectedHandler(TcpClient clientSocket);
        public event DisconnectedHandler OnDisconnected;

        private void doChat()
        {
            NetworkStream stream = null;
            try
            {
                byte[] buffer = new byte[1024];
                string msg = string.Empty;
                int bytes = 0;
                int MessageCount = 0;

                while (true)
                {
                    MessageCount++;
                    stream = clientSocket.GetStream();
                    bytes = stream.Read(buffer, 0, buffer.Length);
                    msg = Encoding.Unicode.GetString(buffer, 0, bytes);
                    msg = msg.Substring(0, msg.IndexOf("$"));

                    if (OnReceived != null)
                        OnReceived(msg, clientList[clientSocket].ToString());
                }
            }
            catch (SocketException se)
            {
                Trace.WriteLine(string.Format("DoChat - SocketException : {0}", se.Message));

                if (clientSocket != null)
                {
                    if (OnDisconnected != null)
                        OnDisconnected(clientSocket);

                    clientSocket.Close();
                    stream.Close();
                }
            }
            catch (Exception ex)
            {
                Trace.WriteLine(string.Format("DoChat - Exception : {0}", ex.Message));

                if (clientSocket != null)
                {
                    if (OnDisconnected != null)
                        OnDisconnected(clientSocket);

                    clientSocket.Close();
                    stream.Close();
                }
            }
        }
    }
}

 

4.5 InitSocket() 메서드 작성

• InitSocket() : Client와 통신하는 메서드
• 해당 메서드를 통하여 Client와 주고 받은 데이터를 확인한다.

/// <summary>
/// Socket 초기화
/// </summary>
private void InitSocket()
{
    server = new TcpListener(IPAddress.Parse(txtIP.Text), int.Parse(txtPort.Text)); // 서버 객체 생성 및 IP주소와 Port번호를 할당
    clientSocket = default(TcpClient); // 소켓 설정
    server.Start(); // 서버 시작
    DisplayText("System : Server 시작");

    while (true)
    {
        try
        {
            clientSocket = server.AcceptTcpClient(); // client 소켓 접속 허용

            NetworkStream stream = clientSocket.GetStream();
            byte[] buffer = new byte[1024]; // 버퍼
            int bytes = stream.Read(buffer, 0, buffer.Length);
            string userName = Encoding.Unicode.GetString(buffer, 0, bytes);
            userName = userName.Substring(0, userName.IndexOf("$")); // client 사용자 명
            DisplayText("System : [" + userName + "] 접속");
            
            clientList.Add(clientSocket, userName); // cleint 리스트에 추가
            SendMessageAll(userName + " 님이 입장하셨습니다.", "", false); // 모든 client에게 메세지 전송
            SetUserList(userName, "I");

            HandleClient h_client = new HandleClient(); // 클라이언트 추가
            h_client.OnReceived += new HandleClient.MessageDisplayHandler(OnReceived);
            h_client.OnDisconnected += new HandleClient.DisconnectedHandler(h_client_OnDisconnected);
            h_client.startClient(clientSocket, clientList);
        }
        catch (SocketException se) { break; }

        catch (Exception ex) { break; }
    }

    clientSocket.Close(); // client 소켓 닫기

    server.Stop(); // 서버 종료
}

/// <summary>
/// Cleint 접속 해제 핸들러
/// </summary>
/// <param name="clientSocket">Client 정보</param>
private void h_client_OnDisconnected(TcpClient clientSocket)
{
    if (clientList.ContainsKey(clientSocket))
    {
        clientList.Remove(clientSocket);
    }
}

/// <summary>
/// Cleint로 부터 받은 데이터
/// </summary>
/// <param name="message">메세지</param>
/// <param name="userName">사용자명</param>
private void OnReceived(string message, string userName)
{
    if (message.Equals("LeaveChat"))
    {
        string displayMessage = "Leave user : " + userName;

        DisplayText(displayMessage);
        SendMessageAll("LeaveChat", userName, true);
        SetUserList(userName, "D");
    }
    else
    {
        string displayMessage = "From Client : " + userName + " : " + message;
        DisplayText(displayMessage); // Server단에 출력
        SendMessageAll(message, userName, true); // 모든 Client에게 전송
    }
}

 

4.6 기타 메서드

• DisplayText() : richTextBox에 텍스트를 추가하기 위해 정의된 메서드
• SetUserList() : 접속한 사용자 리스트 출력 메서드
• SendMessageAll() : 메세지 전송 메서드

/// <summary>
/// 화면에 Text 출력
/// </summary>
/// <param name="text"></param>
private void DisplayText(string text)
{
    richTextBox1.Invoke((MethodInvoker)delegate { richTextBox1.AppendText(text + "\r\n"); }); // 데이터를 수신창에 표시, 데이터 충돌을 피하기 위해 Invoke 사용
    richTextBox1.Invoke((MethodInvoker)delegate { richTextBox1.ScrollToCaret(); });  // 스크롤을 제일 아래로 설정
}

/// <summary>
/// 접속 Client 출력
/// </summary>
/// <param name="userName">사용자명</param>
/// <param name="div">구분(I: 입력, D: 삭제)</param>
private void SetUserList(string userName, string div)
{
    try
    {
        if (div.Equals("I"))
            listBox1.Items.Add(userName);
        else if (div.Equals("D"))
            listBox1.Items.Remove(userName);

    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.ToString());
    }
}

/// <summary>
/// 메세지 전송
/// </summary>
/// <param name="message">메세지</param>
/// <param name="userName">Client</param>
/// <param name="flag">구분자(True: 전체전송, False: 개별전송)</param>
public void SendMessageAll(string message, string userName, bool flag)
{
    foreach (var pair in clientList)
    {
        date = DateTime.Now.ToString("yyyy.MM.dd. HH:mm:ss"); // 현재 날짜 받기

        TcpClient client = pair.Key as TcpClient;
        NetworkStream stream = client.GetStream();
        byte[] buffer = null;

        if (flag)
        {
            if (message.Equals("LeaveChat"))
                buffer = Encoding.Unicode.GetBytes(userName + " 님이 대화방을 나갔습니다.");
            else
                buffer = Encoding.Unicode.GetBytes("[ " + date + " ] " + userName + " : " + message);
        }
        else
        {
            buffer = Encoding.Unicode.GetBytes(message);
        }
        stream.Write(buffer, 0, buffer.Length); // 버퍼 쓰기
        stream.Flush();
    }
}

 

4.7서버 실행 

• 서버 실행 버튼을 클릭하면 4.5에서 작성한 InitSocket() 메서드가 Thread에 등록되어 실행된다.

/// <summary>
/// 서버 실행 버튼 클릭 이벤트
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btnConnect_Click(object sender, EventArgs e)
{
    Thread thread1 = new Thread(InitSocket);
    thread1.IsBackground = true;
    thread1.Start();
}

 

4.8 메세지 전송

• 전송 버튼을 클릭하면 Server에 접속중인 Client 모두에게 메시지를 발송한다.

/// <summary>
/// 전송 버튼 클릭 이벤트
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btnSendMessage_Click(object sender, EventArgs e)
{
    string userName = "Admin";
    string message = txtMessage.Text.Trim();
    string displayMessage = "[" + userName + "] : " + message;

    DisplayText(displayMessage);
    SendMessageAll(message, userName, true); // 모든 Client에게 전송
}

 

4.9 실행 결과

• 실행 결과는 아래 이미지와 같다.
• IP 주소 TextBox에는 실행한 PC나 서버의 IP가 출력된다.

실행 결과

 

4.10 전체 소스코드

• TCP_Server 코드

using System.Net;
using System.Net.Sockets;
using System.Text;
using TCPIP_Server;

namespace TCP_Server
{
    public partial class Form1 : Form
    {
        TcpListener server = null; // 서버
        TcpClient clientSocket = null; // 소켓

        string date; // 날짜
        private Dictionary<TcpClient, string> clientList = new Dictionary<TcpClient, string>(); // 각 클라이언트 마다 리스트에 추가
        private int PORT = 5000; // 포트 정보

        public Form1()
        {
            InitializeComponent();
        }

        /// <summary>
        /// Form Load 이벤트
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void Form1_Load(object sender, EventArgs e)
        {
            InitForm();
            this.Text = "Server";
            txtIP.Text = "";
            txtIP.Text = GetLocalIP();
            txtPort.Text = PORT.ToString();
        }

        private void InitForm()
        {
            txtIP.Text = "";
            txtPort.Text = "";
            txtMessage.Text = "";
            richTextBox1.Text = "";
            listBox1.Items.Clear();
        }

        /// <summary>
        /// IP 가져오기
        /// </summary>
        /// <returns></returns>
        private string GetLocalIP()
        {
            IPHostEntry host = Dns.GetHostEntry(Dns.GetHostName());

            string localIP = string.Empty;

            for (int i = 0; i < host.AddressList.Length; i++)
            {
                if (host.AddressList[i].AddressFamily == AddressFamily.InterNetwork)
                {
                    localIP = host.AddressList[i].ToString();
                    break;
                }
            }

            return localIP;
        }

        /// <summary>
        /// 서버 실행 버튼 클릭 이벤트
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnConnect_Click(object sender, EventArgs e)
        {
            Thread thread1 = new Thread(InitSocket);
            thread1.IsBackground = true;
            thread1.Start();
        }

        /// <summary>
        /// Socket 초기화
        /// </summary>
        private void InitSocket()
        {
            server = new TcpListener(IPAddress.Parse(txtIP.Text), int.Parse(txtPort.Text)); // 서버 객체 생성 및 IP주소와 Port번호를 할당
            clientSocket = default(TcpClient); // 소켓 설정
            server.Start(); // 서버 시작
            DisplayText("System : Server 시작");

            while (true)
            {
                try
                {
                    clientSocket = server.AcceptTcpClient(); // client 소켓 접속 허용
                    
                    NetworkStream stream = clientSocket.GetStream();
                    byte[] buffer = new byte[1024]; // 버퍼
                    int bytes = stream.Read(buffer, 0, buffer.Length);
                    string userName = Encoding.Unicode.GetString(buffer, 0, bytes);
                    userName = userName.Substring(0, userName.IndexOf("$")); // client 사용자 명
                    DisplayText("System : [" + userName + "] 접속");
                    
                    clientList.Add(clientSocket, userName); // cleint 리스트에 추가
                    SendMessageAll(userName + " 님이 입장하셨습니다.", "", false); // 모든 client에게 메세지 전송
                    SetUserList(userName, "I");

                    HandleClient h_client = new HandleClient(); // 클라이언트 추가
                    h_client.OnReceived += new HandleClient.MessageDisplayHandler(OnReceived);
                    h_client.OnDisconnected += new HandleClient.DisconnectedHandler(h_client_OnDisconnected);
                    h_client.startClient(clientSocket, clientList);
                }
                catch (SocketException se) { break; }

                catch (Exception ex) { break; }
            }

            clientSocket.Close(); // client 소켓 닫기

            server.Stop(); // 서버 종료
        }

        /// <summary>
        /// Cleint 접속 해제 핸들러
        /// </summary>
        /// <param name="clientSocket">Client 정보</param>
        private void h_client_OnDisconnected(TcpClient clientSocket)
        {
            if (clientList.ContainsKey(clientSocket))
            {
                clientList.Remove(clientSocket);
            }
        }

        /// <summary>
        /// Cleint로 부터 받은 데이터
        /// </summary>
        /// <param name="message">메세지</param>
        /// <param name="userName">사용자명</param>
        private void OnReceived(string message, string userName)
        {
            if (message.Equals("LeaveChat"))
            {
                string displayMessage = "Leave user : " + userName;

                DisplayText(displayMessage);
                SendMessageAll("LeaveChat", userName, true);
                SetUserList(userName, "D");
            }
            else
            {
                string displayMessage = "From Client : " + userName + " : " + message;
                DisplayText(displayMessage); // Server단에 출력
                SendMessageAll(message, userName, true); // 모든 Client에게 전송
            }
        }

        /// <summary>
        /// 메세지 전송
        /// </summary>
        /// <param name="message">메세지</param>
        /// <param name="userName">Client</param>
        /// <param name="flag">구분자(True: 전체전송, False: 개별전송)</param>
        public void SendMessageAll(string message, string userName, bool flag)
        {
            foreach (var pair in clientList)
            {
                date = DateTime.Now.ToString("yyyy.MM.dd. HH:mm:ss"); // 현재 날짜 받기

                TcpClient client = pair.Key as TcpClient;
                NetworkStream stream = client.GetStream();
                byte[] buffer = null;

                if (flag)
                {
                    if (message.Equals("LeaveChat"))
                        buffer = Encoding.Unicode.GetBytes(userName + " 님이 대화방을 나갔습니다.");
                    else
                        buffer = Encoding.Unicode.GetBytes("[ " + date + " ] " + userName + " : " + message);
                }
                else
                {
                    buffer = Encoding.Unicode.GetBytes(message);
                }
                stream.Write(buffer, 0, buffer.Length); // 버퍼 쓰기
                stream.Flush();
            }
        }

        /// <summary>
        /// 화면에 Text 출력
        /// </summary>
        /// <param name="text"></param>
        private void DisplayText(string text)
        {
            richTextBox1.Invoke((MethodInvoker)delegate { richTextBox1.AppendText(text + "\r\n"); }); // 데이터를 수신창에 표시, 데이터 충돌을 피하기 위해 Invoke 사용
            richTextBox1.Invoke((MethodInvoker)delegate { richTextBox1.ScrollToCaret(); });  // 스크롤을 제일 아래로 설정
        }

        /// <summary>
        /// 접속 Client 출력
        /// </summary>
        /// <param name="userName">사용자명</param>
        /// <param name="div">구분(I: 입력, D: 삭제)</param>
        private void SetUserList(string userName, string div)
        {
            try
            {
                if (div.Equals("I"))
                    listBox1.Items.Add(userName);
                else if (div.Equals("D"))
                    listBox1.Items.Remove(userName);

            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.ToString());
            }
        }

        /// <summary>
        /// 전송 버튼 클릭 이벤트
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSendMessage_Click(object sender, EventArgs e)
        {
            string userName = "Admin";
            string message = txtMessage.Text.Trim();
            string displayMessage = "[" + userName + "] : " + message;

            DisplayText(displayMessage);
            SendMessageAll(message, userName, true); // 모든 Client에게 전송
        }
    }
}

• HandleClient 코드

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Net.Sockets;
using System.Text;
using System.Threading.Tasks;

namespace TCPIP_Server
{
    internal class HandleClient
    {
        TcpClient clientSocket = null;
        public Dictionary<TcpClient, string> clientList = null;

        public void startClient(TcpClient clientSocket, Dictionary<TcpClient, string> clientList)
        {
            this.clientSocket = clientSocket;
            this.clientList = clientList;

            Thread t_hanlder = new Thread(doChat);
            t_hanlder.IsBackground = true;
            t_hanlder.Start();
        }

        public delegate void MessageDisplayHandler(string message, string userName);
        public event MessageDisplayHandler OnReceived;

        public delegate void DisconnectedHandler(TcpClient clientSocket);
        public event DisconnectedHandler OnDisconnected;

        private void doChat()
        {
            NetworkStream stream = null;
            try
            {
                byte[] buffer = new byte[1024];
                string msg = string.Empty;
                int bytes = 0;
                int MessageCount = 0;

                while (true)
                {
                    MessageCount++;
                    stream = clientSocket.GetStream();
                    bytes = stream.Read(buffer, 0, buffer.Length);
                    msg = Encoding.Unicode.GetString(buffer, 0, bytes);
                    msg = msg.Substring(0, msg.IndexOf("$"));

                    if (OnReceived != null)
                        OnReceived(msg, clientList[clientSocket].ToString());
                }
            }
            catch (SocketException se)
            {
                Trace.WriteLine(string.Format("DoChat - SocketException : {0}", se.Message));

                if (clientSocket != null)
                {
                    if (OnDisconnected != null)
                        OnDisconnected(clientSocket);

                    clientSocket.Close();
                    stream.Close();
                }
            }
            catch (Exception ex)
            {
                Trace.WriteLine(string.Format("DoChat - Exception : {0}", ex.Message));

                if (clientSocket != null)
                {
                    if (OnDisconnected != null)
                        OnDisconnected(clientSocket);

                    clientSocket.Close();
                    stream.Close();
                }
            }
        }
    }
}

 

※ TCP Client 구현은 아래 게시글 참고

[C#] TCP 채팅 프로그램 #2 Client 구현

---

C# 윈폼 - TCP/IP 네트워크 통신을 뚫어보자

C# 소켓 프로그래밍 - 비동기 채팅 프로그램 만들기 (1:n 통신)

[Program C#] 서버-클라이언트 채팅 통신

TCP 클라이언트 - C# 프로그래밍 배우기 (Learn C# Programming)

[C#] TCP 소켓 통신