如何为C# .NET 6 TCP服务器添加REST接口与Web服务？

思路确认 #

你的方向是对的，ASP.NET Core的MVC/Web API框架确实是.NET生态里实现REST端点的标准方案。你提到的MVC思路本质上和Web API控制器模式一致，Web API就是MVC在接口场景下的轻量化适配，完全适合你的需求。

最佳实现方式 #

在.NET 6里，有两种主流方案可以快速整合到你的现有TCP服务器项目中：

1. 最小API（推荐简单场景） #

最小API是.NET 6新增的轻量级特性，无需控制器，直接在Program.cs里定义端点，代码简洁，适合快速实现简单的REST接口。

步骤：

• 修改项目配置：把项目文件（.csproj）里的<Project Sdk="Microsoft.NET.Sdk">替换为<Project Sdk="Microsoft.NET.Sdk.Web">，这样会自动引入ASP.NET Core的依赖包。
• 整合Web主机与TCP服务器：在Program.cs中同时启动Web服务和你的TCP服务器，示例代码如下：

var builder = WebApplication.CreateBuilder(args);

// 注册TCP服务器为后台服务，便于生命周期管理和依赖注入
builder.Services.AddHostedService<TcpServerHostedService>();

var app = builder.Build();

// 定义获取连接客户端的REST端点
app.MapGet("/api/connected-clients", (TcpServerHostedService tcpServer) =>
{
    // 注意：访问客户端集合时要保证线程安全，建议用ConcurrentDictionary等线程安全容器
    var clients = tcpServer.GetConnectedClients();
    return Results.Ok(clients);
});

// 同时启动Web服务和TCP服务器
await Task.WhenAll(app.RunAsync(), tcpServer.StartAsync(CancellationToken.None));

2. Web API控制器（推荐复杂场景） #

如果后续需要扩展更复杂的接口逻辑（比如参数验证、路由分组、过滤器等），Web API控制器更合适，这就是你猜测的类似MVC的方案。

步骤：

• 同样修改项目Sdk：切换为Microsoft.NET.Sdk.Web。
• 注册控制器服务：在Program.cs中添加控制器服务注册：

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers(); // 注册控制器服务
builder.Services.AddHostedService<TcpServerHostedService>();

var app = builder.Build();

// 配置控制器路由
app.UseRouting();
app.MapControllers();

await Task.WhenAll(app.RunAsync(), tcpServer.StartAsync(CancellationToken.None));

• 创建控制器类：新增一个控制器文件，比如ClientController.cs：

[ApiController]
[Route("api/[controller]")]
public class ClientController : ControllerBase
{
    private readonly TcpServerHostedService _tcpServer;

    public ClientController(TcpServerHostedService tcpServer)
    {
        _tcpServer = tcpServer;
    }

    [HttpGet("connected")]
    public IActionResult GetConnectedClients()
    {
        var clients = _tcpServer.GetConnectedClients();
        return Ok(clients);
    }
}

关键注意事项 #

• 线程安全：TCP服务器的客户端连接集合是多线程访问的，必须用ConcurrentDictionary、ConcurrentBag等线程安全容器，或者在访问时加锁，避免并发问题。
• 后台服务封装：把TCP服务器的启动、运行逻辑封装为IHostedService实现类，这样可以通过依赖注入在API端点中安全访问，同时利用ASP.NET Core的主机生命周期管理。

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