MQTTnet 服务端启动端口监听问题解析与解决方案

问题背景

在使用 MQTTnet 4.3.3.952 版本开发 ASP.NET Core 6 API 项目时，开发者尝试通过 IHostedService 接口实现 MQTT 服务端功能。虽然代码执行没有抛出异常，日志也显示服务已启动，但实际端口并未被正确监听。

问题现象

开发者使用以下代码初始化 MQTT 服务端：

var optionsBuilder = new MqttServerOptionsBuilder()
    .WithConnectionBacklog(100)
    .WithDefaultEndpointPort(87941);
    
var mMqtt = new MqttFactory(new MyLogger()).CreateMqttServer(optionsBuilder.Build());
await mMqtt.StartAsync();

尽管日志显示服务已启动，但通过系统工具检查发现指定端口(87941)并未被实际监听。

问题分析

经过深入分析，发现问题根源在于 MQTT 服务端配置不完整。MQTTnet 服务端需要明确指定端点配置才能正确启动端口监听。原始代码中缺少了两个关键配置项：

1. WithDefaultEndpoint() - 明确指定使用默认端点
2. WithDefaultEndpointBoundIPAddress() - 指定绑定的IP地址

解决方案

正确的服务端配置应包含以下关键要素：

var mqttFactory = new MqttFactory();
var mqttServerOptions = mqttFactory
    .CreateServerOptionsBuilder()
    .WithDefaultEndpoint()  // 明确启用默认端点
    .WithDefaultEndpointBoundIPAddress(IPAddress.Parse("0.0.0.0"))  // 绑定所有网络接口
    .WithDefaultEndpointPort(87941)  // 指定端口
    .Build();
    
var mMqtt = mqttFactory.CreateMqttServer(mqttServerOptions);
await mMqtt.StartAsync();

关键配置说明

1. IP地址绑定：

   • 0.0.0.0：允许从外部网络访问
   • 127.0.0.1：仅限本地访问

2. 端口配置：

   • 可自由指定任何未被占用的端口号
   • 建议使用1024以上的端口，避免系统端口冲突

最佳实践

在 ASP.NET Core 中实现 MQTT 服务端时，推荐使用 BackgroundService 模式：

public class MqttBrokerService : BackgroundService
{
    public MqttServer MqttServer { get; }
    
    public MqttBrokerService()
    {
        var mqttFactory = new MqttFactory();
        var mqttServerOptions = mqttFactory
            .CreateServerOptionsBuilder()
            .WithDefaultEndpoint()
            .WithDefaultEndpointBoundIPAddress(IPAddress.Parse("0.0.0.0"))
            .WithDefaultEndpointPort(87941)
            .Build();
            
        this.MqttServer = mqttFactory.CreateMqttServer(mqttServerOptions);
    }
    
    public override async Task StartAsync(CancellationToken cancellationToken)
    {
        await this.MqttServer.StartAsync();
        await base.StartAsync(cancellationToken);
    }
    
    // 其他必要方法...
}

总结

MQTTnet 服务端启动时，必须明确配置端点信息才能正确监听端口。通过完整配置 WithDefaultEndpoint() 和 WithDefaultEndpointBoundIPAddress() 方法，可以确保服务端按预期工作。在 ASP.NET Core 中，结合 BackgroundService 使用可以提供更稳定可靠的服务实现。