DoconutHost

La radice di composizione per System.Web

DoconutHost (namespace Doconut) è una classe statica che possiede i servizi di Doconut per l'intero processo worker. Le applicazioni ASP.NET Core costruiscono quei servizi nel contenitore proprio del framework; il classico ASP.NET non ha contenitore, quindi DoconutHost ne costruisce uno e lo mantiene. Il gestore DocImage.axd e il modulo di risorse risolvono tutto ciò di cui hanno bisogno da esso, così come il tuo codice.

MembroScopo
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null)Costruisce i servizi — una sola volta
static IServiceProvider Services { get; }Il contenitore costruito
static bool IsInitialized { get; }true una volta che Initialize è stato eseguito
static void Shutdown()Interrompe il lavoro in background e rilascia il contenitore

Inizializzazione

Chiamala da Application_Start in Global.asax.cs:

csharp
// Global.asax.cs, Application_Start - una volta per processo worker. Una seconda chiamata è un'operazione nulla:
// le opzioni della prima chiamata vincono.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // Facoltativo. Viene eseguito dopo le registrazioni di Doconut e prima che il contenitore sia costruito,
        // in modo che possa aggiungere servizi o sostituire un servizio registrato da Doconut.
        services.AddMemoryCache();
    });
  • configure riceve le DoconutOptions: licenza, interruttori di sicurezza, plugin, widget.
  • configureServices è opzionale. Viene eseguito dopo che Doconut ha registrato i propri servizi e prima che il contenitore sia costruito, così può aggiungere servizi — AddDoconutDistributed per un web farm è quello usuale — o sostituire una registrazione fatta da Doconut.

La prima chiamata vince. Initialize è idempotente: una seconda chiamata ritorna immediatamente, e nessuno dei suoi delegati viene eseguito. Questo mantiene un Application_Start duplicato innocuo, ma significa anche che la configurazione non può essere cambiata chiamando nuovamente Initialize — ricicla invece il pool di applicazioni.

Un'eccezione lanciata qui — un plugin senza licenza, opzioni non valide, una configurazione di farm incompleta — avviene all'interno di Application_Start. ASP.NET risponde quindi a ogni richiesta con un 500 vuoto, e l'eccezione viene registrata solo nel registro eventi di Windows (registro Applicazione, origine ASP.NET).

Servizi e IsInitialized

System.Web non ha iniezione tramite costruttore per controller, pagine o gestori, quindi risolvi i servizi di Doconut dove li utilizzi:

csharp
// System.Web non supporta l'iniezione tramite costruttore: risolvi i servizi Doconut dove li utilizzi.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

// Registrato solo quando il plugin Converter è (vedi la pagina del plugin).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();

Services lancia InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.) quando viene letto prima di Initialize. Il codice che può essere eseguito prima — un modulo, un costruttore statico — può controllare IsInitialized per primo.

Ciò che il tuo codice tipicamente risolve:

ServizioDurataRuolo
ViewerTransienteApri, chiudi, annotazioni, helper di risorse — vedi Viewer
DocumentConverterTransienteConversione — sempre registrata; risolverla senza il plugin Converter lancia un InvalidOperationException che indica il plugin da aggiungere
DocumentSignerTransienteFirma — richiede il plugin Signer (vedi Signer Plugin)
IDoconutLicenseServiceSingletonLa licenza caricata e le sue capacità — vedi Licensing
DoconutOptionsSingletonLe opzioni passate a Initialize
HealthCheckServiceSingletonEsegue il controllo di integrità "doconut" (di seguito)

Risolvi da DoconutHost.Services, mai da un contenitore tuo. Registrare Doconut in un altro contenitore crea un secondo set separato di servizi che il gestore e il modulo non vedono mai: i documenti aperti tramite esso sono sconosciuti a DocImage.axd.

Arresto

csharp
// Global.asax.cs, Application_End - interrompe il lavoro in background e rilascia il contenitore.
// Sicuro da chiamare due volte, e sicuro quando Initialize non è mai stato eseguito.
Doconut.DoconutHost.Shutdown();

Shutdown interrompe il lavoro in background di Doconut (usato dalla modalità distribuita) e rilascia il contenitore. È sicuro chiamarlo due volte, e sicuro quando Initialize non è mai stato eseguito — per esempio quando il pool di applicazioni ricicla prima della prima richiesta.

Controllo di integrità

Doconut registra un controllo di integrità chiamato "doconut" che riporta lo stato della licenza. Il classico ASP.NET non ha un endpoint di controllo di integrità proprio, quindi esponilo da un controller:

csharp
// GET /Health - Doconut registra un controllo di salute "doconut" che riporta lo stato della licenza:
// Sano (valido), Degradato (trial o nessun file di licenza), Non sano (rifiutato o scaduto).
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");
}
StatoSignificato
HealthyÈ stata caricata una licenza valida
DegradedProva, o nessun file di licenza trovato
UnhealthyLa licenza è stata rifiutata (ad esempio, un file modificato) o è scaduta

I metodi di estensione ASP.NET Core

Il pacchetto contiene anche UseDoconut() e UseDoconutResources(), le estensioni della pipeline ASP.NET Core, perché condivide il suo codice con i pacchetti ASP.NET Core. In questo pacchetto entrambi sono contrassegnati [Obsolete] e non sono usati: un'applicazione System.Web non ha una pipeline di richieste a cui aggiungerli. I loro sostituti sono le due registrazioni Web.config da Installation:

ASP.NET Core.NET Framework 4.7.2
builder.Services.AddDoconut(...)DoconutHost.Initialize(...) in Application_Start
app.UseDoconut()Doconut.DocImageHandler on DocImage.axd in Web.config
app.UseDoconutResources()Doconut.DoconutResourceModule in Web.config
Iniezione tramite costruttoreDoconutHost.Services.GetRequiredService<T>()
Arresto dell'hostDoconutHost.Shutdown() in Application_End

Questa pagina è stata utile?