AspComet 使用指南

AspComet 使用指南

AspComet 是一个针对 ASP.NET 的 Comet/Bayeux 实现，它允许开发者在不依赖自定义服务器的情况下实现长轮询等 Comet 技术。本指南将帮助您了解其基本结构、关键文件以及如何进行配置。

1. 项目目录结构及介绍

AspComet 的项目结构是为了便于理解和扩展设计的：

• build: 可能包含了构建脚本或者编译后的输出。
• lib: 库文件夹，可能存放着项目编译后的主要 .NET DLL 文件。
• src:
  • AspComet: 核心库源代码，包括 Comet 功能的实现。
  • Samples: 示例应用程序目录，通常包含两个子目录——Chat 和 AspCometCoreApp，分别演示了传统 ASP.NET 和 ASP.NET Core 中如何集成AspComet。
• .gitignore: 指定了Git应该忽略的文件或文件夹。
• LICENSE: 许可证文件，表明AspComet遵循MIT许可证。
• README.md: 项目的主要说明文件，包含背景信息、安装步骤和快速入门指导。

2. 项目的启动文件介绍

对于示例应用而言，启动文件取决于使用的ASP.NET版本：

• 对于基于传统ASP.NET的应用（如样品中的Chat），启动点可能是Global.asax.cs文件中的Application_Start方法。

  protected void Application_Start()
  {
      AreaRegistration.RegisterAllAreas();
      FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
      RouteConfig.RegisterRoutes(RouteTable.Routes);
      BundleConfig.RegisterBundles(BundleTable.Bundles);
      // AspComet 初始化代码
      Setup.AspComet.WithTheDefaultServices();
  }
  

• 而对于ASP.NET Core的应用，启动逻辑则在Startup.cs文件中，通过ConfigureServices和Configure方法来配置和服务初始化。

3. 项目的配置文件介绍

Web.config (对于传统的ASP.NET项目)

在传统ASP.NET项目中，AspComet需要在Web.config中配置HTTP处理器以处理COMET请求。您需要添加如下片段：

<system.web>
    <!-- AspComet配置 -->
    <httpHandlers>
        <add verb="POST" path="comet.axd" validate="false" type="AspComet.CometHttpHandler, AspComet"/>
    </httpHandlers>
</system.web>

配置服务 (ASP.NET Core 或 更新的框架)

在ASP.NET Core中，配置AspComet涉及在Startup.cs文件内的ConfigureServices和Configure方法中添加必要的服务和中间件。例如：

public void ConfigureServices(IServiceCollection services)
{
    // 添加AspCoreCometware的基本服务配置
    services.ConfigureBasicCometServices();

    // 自定义服务配置...
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 配置路由到Comet中间件
    app.MapWhen(context => context.Request.Path.ToString().Contains("/comet/..."), appBranch =>
    {
        appBranch.UseCometMiddleware(); // 替代传统的HttpHandler
        // 其他配置...
    });
}

请注意，AspComet现在处于维护模式，主要用于支持遗留系统。对于新项目，建议考虑现代技术如WebSockets。