.NET 5 网络编程变更：SendToAsync 后 LocalEndPoint 属性更新解析

.NET 5 网络编程变更：SendToAsync 后 LocalEndPoint 属性更新解析

docs This repository contains .NET Documentation. 项目地址: https://gitcode.com/gh_mirrors/docs2/docs

前言

在 .NET 5 中，Socket 类的异步发送方法 SendToAsync 的行为发生了一个重要变化，这个变化可能会影响到现有的网络应用程序。本文将详细解析这一变更的背景、原因以及开发者需要注意的事项。

变更概述

在 .NET 5 之前，当调用 Socket.SendToAsync 方法发送数据时，Socket 实例的 LocalEndPoint 属性值不会发生变化。然而从 .NET 5 开始，当 SendToAsync 操作成功完成后，LocalEndPoint 属性会被更新为套接字隐式绑定的本地地址。

技术细节

旧版本行为

在 .NET Core 3.1 及更早版本中：

var socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
// LocalEndPoint 初始为 null
Console.WriteLine(socket.LocalEndPoint); // 输出: null

var args = new SocketAsyncEventArgs();
args.RemoteEndPoint = new IPEndPoint(IPAddress.Loopback, 1234);
args.SetBuffer(new byte[10], 0, 10);
socket.SendToAsync(args);

// 即使 SendToAsync 完成，LocalEndPoint 仍为 null
Console.WriteLine(socket.LocalEndPoint); // 输出: null

.NET 5 新行为

在 .NET 5 及更高版本中：

var socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
// LocalEndPoint 初始为 null
Console.WriteLine(socket.LocalEndPoint); // 输出: null

var args = new SocketAsyncEventArgs();
args.RemoteEndPoint = new IPEndPoint(IPAddress.Loopback, 1234);
args.SetBuffer(new byte[10], 0, 10);
socket.SendToAsync(args);

// SendToAsync 完成后，LocalEndPoint 被更新为实际绑定的本地地址
Console.WriteLine(socket.LocalEndPoint); // 输出类似: 0.0.0.0:54321

变更原因

这一变更是为了修复一个长期存在的行为不一致问题。在之前的版本中：

1. Socket.SendTo 方法会更新 LocalEndPoint
2. Socket.BeginSendTo/EndSendTo 方法也会更新 LocalEndPoint
3. 但 Socket.SendToAsync 方法却不会更新 LocalEndPoint

这种不一致性可能导致开发者困惑，特别是当他们在代码中混合使用这些方法时。.NET 5 通过统一这些方法的行为，使 API 更加一致和可预测。

对现有代码的影响

如果你的应用程序有以下情况，可能会受到此变更的影响：

1. 代码假设 LocalEndPoint 在 SendToAsync 调用后保持不变
2. 依赖 LocalEndPoint 为 null 来判断套接字是否已绑定
3. 在 SendToAsync 调用前后比较 LocalEndPoint 值

迁移建议

为了确保代码在 .NET 5 及更高版本中正常工作，建议进行以下调整：

1. 不要依赖 LocalEndPoint 保持不变：如果你需要原始值，应在调用 SendToAsync 前保存它
2. 更新状态检查逻辑：如果之前使用 LocalEndPoint == null 判断套接字状态，可能需要改用其他方式
3. 测试边界情况：特别是在套接字重用或连接池场景中

实际应用场景

考虑一个 UDP 服务器实现：

public class UdpServer
{
    private Socket _socket;
    
    public void Start()
    {
        _socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
        // 在 .NET 5 前，这里可以安全地检查 LocalEndPoint
        // 但在 .NET 5 后，第一次 SendToAsync 后就会改变
        if (_socket.LocalEndPoint == null)
        {
            Console.WriteLine("Socket not bound yet");
        }
        
        // 发送初始化数据包
        var args = new SocketAsyncEventArgs();
        args.RemoteEndPoint = new IPEndPoint(IPAddress.Broadcast, 12345);
        args.SetBuffer(Encoding.ASCII.GetBytes("INIT"), 0, 4);
        args.Completed += OnSendCompleted;
        _socket.SendToAsync(args);
    }
    
    private void OnSendCompleted(object sender, SocketAsyncEventArgs e)
    {
        // 在 .NET 5 后，这里 _socket.LocalEndPoint 已经被设置
        Console.WriteLine($"Socket is now bound to {_socket.LocalEndPoint}");
    }
}

在 .NET 5 中，上述代码的行为会发生变化，开发者需要根据实际情况调整逻辑。

总结

.NET 5 对 Socket.SendToAsync 方法的这一变更是为了统一套接字 API 的行为，虽然它可能破坏一些现有代码，但从长远来看，这种一致性改进对框架的健康发展和开发者的使用体验都是有益的。作为开发者，理解这些变更并相应调整代码，可以确保应用程序在不同 .NET 版本间的兼容性和稳定性。

对于需要跨多个 .NET 版本工作的代码，建议添加版本检查或使用条件编译来处理这些行为差异。

docs This repository contains .NET Documentation. 项目地址: https://gitcode.com/gh_mirrors/docs2/docs