DoconutExtensions

Dienst- und Middleware‑Registrierung

DoconutExtensions (namespace Doconut.Middleware) ist die statische Klasse mit den drei Aufrufen, die jeder Doconut‑Host macht: eine Service‑Registrierung und zwei Middleware‑Registrierungen.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // Rufen Sie UseSession() vor UseDoconut() auf
app.UseDoconutResources(); // muss vor UseDoconut() registriert werden
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() beantwortet jede Anfrage, die sie erreicht, also binden Sie sie auf einem eigenen Zweig mit app.Map.

AddDoconut

text
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)

Erstellt das DoconutOptions, validiert es sofort (siehe DoconutOptions → Startup‑Validierung) und registriert den vollständigen Servicegraphen:

ServiceLifetimeRole
DoconutOptionsSingletonDas Konfigurationsobjekt
Session cache serviceSingletonToken → session cache (IMemoryCache ist ebenfalls registriert)
IDoconutLicenseServiceSingletonLizenz wird einmal beim Start geladen (Priorität: LicenseStream → LicenseContent → LicensePath → auto-search)
Page-image pipelineSingletonFührt Bildverarbeitung für Seiten durch (Wasserzeichen, Drehen, Skalieren, Anmerkungen)
Document security (access store)SingletonGewährt für Token‑zu‑Session‑Bindung
ViewerTransientDie öffentliche Öffnen/Schließen‑Fassade
DocumentConverterTransientKonvertierungs‑Fassade — erfordert das Converter‑Plugin
DocumentSignerTransientSignatur‑Fassade — erfordert das Signer‑Plugin (siehe Signer Plugin)
DistributedDocumentPublisherTransientVeröffentlicht die Artefakte eines Dokuments im gemeinsamen Speicher
Health check "doconut"—Berichtet den Lizenz‑/Ablaufstatus über ASP.NET Health Checks

Es gibt keinen entsprechenden Aufruf in der vorherigen .NET Standard‑Bibliothek. Sie erstellte new Viewer(cache, accessor) pro Anfrage und übergab Optionen an die Middleware; beide werden durch diese einzelne Registrierung ersetzt.

Zwei Verhaltensweisen, die es zu kennen gilt:

  • Converter erfordert sein Plugin. Das Auflösen von DocumentConverter ohne options.AddPlugin<ConverterPlugin>() wirft:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner folgt derselben Regel: Ohne options.AddPlugin<SignerPlugin>() wirft es No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Plugin‑Berechtigung wird beim Start validiert. Eine fehlende Lizenz, eine veraltete TRIAL‑Datei oder eine kostenpflichtige Lizenz ohne die Fähigkeit eines registrierten Plugins schlägt zur AddDoconut()‑Zeit fehl. Temporäre/Demo‑Registrierungen überleben ihr Ablaufdatum, während Laufzeit‑Gates die abgelaufenen Fähigkeiten entziehen.

Der Health Check integriert sich in den Standard‑ASP.NET‑Core‑Mechanismus — binden Sie ihn ein, wenn Sie den Lizenzstatus auf Ihrem Health‑Endpunkt sehen möchten:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Fügt die Doconut Page‑Image‑Middleware hinzu. Sie bedient jede Anfrage, die einen ?token=‑Abfrageparameter enthält — Seiten, Thumbnails, Suche, Anmerkungen, Seitenaktionen (die vollständige Anfragetabelle befindet sich in Core Concepts → How the Viewer Works) — und beantwortet jede andere Anfrage selbst mit 404 (oder dem ShowDoconutInfo‑Banner): Sie leitet keine Anfrage an den Rest der Pipeline weiter. Binden Sie sie in einem eigenen Zweig ein, wie in den Beispielen auf dieser Seite. Wenn UnsafeMode false ist, wird die Dokument‑Sicherheits‑Schicht automatisch davor verkabelt.

Sie nimmt keine Argumente entgegen. Das Übergeben einer DoconutOptions‑Instanz hier war die Form der vorherigen Bibliothek und kompiliert nicht mehr.

Eine gängige Konfiguration bewahrt die historische DocImage.axd‑Anfrageform mit einem MapWhen‑Zweig (der Client verwendet dann BasePath: '/'):

csharp
app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconutResources

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

Stellt das eingebettete JS, CSS, Bilder und Schriftarten unter DoconutOptions.ResourcesPath (Standard /doconut-res) bereit. Dies sind die Dateien, für die Viewer.ReferenceCss() / ReferenceScripts() Tags erzeugen.

Rufen Sie es immer vor UseDoconut() auf. Wenn der Viewer‑Bereich leer bleibt und die Browser‑Konsole 404‑Fehler für /doconut-res/... anzeigt, fehlt dieser Aufruf oder ist an der falschen Stelle.

Dies ist der unterstützte Ersatz für das manuelle Einbinden der Middleware zur Behandlung eingebetteter Ressourcen.

Serving from shared storage

Zwei weitere Registrierungen existieren für Deployments, bei denen der Knoten, der ein Dokument rendert, nicht unbedingt der Knoten ist, der dessen Seiten bereitstellt. Beide werden end‑to‑end in Distributed Deployments behandelt; die Signaturen lauten:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // opt-in Hintergrund-Publishing-Warteschlange
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // gemeinsamer Backing Store für Widget-Uploads

Die Leseseite ist eine separate Middleware aus der Doconut.Clouds‑Assembly, die im selben Paket geliefert wird:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

UseDoconutWebFarm(...) und WebFarmOptions existieren in dieser Version nicht. Siehe den migration guide für die Einstellung‑für‑Einstellung‑Zuordnung.

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // Rufen Sie UseSession() vor UseDoconut() auf
app.UseDoconutResources(); // muss vor UseDoconut() registriert werden
app.Map("/doconut", branch => branch.UseDoconut()); // oder ein MapWhen-Zweig

War diese Seite hilfreich?