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 in einen 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 Service-Graphen:

DienstLebensdauerRolle
DoconutOptionsSingletonDas Konfigurationsobjekt
Session-Cache-DienstSingletonToken → Session-Cache (IMemoryCache ist ebenfalls registriert)
IDoconutLicenseServiceSingletonLizenz, die einmal beim Start geladen wird (Priorität: LicenseStream → LicenseContent → LicensePath → Auto-Suche)
Page-Image-PipelineSingletonFührt Bildverarbeitung für Seiten durch (Wasserzeichen, Drehen, Skalieren, Anmerkungen)
Dokumentensicherheit (Zugriffsspeicher)SingletonErlaubnisse 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 (siehe Verteilte Deployments)
Health-Check "doconut"—Meldet Lizenz-/Ablaufstatus über ASP.NET Health Checks

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 registrierte Plugin-Fähigkeit 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, wenn Sie den Lizenzstatus auf Ihrem Health-Endpunkt anzeigen 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 mit einem ?token=-Abfrageparameter — Seiten, Thumbnails, Suche, Anmerkungen, Seitenaktionen (die vollständige Anfragetabelle befindet sich in Kernkonzepte → Wie der Viewer funktioniert) — 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 einen eigenen Zweig ein, wie in den Beispielen auf dieser Seite. Wenn UnsafeMode false ist, wird die Dokumentensicherheits-Schicht automatisch davor eingebunden.

Eine gängige Alternative bewahrt das historische DocImage.axd-Anfrageformat 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 falsch platziert.

Bereitstellung aus gemeinsamem Speicher

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 in Verteilte Deployments vollständig behandelt; die Signaturen sind:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // Opt-in-Hintergrund-Publikationswarteschlange
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // Gemeinsamer Speicher für Widget-Uploads

Die Leseseite ist eine separate Middleware aus dem Doconut.Clouds-Assembly, das im selben Paket ausgeliefert wird:

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

Zusammenfassung der Reihenfolge

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?