Installation

Fügen Sie Doconut zu Ihrem .NET Standard 2.1-Projekt hinzu

Der Basis‑Doconut‑Viewer für .NET Standard wird als ein NuGet‑Paket geliefert, das sich in jede ASP.NET‑Core‑Anwendung einfügt. Optionale Plugins verwenden separate Pakete. Diese Seite installiert das Basis‑Paket, bestätigt, dass Ihr Host es verwenden kann, und registriert die Middleware — das Minimum, das vor Ihrer ersten Darstellung erforderlich ist.

Überprüfen Sie zuerst das Host‑Framework

Die Bibliothek zielt auf netstandard2.1. Das ist ein engerer Vertrag als das vorherige netstandard2.0‑Build, und es ist das Erste, das Sie überprüfen sollten:

HostUnterstützt
.NET Core 3.0 oder neuer, einschließlich .NET 5/6/7/8Ja
.NET Framework (beliebige Version)Nein — netstandard2.1 kann nicht von .NET Framework verwendet werden

Das Paket läuft nur unter Windows. Für einen Linux‑Host verwenden Sie Doconut.NET8 oder Doconut.NET6.

Wenn die Anwendung unter .NET Framework läuft, ist dies nicht das richtige Paket. Verwenden Sie stattdessen Doconut.NETFramework; ab Version 26.9.0 erfordert es .NET Framework 4.7.2.

Paket installieren

bash
dotnet add package Doconut.NETStandard

Der Befehl ohne Versionsangabe installiert die neueste stabile Version. Um die in dieser Dokumentation beschriebene Version festzulegen, übergeben Sie die Version als separate Option:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard ist die Paket‑ID. Das Versionssuffix gehört zum heruntergeladenen Doconut.NETStandard.<version>.nupkg‑Dateinamen und ist nicht Teil der ID.

Die Versionsnummer ist die Generation

Das ist hier wichtiger als der Paketname. Beide Generationen der .NET‑Standard‑Bibliothek werden unter derselben Paket‑ID veröffentlicht, und nur die Version unterscheidet sie:

VersionZielAPI
26.7.0 und darunternetstandard2.0die vorherige Integration
26.8.0 und darübernetstandard2.1die hier dokumentierte Integration

Es gibt keinen Kompatibilitäts‑Shim und kein Nebeneinander‑Paket. Das Erhöhen der Version ist das Upgrade, und der Compiler meldet die API‑Unterschiede sofort.

Wählen Sie die Dokumentation nicht nur anhand des Paketnamens aus:

  • new Viewer(_cache, _accessor, …), UnSafeMode, synchrones OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm und manuell kopierte Viewer‑Skripte identifizieren die vorherige Integration;
  • AddDoconut(), UseDoconutResources(), ein injizierter Viewer und OpenDocumentAsync(...) identifizieren die hier dokumentierte aktuelle Integration.

Das übersetzte vorherige Einrichtungs‑Handbuch ist weiterhin verfügbar. Verwenden Sie den Migrations‑Leitfaden, um Generationen zu wechseln; ein Paket‑Update konvertiert nicht automatisch den Start, die Viewer‑Lebensdauer oder Browser‑Ressourcen automatisch.

Doconut registrieren

AddDoconut() ist der einzige Registrierungseintragspunkt — es gibt eine einzige Überladung, und sie verbindet den Viewer‑Dienst, den Lizenz‑Dienst und die Rendering‑Infrastruktur in den DI‑Container.

Zwei Middleware‑Aufrufe vervollständigen die Einrichtung, und ihre Reihenfolge ist wichtig: UseDoconutResources() muss vor UseDoconut() ausgeführt werden. UseDoconut() ist terminale Middleware, sodass ein Aufruf zuerst bedeutet, dass jede Anfrage an ein /doconut-res‑Asset nie den Ressourcen‑Handler erreicht und 404‑Fehler erzeugt. UseDoconut() beantwortet jede Anfrage, die ihn erreicht, daher sollten Sie ihn in einem eigenen Zweig mit app.Map einbinden. Das Session‑Wiring ist ebenfalls erforderlich — Doconut's Standard‑Dokumentensicherheit prüft jede Seitenanfrage gegen den ASP.NET‑Session‑State.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // Der Session-Status benötigt einen Cache (MVC/Razor Pages fügen bereits einen hinzu)
builder.Services.AddSession(); // Doconut-Dokumentsicherheit basiert auf dem ASP.NET Session-Status

