如何为ASP.NET Generic Host实现自定义协议监听器，求相关示例与文档

首先明确你要找的组件在.NET生态里的标准定位：属于Generic Host 托管服务扩展，完整实现需要覆盖3个核心层：托管生命周期注册、协议监听服务、请求分发器。

1. 核心实现逻辑拆解 #

你提到的ConfigureWebHostDefaults、UseNServiceBus这类扩展方法本质是做3件事：

• 向Generic Host的依赖注入容器注册自定义协议所需的所有服务、配置规则
• 注册一个实现了IHostedService接口的长驻后台服务，用于持续监听协议请求（TCP/UDP套接字、消息队列客户端订阅、自定义私有协议报文解析都在这一层实现）
• 注入请求分发逻辑，将监听到的报文/事件匹配到对应的处理方法上（对应MVC里的Controller Action匹配过程）

2. 最小实现示例 #

2.1 第一步：定义自定义处理方法的标记特性 #

用来标识哪些类/方法是你的自定义协议的处理入口，类似MVC的[ApiController]、[Route]特性：

[AttributeUsage(AttributeTargets.Class)]
public class MyProtocolHandlerAttribute : Attribute
{
}

[AttributeUsage(AttributeTargets.Method)]
public class MyProtocolActionAttribute : Attribute
{
    public string ActionName { get; }
    public MyProtocolActionAttribute(string actionName) => ActionName = actionName;
}

2.2 第二步：实现协议监听托管服务 #

实现IHostedService接口，在StartAsync方法里启动监听逻辑，这里以简单的TCP监听为例：

public class MyProtocolListener : IHostedService
{
    private readonly IServiceProvider _serviceProvider;
    private TcpListener _tcpListener;
    private CancellationTokenSource _cts;

    public MyProtocolListener(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public async Task StartAsync(CancellationToken cancellationToken)
    {
        _cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
        _tcpListener = new TcpListener(System.Net.IPAddress.Any, 8088);
        _tcpListener.Start();

        // 后台运行监听循环，不阻塞Host启动
        _ = RunListenerLoop(_cts.Token);
        await Task.CompletedTask;
    }

    private async Task RunListenerLoop(CancellationToken token)
    {
        while (!token.IsCancellationRequested)
        {
            var client = await _tcpListener.AcceptTcpClientAsync(token);
            // 解析报文，获取要调用的Action名称
            using var reader = new StreamReader(client.GetStream());
            var actionName = await reader.ReadLineAsync(token);
            if (string.IsNullOrEmpty(actionName)) continue;

            // 匹配处理方法，执行调用
            await DispatchRequest(actionName, client, token);
        }
    }

    private async Task DispatchRequest(string actionName, TcpClient client, CancellationToken token)
    {
        // 扫描所有标注了MyProtocolHandlerAttribute的类，找到对应ActionName的方法
        var handlerTypes = AppDomain.CurrentDomain.GetAssemblies()
            .SelectMany(a => a.GetTypes())
            .Where(t => t.GetCustomAttribute<MyProtocolHandlerAttribute>() != null);

        foreach (var type in handlerTypes)
        {
            var method = type.GetMethods().FirstOrDefault(m => 
                m.GetCustomAttribute<MyProtocolActionAttribute>()?.ActionName == actionName);
            if (method == null) continue;

            // 从DI容器创建处理类实例
            var handlerInstance = ActivatorUtilities.CreateInstance(_serviceProvider, type);
            // 传入参数执行方法
            var result = method.Invoke(handlerInstance, new object[] { client, token });
            if (result is Task task) await task;
            break;
        }
    }

    public async Task StopAsync(CancellationToken cancellationToken)
    {
        _cts.Cancel();
        _tcpListener.Stop();
        await Task.CompletedTask;
    }
}

2.3 第三步：封装Use扩展方法 #

类似UseNServiceBus，把注册逻辑封装成扩展方法，方便使用者调用：

public static class MyProtocolHostExtensions
{
    public static IHostBuilder UseMyProtocol(this IHostBuilder hostBuilder)
    {
        return hostBuilder.ConfigureServices(services =>
        {
            // 注册监听服务
            services.AddHostedService<MyProtocolListener>();
            // 可以在这里注册你需要的全局配置、中间件等组件
        });
    }
}

2.4 使用方式 #

和你平时用ASP.NET Core、NServiceBus的方式完全一致：

// 程序入口
var host = Host.CreateDefaultBuilder(args)
    .UseMyProtocol() // 启用自定义协议
    .Build();

await host.RunAsync();

// 定义自己的处理类
[MyProtocolHandler]
public class TestHandler
{
    [MyProtocolAction("Hello")]
    public async Task HelloAction(TcpClient client, CancellationToken token)
    {
        using var writer = new StreamWriter(client.GetStream());
        await writer.WriteLineAsync("Hello from custom protocol handler!", token);
        await writer.FlushAsync(token);
    }
}

3. 生产级实现需要补充的能力 #

上面的是最小可运行实现，实际生产环境使用还需要补充以下特性：

• 报文序列化/反序列化统一处理，支持自定义序列化器
• 中间件管道，类似ASP.NET Core的中间件逻辑，可以在请求处理前后加日志、鉴权、异常处理逻辑
• 路由匹配规则优化，不要每次请求都扫描全量程序集，可以在服务启动时预构建路由表
• 全局异常捕获和统一返回格式
• 连接池、线程池优化，避免高并发下的性能问题
• 配置支持，可以通过appsettings.json配置监听端口、超时时间等参数

内容的提问来源于stack exchange，提问作者zu1b