使用 TcpClient 进行客户端通信的应用程序

在这篇文章中，我们将探讨如何使用 C# 中的 TcpClient 类来创建一个简单的客户端应用程序。这个示例程序可以连接到服务器，发送消息，并接收服务器的响应。我们将详细讨论 TcpClient 的主要属性和方法，并提供一个带有详细注释的示例代码。

`TcpClient` 类简介

TcpClient 类提供了简单的方法来连接到 TCP 网络服务。通过 TcpClient，我们可以与服务器建立连接，发送和接收数据。该类封装了 TCP 连接的创建和管理，简化了与服务器进行网络通信的过程。

主要方法

Connect(string hostname, int port): 连接到指定主机名和端口号的远程主机。
Connect(IPAddress[] ipAddresses, int port): 连接到指定 IP 地址数组和端口号的远程主机。
GetStream(): 获取用于发送和接收数据的网络流。
Close(): 关闭 TcpClient 并释放所有资源。

界面设计

示例代码

下面是一个使用 TcpClient 的简单客户端应用程序，它连接到服务器，发送消息，并接收服务器的响应。

C#
using System;
using System.Net.Sockets;
using System.Text;
using System.Windows.Forms;

public partial class Form1 : Form
{
    private TcpClient client; // TcpClient实例
    private NetworkStream stream; // 网络流，用于与服务器通信

    public Form1()
    {
        InitializeComponent();
    }

    /// <summary>
    /// 连接到服务器
    /// </summary>
    /// <param name="server">服务器IP地址或主机名</param>
    /// <param name="port">端口号</param>
    private async void ConnectToServer(string server, int port)
    {
        try
        {
            // 创建一个TcpClient实例
            client = new TcpClient();

            // 异步连接到指定的服务器IP和端口
            await client.ConnectAsync(server, port);

            // 获取与服务器通信的网络流
            stream = client.GetStream();

            // 启动一个异步任务接收来自服务器的消息
            ReceiveMessages();

            // 如果连接成功，更改窗口标题以显示已连接
            this.Text = "Connected";
        }
        catch (Exception ex)
        {
            // 如果在尝试连接过程中发生异常，显示错误消息
            MessageBox.Show($"连接服务器时出错: {ex.Message}");
        }
    }

    /// <summary>
    /// 发送消息到服务器
    /// </summary>
    /// <param name="message">要发送的消息</param>
    private async void Send(string message)
    {
        try
        {
            // 检查网络流是否已经初始化，确保我们可以发送数据
            if (stream != null)
            {
                // 将字符串消息转换为UTF-8编码的字节数组
                byte[] data = Encoding.UTF8.GetBytes(message);

                // 异步地将数据写入网络流
                // 这是发送数据到服务器的实际操作
                await stream.WriteAsync(data, 0, data.Length);
            }
        }
        catch (Exception ex)
        {
            // 如果在发送数据过程中发生异常（如连接断开），显示错误消息
            MessageBox.Show($"发送消息时出错: {ex.Message}");
        }
    }

    /// <summary>
    /// 异步接收来自服务器的消息
    /// </summary>
    private async void ReceiveMessages()
    {
        try
        {
            // 创建一个缓冲区用于接收数据
            byte[] buffer = new byte[1024];
            int numberOfBytesRead;

            // 循环读取网络流中的数据，直到没有更多数据
            while ((numberOfBytesRead = await stream.ReadAsync(buffer, 0, buffer.Length)) != 0)
            {
                // 将接收到的字节数据转换为字符串
                string receivedMessage = Encoding.UTF8.GetString(buffer, 0, numberOfBytesRead);

                // 在UI线程上安全地更新文本框以显示接收到的消息
                // 这是必要的，因为ReceiveMessages不在UI线程上运行
                Invoke(new Action(() =>
                {
                    txtDisplay.AppendText(receivedMessage + Environment.NewLine);
                }));
            }
        }
        catch (Exception ex)
        {
            // 如果在接收数据过程中发生异常（如连接断开），显示错误消息
            MessageBox.Show($"接收消息时出错: {ex.Message}");
        }
    }

    /// <summary>
    /// 发送按钮的点击事件处理
    /// </summary>
    private void btnSend_Click(object sender, EventArgs e)
    {
        Send(txtMessage.Text);
        txtMessage.Clear(); // 清空输入框
    }

    /// <summary>
    /// 连接按钮的点击事件处理
    /// </summary>
    private void btnConnect_Click(object sender, EventArgs e)
    {
        // 替换为你的服务器地址和端口
        ConnectToServer("127.0.0.1", 3001);
    }
}

代码分析

连接到服务器

C#
private async void ConnectToServer(string server, int port)
{
    try
    {
        client = new TcpClient();
        await client.ConnectAsync(server, port);
        stream = client.GetStream();
        ReceiveMessages();
        this.Text = "Connected";
    }
    catch (Exception ex)
    {
        MessageBox.Show($"Error connecting to server: {ex.Message}");
    }
}

ConnectToServer 方法用于连接到指定的服务器和端口。如果连接成功，它会启动一个异步任务来接收来自服务器的消息，并更改窗口标题以显示连接状态。

发送消息

C#
private async void Send(string message)
{
    try
    {
        if (stream != null)
        {
            byte[] data = Encoding.UTF8.GetBytes(message);
            await stream.WriteAsync(data, 0, data.Length);
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show($"Error sending message: {ex.Message}");
    }
}

Send 方法将消息发送到服务器。该方法首先将字符串消息转换为 UTF-8 编码的字节数组，然后将这些数据异步地写入网络流。

接收消息

C#
private async void ReceiveMessages()
{
    try
    {
        byte[] buffer = new byte[1024];
        int numberOfBytesRead;

        while ((numberOfBytesRead = await stream.ReadAsync(buffer, 0, buffer.Length)) != 0)
        {
            string receivedMessage = Encoding.UTF8.GetString(buffer, 0, numberOfBytesRead);

            Invoke(new Action(() =>
            {
                txtDisplay.AppendText(receivedMessage + Environment.NewLine);
            }));
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show($"Error receiving message: {ex.Message}");
    }
}

ReceiveMessages 方法异步接收来自服务器的消息。它不停地从网络流中读取数据，直到没有更多的数据可读取。接收到的数据在 UI 线程上显示出来。

结论

通过使用 TcpClient 类，我们能够轻松地创建一个能与服务器进行通信的客户端应用程序。我们详细介绍了 TcpClient 的主要属性和方法，并通过示例代码展示了如何使用这些功能来实现基本的客户端通信。希望这篇文章对你理解 TcpClient 的使用有所帮助。

目录

TcpClient 类简介