app.UseSession();          // Rufen Sie UseSession() vor UseDoconut() auf
app.UseDoconutResources(); // Muss vor UseDoconut() registriert werden
app.Map("/doconut", branch => branch.UseDoconut());

Namespaces

Die Konfigurationstypen sind nicht mehr auf vier Namespaces verteilt. In diesem Release befindet sich fast alles im Root‑Namespace Doconut:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, alle Format-Konfigurationen
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // Cloud- und Dateifreigabe-Konfigurationen
using Doconut.Configs.Conversion;    // ConversionTarget

Die Typnamen selbst haben sich nicht geändert — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig und der Rest sind weiterhin vorhanden. Wenn Sie eine bestehende Anwendung migrieren, benötigen die meisten Dateien nur zwei gelöschte using‑Zeilen; siehe den Migrations‑Leitfaden.

Alle Optionen

DoconutOptions akzeptiert die folgenden einstellbaren Eigenschaften. Jede ist optional — die untenstehenden Vorgaben gelten, wenn eine Eigenschaft nicht gesetzt wird.

EigenschaftStandardBeschreibung
ShowDoconutInfofalseWenn true, gibt eine Anfrage ohne token stattdessen ein Versionsbanner zurück anstelle eines 404. Nützlich als Schnelltest; in der Produktion deaktivieren.
UnsafeModefalseWenn true, wird die ASP.NET‑Session‑Sicherheitsprüfung bei Seitenanfragen übersprungen. In der Produktion deaktivieren. Hinweis zur Schreibweise — die vorherige Bibliothek nannte dies UnSafeMode.
MiddlewarePath"/doconut"Koordinationswert für den page‑image‑Endpunkt. Er wird validiert, mountet jedoch keinen eigenen Zweig; halten Sie ihn abgestimmt mit der tatsächlichen UseDoconut()‑Zuordnung und dem Client‑BasePath.
ResourcesPath"/doconut-res"Wo die eingebetteten JS/CSS/Image‑Ressourcen bereitgestellt werden.
LicensePath"" (leerer String)Pfad zur Lizenzdatei. Leer bedeutet, zum nächsten Quellort weiterzuleiten, dann automatische Suche.
LicenseContent"" (leerer String)Roh‑Lizenzinhalt — aus einer Umgebungsvariablen, einem Secret‑Manager oder einer Datenbank.
LicenseStreamnullLizenz als Stream, einmal beim Start gelesen.
ResetLicensefalseReserviertes Kompatibilitäts‑Flag. Die Lizenz wird während AddDoconut() gelesen; starten Sie die Anwendung neu, nachdem Sie eine Lizenz ersetzt haben.
MaxConcurrentEditorSessions200Maximale Anzahl gleichzeitiger Live‑Editor‑Sitzungen (Dokumente, die mit DocOptions.EditMode geöffnet wurden). Darüber hinaus wird die am wenigsten kürzlich genutzte Leerlauf‑Editor‑Sitzung geschlossen. Normale Viewer‑Sitzungen werden nie gezählt. 0 oder ein negativer Wert bedeutet keine Begrenzung.
EditorSnapshotEveryOps50Bei aktivierter Editor‑Persistenz (AddDoconutEditorPersistence) wird das Live‑Dokument nach N aufgezeichneten Änderungen gesnapshottet. 0 oder ein negativer Wert erzeugt nie Snapshots während einer Sitzung. Keine Wirkung, wenn die Persistenz deaktiviert ist.

Lizenz‑Priorität, wenn mehr als eine Quelle gesetzt ist: LicenseStream schlägt LicenseContent, das LicensePath schlägt die automatische Suche — siehe Lizenz‑Einrichtung.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // Koordinieren Sie sich mit der App-Zuordnung und dem Client-BasePath
    options.ResourcesPath   = "/doconut-res"; // wo die JS/CSS/Bilder des Viewers bereitgestellt werden
    options.UnsafeMode      = false;          // Session-Sicherheit aktiv lassen
    options.ShowDoconutInfo = false;
});

Nächste Schritte

War diese Seite hilfreich?