DoconutHost

La raíz de composición para System.Web

DoconutHost (namespace Doconut) es una clase estática que posee los servicios de Doconut para todo el proceso de trabajo. Las aplicaciones ASP.NET Core construyen esos servicios dentro del propio contenedor del framework; el ASP.NET clásico no tiene contenedor, por lo que DoconutHost crea uno y lo mantiene. El manejador DocImage.axd y el módulo de recursos resuelven todo lo que necesitan de él, y también lo hace su código.

MiembroPropósito
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null)Construye los servicios — una vez
static IServiceProvider Services { get; }El contenedor construido
static bool IsInitialized { get; }true una vez Initialize se haya ejecutado
static void Shutdown()Detiene el trabajo en segundo plano y elimina el contenedor

Inicializar

Llámelo desde Application_Start en Global.asax.cs:

csharp
// Global.asax.cs, Application_Start - una vez por proceso de trabajo. Una segunda llamada no hace nada:
// las opciones de la primera llamada ganan.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // Opcional. Se ejecuta después de los registros propios de Doconut y antes de que se construya el contenedor,
        // para que pueda agregar servicios o reemplazar uno registrado por Doconut.
        services.AddMemoryCache();
    });
  • configure recibe las OpcionesDoconut: licencia, interruptores de seguridad, complementos, widgets.
  • configureServices es opcional. Se ejecuta después de que Doconut haya registrado sus propios servicios y antes de que se construya el contenedor, por lo que puede agregar servicios — AddDoconutDistributed para una granja web es el habitual — o reemplazar un registro que Doconut haya hecho.

La primera llamada gana. Initialize es idempotente: una segunda llamada devuelve inmediatamente, y ninguno de sus delegados se ejecuta. Eso mantiene inofensivo un Application_Start duplicado, pero también significa que la configuración no puede cambiarse llamando a Initialize de nuevo — recicle el grupo de aplicaciones en su lugar.

Una excepción lanzada aquí — un complemento sin licencia, opciones inválidas, una configuración de granja incompleta — ocurre dentro de Application_Start. ASP.NET entonces responde a cada solicitud con un 500 vacío, y la excepción se registra solo en el registro de eventos de Windows (registro de Aplicación, origen ASP.NET).

Servicios e IsInitialized

System.Web no tiene inyección de constructor para controladores, páginas o manejadores, por lo que resuelva los servicios de Doconut donde los use:

csharp
// System.Web no tiene inyección por constructor: resuelve los servicios de Doconut donde los uses.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

// Registrado solo cuando el plugin Converter está (ver la página del plugin).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();

Services lanza InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.) cuando se lee antes de Initialize. El código que pueda ejecutarse antes — un módulo, un constructor estático — puede comprobar IsInitialized primero.

Lo que su código típicamente resuelve:

ServicioDuraciónRol
ViewerTransitorioAbrir, cerrar, anotaciones, ayudantes de recursos — ver Visor
DocumentConverterTransitorioConversión — siempre registrado; resolverlo sin el complemento Converter lanza un InvalidOperationException que nombra el complemento a agregar
DocumentSignerTransitorioFirma — requiere el complemento Signer (ver Complemento de firmante)
IDoconutLicenseServiceÚnicoLa licencia cargada y sus capacidades — ver Licencias
DoconutOptionsÚnicoLas opciones pasadas a Initialize
HealthCheckServiceÚnicoEjecuta la verificación de salud "doconut" (abajo)

Resuelva desde DoconutHost.Services, nunca desde un contenedor propio. Registrar Doconut en otro contenedor crea un segundo conjunto de servicios separado que el manejador y el módulo nunca ven: los documentos abiertos a través de él son desconocidos para DocImage.axd.

Apagado

csharp
// Global.asax.cs, Application_End - detiene el trabajo en segundo plano y libera el contenedor.
// Seguro de llamar dos veces, y seguro cuando Initialize nunca se ejecutó.
Doconut.DoconutHost.Shutdown();

Shutdown detiene el trabajo en segundo plano de Doconut (usado por el modo distribuido) y elimina el contenedor. Es seguro llamarlo dos veces, y seguro cuando Initialize nunca se ejecutó — por ejemplo cuando el grupo de aplicaciones se recicla antes de la primera solicitud.

Verificación de salud

Doconut registra una verificación de salud llamada "doconut" que informa el estado de la licencia. El ASP.NET clásico no tiene un punto final de verificación de salud propio, así que expóngalo desde un controlador:

csharp
// GET /Health - Doconut registra una comprobación de salud "doconut" que informa el estado de la licencia:
// Saludable (válida), Degradada (prueba o sin archivo de licencia), No saludable (rechazada o expirada).
public async Task<ActionResult> Index()
{
    var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
    HealthReport report = await health.CheckHealthAsync();

    Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
    return Content(report.Status.ToString(), "text/plain");
}
EstadoSignificado
HealthyUna licencia válida está cargada
DegradedPrueba, o no se encontró archivo de licencia
UnhealthyLa licencia fue rechazada (por ejemplo, un archivo editado) o ha expirado

Los métodos de extensión de ASP.NET Core

El paquete también contiene UseDoconut() y UseDoconutResources(), las extensiones del pipeline de ASP.NET Core, porque comparte su código con los paquetes de ASP.NET Core. En este paquete ambos están marcados [Obsolete] y no se usan: una aplicación System.Web no tiene pipeline de solicitudes al que agregarlos. Sus reemplazos son los dos registros Web.config de Instalación:

ASP.NET Core.NET Framework 4.7.2
builder.Services.AddDoconut(...)DoconutHost.Initialize(...) en Application_Start
app.UseDoconut()Doconut.DocImageHandler en DocImage.axd en Web.config
app.UseDoconutResources()Doconut.DoconutResourceModule en Web.config
Inyección de constructorDoconutHost.Services.GetRequiredService<T>()
Apagado del hostDoconutHost.Shutdown() en Application_End

¿Fue útil esta página?