DoconutHost

Der Kompositions-Root für System.Web

DoconutHost (namespace Doconut) ist eine statische Klasse, die Doconut's Dienste für den gesamten Worker-Prozess besitzt. ASP.NET Core-Anwendungen bauen diese Dienste in den eigenen Container des Frameworks ein; klassisches ASP.NET hat keinen Container, daher baut DoconutHost einen und behält ihn. Der DocImage.axd-Handler und das Ressourcenmodul lösen alles, was sie benötigen, daraus auf, und das tut Ihr Code ebenfalls.

MitgliedZweck
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null)Erstellt die Dienste — einmal
static IServiceProvider Services { get; }Der erstellte Container
static bool IsInitialized { get; }true einmal, nachdem Initialize ausgeführt wurde
static void Shutdown()Stoppt Hintergrundarbeit und gibt den Container frei

Initialisieren

Rufen Sie es von Application_Start in Global.asax.cs auf:

csharp
// Global.asax.cs, Application_Start - einmal pro Worker-Prozess. Ein zweiter Aufruf ist ein no-op:
// Die Optionen des ersten Aufrufs gewinnen.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // Optional. Läuft nach Doconut's eigenen Registrierungen und bevor der Container gebaut wird,
        // so kann es Dienste hinzufügen oder einen von Doconut registrierten ersetzen.
        services.AddMemoryCache();
    });

Hinweis: Der Kommentar im Code wurde ins Deutsche übersetzt.

  • configure erhält die DoconutOptions: Lizenz, Sicherheitsschalter, Plugins, Widgets.
  • configureServices ist optional. Es wird ausgeführt, nachdem Doconut seine eigenen Dienste registriert hat und bevor der Container gebaut wird, sodass es Dienste hinzufügen kann — AddDoconutDistributed für einen Web-Farm ist das übliche — oder eine von Doconut vorgenommene Registrierung ersetzen.

Der erste Aufruf gewinnt. Initialize ist idempotent: ein zweiter Aufruf gibt sofort zurück, und keiner seiner Delegaten wird ausgeführt. Das hält ein dupliziertes Application_Start harmlos, bedeutet aber auch, dass die Konfiguration nicht geändert werden kann, indem man Initialize erneut aufruft — recyceln Sie stattdessen den Anwendungspool.

Eine hier ausgelöste Ausnahme — ein Plugin ohne Lizenz, ungültige Optionen, eine unvollständige Farmkonfiguration — tritt innerhalb von Application_Start auf. ASP.NET beantwortet dann jede Anfrage mit einem leeren 500, und die Ausnahme wird nur im Windows-Ereignisprotokoll (Anwendungsprotokoll, Quelle ASP.NET) aufgezeichnet.

Dienste und IsInitialized

System.Web bietet keine Konstruktorinjektion für Controller, Seiten oder Handler, daher lösen Sie Doconut's Dienste dort auf, wo Sie sie verwenden:

csharp
// System.Web hat keine Konstruktorinjektion: Auflösen von Doconut‑Diensten dort, wo Sie sie verwenden.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

// Nur registriert, wenn das Converter‑Plugin aktiv ist (siehe die Plugin‑Seite).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();

Hinweis: Der Kommentar im Code wurde ins Deutsche übersetzt.

Services wirft InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.), wenn es vor Initialize gelesen wird. Code, der früher ausgeführt werden könnte — ein Modul, ein statischer Konstruktor — kann zuerst IsInitialized prüfen.

Was Ihr Code typischerweise auflöst:

DienstLebensdauerRolle
ViewerTransientÖffnen, schließen, Anmerkungen, Ressourcenhilfen — siehe Viewer
DocumentConverterTransientKonvertierung — immer registriert; das Auflösen ohne das Converter-Plugin wirft einen InvalidOperationException, der das hinzuzufügende Plugin nennt
DocumentSignerTransientSignieren — erfordert das Signer-Plugin (siehe Signer Plugin)
IDoconutLicenseServiceSingletonDie geladene Lizenz und ihre Fähigkeiten — siehe Licensing
DoconutOptionsSingletonDie an Initialize übergebenen Optionen
HealthCheckServiceSingletonFührt den "doconut"-Gesundheitscheck (unten) aus

Lösen Sie von DoconutHost.Services auf, niemals aus einem eigenen Container. Die Registrierung von Doconut in einem anderen Container erzeugt einen zweiten, separaten Satz von Diensten, den Handler und das Modul nie sehen: über ihn geöffnete Dokumente sind DocImage.axd unbekannt.

Herunterfahren

csharp
// Global.asax.cs, Application_End - stoppt Hintergrundarbeit und gibt den Container frei.
// Sicher, zweimal aufzurufen, und sicher, wenn Initialize nie ausgeführt wurde.
Doconut.DoconutHost.Shutdown();

Hinweis: Der Kommentar im Code wurde ins Deutsche übersetzt.

Shutdown stoppt Doconut's Hintergrundarbeit (verwendet im verteilten Modus) und gibt den Container frei. Es ist sicher, es zweimal aufzurufen, und sicher, wenn Initialize nie ausgeführt wurde — zum Beispiel wenn der Anwendungspool vor der ersten Anfrage recycelt wird.

Gesundheitsprüfung

Doconut registriert einen Gesundheitscheck namens "doconut", der den Lizenzstatus meldet. Klassisches ASP.NET hat keinen eigenen Health-Check-Endpunkt, daher stellen Sie ihn über einen Controller bereit:

csharp
// GET /Health - Doconut registriert einen "doconut"-Health‑Check, der den Lizenzstatus meldet:
// Gesund (gültig), Degradiert (Testversion oder keine Lizenzdatei), Ungesund (abgelehnt oder abgelaufen).
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");
}

Hinweis: Der Kommentar im Code wurde ins Deutsche übersetzt.

StatusBedeutung
HealthyEine gültige Lizenz ist geladen
DegradedTestversion oder keine Lizenzdatei gefunden
UnhealthyDie Lizenz wurde abgelehnt (z. B. eine bearbeitete Datei) oder ist abgelaufen

Die ASP.NET Core-Erweiterungsmethoden

Das Paket enthält außerdem UseDoconut() und UseDoconutResources(), die ASP.NET Core-Pipeline-Erweiterungen, weil es seinen Code mit den ASP.NET Core-Paketen teilt. In diesem Paket sind beide mit [Obsolete] gekennzeichnet und werden nicht verwendet: eine System.Web-Anwendung hat keine Request-Pipeline, zu der sie hinzugefügt werden könnten. Ihre Ersatzlösungen sind die beiden Web.config-Registrierungen aus 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
KonstruktorinjektionDoconutHost.Services.GetRequiredService<T>()
Host-AbschaltungDoconutHost.Shutdown() in Application_End

War diese Seite hilfreich?