使用 async/await 的异步 TcpListener 的正确方法

Question

我一直在思考什么是使用异步编程设置TCP服务器的正确方法。

通常我会为每个传入请求生成一个线程，但我想充分利用 ThreadPool，所以当连接空闲时，没有阻塞线程。

首先，我将创建侦听器并开始接受客户端，在本例中，是在控制台应用程序中：

static void Main(string[] args)
{
    CancellationTokenSource cancellation = new CancellationTokenSource();
    var endpoint = new IPEndPoint(IPAddress.Parse("127.0.0.1"), 8001);
    TcpListener server = new TcpListener(endpoint); 

    server.Start();
    var task = AcceptTcpClients(server, cancellation.Token);

    Console.ReadKey(true);
    cancellation.Cancel();
    await task;
    Console.ReadKey(true);
}

在该方法中，我会循环接受传入的请求并生成一个新任务来处理连接，因此循环可以返回以接受更多客户端：

static async Task AcceptTcpClients(TcpListener server, CancellationToken token)
{
    while (!token.IsCancellationRequested)
    {
        var ws = await server.AcceptTcpClientAsync();

        Task.Factory.StartNew(async () =>
        {
            while (ws.IsConnected && !token.IsCancellationRequested)
            {
                String msg = await ws.ReadAsync();
                if (msg != null)
                    await ws.WriteAsync(ProcessResponse(msg));
            }
        }, token);
    }
 }

创建新任务并不一定意味着新线程，但这是正确的方法吗？我是在利用 ThreadPool 还是我能做些什么？

这种方法有什么潜在的缺陷吗？

Answer 1

Main 中的 await task; 无法编译；如果你想阻止它，你必须使用task.Wait();。

此外，您应该在异步编程中使用Task.Run 而不是Task.Factory.StartNew。

创建新Task并不一定意味着新线程，但这是否正确？

您当然可以启动单独的任务（使用Task.Run）。虽然你没有有。您可以轻松调用单独的 async 方法来处理各个套接字连接。

不过，您的实际套接字处理存在一些问题。 Connected 属性实际上是无用的。您应该始终不断地从连接的套接字读取，即使您正在写入它。此外，您应该编写“keepalive”消息或读取超时，以便您可以检测到半开的情况。我维护了一个 TCP/IP .NET FAQ 来解释这些常见问题。

我真的强烈建议人们不要编写 TCP/IP 服务器或客户端。有吨的陷阱。如果可能的话，自托管 WebAPI 和/或 SignalR 会好得多。

Answer 2

为了优雅地停止服务器接受循环，我注册了一个回调，该回调在取消取消标记时停止侦听 (cancellationToken.Register(listener.Stop);)。

这将在await listener.AcceptTcpClientAsync(); 上抛出一个易于捕获的 SocketException。

不需要Task.Run(HandleClient())，因为调用异步方法会返回一个并行运行的任务。

    public async Task Run(CancellationToken cancellationToken)
    {
        TcpListener listener = new TcpListener(address, port);
        listener.Start();
        cancellationToken.Register(listener.Stop);
        while (!cancellationToken.IsCancellationRequested)
        {
            try
            {
                TcpClient client = await listener.AcceptTcpClientAsync();
                var clientTask = protocol.HandleClient(client, cancellationToken)
                    .ContinueWith(antecedent => client.Dispose())
                    .ContinueWith(antecedent => logger.LogInformation("Client disposed."));
            }
            catch (SocketException) when (cancellationToken.IsCancellationRequested)
            {
                logger.LogInformation("TcpListener stopped listening because cancellation was requested.");
            }
            catch (Exception ex)
            {
                logger.LogError(new EventId(), ex, $"Error handling client: {ex.Message}");
            }
        }
    }