你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

在 .NET 中自定义 Web 角色或辅助角色的生命周期

项目
10/17/2024

重要

从 2024 年 9 月 1 日开始，已弃用所有客户的云服务（经典版）。从 2024 年 10 月开始，Microsoft 将停止并关闭任何正在运行的现有部署，数据将永久性丢失。新部署应使用基于 Azure 资源管理器的新型部署模型 Azure 云服务（外延支持）。

在创建辅助角色时，需要扩展 RoleEntryPoint 类，重写该类提供的方法可以响应生命周期事件。此类对于 Web 角色而言是可选的，因此必须将它用于响应生命周期事件。

扩展 RoleEntryPoint 类

RoleEntryPoint 类包含由 Azure 在启动、运行或停止 Web 角色或辅助角色时调用的方法。可以选择重写这些方法来管理角色初始化、角色关闭序列或角色执行线程。

在扩展 RoleEntryPoint 时，应该了解方法的以下行为：

OnStart 方法会返回一个布尔值，因此，可以从此方法返回 false。

如果代码返回 false，则该角色进程将突然终止，而不会运行可能拥有的任何关闭序列。一般来说，应该避免从 OnStart 方法返回 false 。
RoleEntryPoint 方法重载中未捕获的任何异常都被视为未经处理的异常。

如果某个生命周期方法中发生异常，则 Azure 将引发 UnhandledException 事件，然后进程终止。角色脱机后，Azure 会重启它。如果出现未经处理的异常，则不会引发 Stopping 事件，并且不会调用 OnStop 方法。

如果角色未启动，或者在初始化、繁忙和停止状态之间循环，可能是因为每次角色重启生命周期事件时，代码都可能引发未经处理的异常。在这种情况下，请使用 UnhandledException 事件确定异常的原因并采用适当的方法进行处理。角色也可能会从 Run 方法返回，从而促使角色重启。有关部署状态的详细信息，请参阅导致角色回收的常见问题。

注意

如果当前使用 Azure Tools for Microsoft Visual Studio 开发应用程序，则角色项目模板将自动在 WebRole.cs 和 WorkerRole.cs 文件中扩展 RoleEntryPoint 类。

OnStart 方法

当 Azure 使角色实例联机时，就会调用 OnStart 方法。 OnStart 代码执行时，角色实例被标记为“繁忙”，并且负载均衡器不会将任何外部流量引导到该角色。可以重写此方法以执行初始化工作，例如实现事件处理程序和启动 Azure 诊断。

如果 OnStart 返回 true，则该实例已成功初始化，并且 Azure 已调用 RoleEntryPoint.Run 方法。如果 OnStart 返回 false，则角色将立即终止，而不执行任何计划中的关闭序列。

下面的代码示例演示如何重写 OnStart 方法。当角色实例启动并设置将日志记录数据传输到存储帐户时，此方法将配置并启动诊断监视器：

public override bool OnStart()
{
    var config = DiagnosticMonitor.GetDefaultInitialConfiguration();

    config.DiagnosticInfrastructureLogs.ScheduledTransferLogLevelFilter = LogLevel.Error;
    config.DiagnosticInfrastructureLogs.ScheduledTransferPeriod = TimeSpan.FromMinutes(5);

    DiagnosticMonitor.Start("DiagnosticsConnectionString", config);

    return true;
}

OnStop 方法

OnStop 方法在 Azure 使角色实例脱机之后并且在进程退出之前被调用。可以重写此方法调用角色实例所需的代码，从而彻底关闭此角色实例。

重要

如果出于某些原因而不是用户启动的关闭而调用 OnStop 方法，则此方法中运行的代码必须在有限的时间内完成。这段时间过后，进程将被终止，因此，必须确保 OnStop 方法中的代码能够快速运行或者不必完全运行。引发 Stopping 事件后，会调用 OnStop 方法。

Run 方法

可以重写 Run 方法，为角色实例实现长时间运行的线程。

重写 Run 方法不是必需的；默认实现可以启动一个永远休眠的线程。如果重写 Run 方法，则代码可能会被无限期阻止。如果 Run 方法返回，角色会自动回收；也就是说，Azure 将引发 Stopping 事件并调用 OnStop 方法，因此，在角色脱机之前可能执行了关闭序列。

为 Web 角色实现 ASP.NET 生命周期方法

除了 RoleEntryPoint 类提供的方法以外，还可以使用 ASP.NET 生命周期方法来管理 Web 角色的初始化和关闭序列。如果要将现有的 ASP.NET 应用程序迁移到 Azure，此方法可能有利于解决兼容性问题。 ASP.NET 生命周期方法将从 RoleEntryPoint 方法中调用。 Application_Start 方法将在 RoleEntryPoint.OnStart 方法结束后调用，而 Application_End 方法将在 RoleEntryPoint.OnStop 方法调用前调用。

后续步骤

了解如何创建云服务包。

通过