Plugin-System
Erweitern Sie den Viewer mit Plugins
Der Kern von Doconut bleibt schlank; optionale Funktionalität wird als Plugins bereitgestellt — separate NuGet-Pakete, die Viewer oder Services beitragen und durch Ihre Lizenz aktiviert werden. Diese Seite erklärt das Registrierungsmodell, wie die Lizenzgating zur Laufzeit funktioniert und wie Sie Ihren eigenen Viewer einbinden können.
Registrieren eines Plugins
Jedes Plugin-Paket stellt eine Plugin-Klasse bereit. Sie registrieren sie einmalig beim Start:
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() instanziiert das Plugin und ruft dessen Register-Callback im Plugin-Register auf, das auf DoconutOptions gehalten wird. Alles, was ein Plugin beiträgt, ist mit der erforderlichen Fähigkeit des Plugins gekennzeichnet. AddDoconut() validiert registrierte Plugins sofort: Eine fehlende Lizenz, eine veraltete TRIAL-Datei oder eine kostenpflichtige Lizenz ohne die Fähigkeit führen beim Start zu einem Fehler mit InvalidOperationException. Eine Temporary/Demo‑Registrierung bleibt über das Ablaufdatum erhalten, aber ihre Laufzeit‑Fähigkeiten werden nach dem Ablaufdatum widerrufen.
Der Vertrag
Ein Plugin implementiert eine bewusst kleine Schnittstelle:
public interface IDoconutPlugin
{
string Name { get; } // z. B. "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // das Lizenztor
void Register(IDoconutPluginBuilder builder); // Viewer/Dienste beitragen
}Innerhalb von Register akzeptiert der Builder zwei Arten von Beiträgen:
builder.RegisterViewer(extension, factory)— ein Viewer für eine Dateierweiterung; die Fabrik gibt einIFormatViewerzurück (das DICOM‑Plugin registriert auf diese Weise.dcmund.ima),builder.RegisterService<TContract>(() => …)— ein typisierter Service, den andere Teile der Pipeline abrufen können.
Fähigkeiten und Gating
Fähigkeiten sind die Lizenz‑Einheiten. Converter, Dicom und Signer werden als opt‑in‑Plugins bereitgestellt; Search und Annotation sind eingebaute Funktionen, die auf dieselbe Weise gesteuert werden. Der Basis‑Viewer ist keine Fähigkeit — er ist die Voraussetzung, die als IsViewerLicensed im Lizenz‑Service bereitgestellt wird.
Die Start‑Validierung verhindert normalerweise, dass ein nicht lizenziertes Plugin in die Anforderungspipeline gelangt. Die Viewer‑Fabrik wendet außerdem zwei defensive Laufzeitregeln an, die wichtig sind, wenn sich das Anrecht nach dem Start ändert:
- Plugin überschreibt einen eingebauten Viewer (ein Plugin beansprucht eine Erweiterung, die das eingebaute Register ebenfalls behandelt): Ist die Fähigkeit lizenziert, gewinnt der Plugin‑Viewer; ohne sie fällt Doconut stillschweigend auf den eingebauten Viewer zurück. Benutzer sehen ihr Dokument weiterhin — sie erhalten jedoch nicht die Plugin‑Funktion.
- Nur‑Plugin‑Format (
.dcmund.ima— DICOM hat keinen eingebauten Viewer): Ohne die Fähigkeit schlägt der Öffnungsaufruf hart fehl:
LicenseException: This document type requires the 'Dicom' plugin license.Eine aktive Temporary‑Lizenz gewährt jede Fähigkeit (mit sauberer, nicht wasserzeichenbehafteter Basisansicht). Dies ist eine klassische Quelle für Überraschungen beim Go‑Live: Das Registrieren derselben Plugins mit einer gekauften Lizenz, die eine ihrer Fähigkeiten weglässt, lässt AddDoconut() beim Start fehlschlagen. Vergleichen Sie IsCapabilityGranted(...) mit Ihrem Plan, bevor Sie bereitstellen. Das Gegenstück: Mit keiner Lizenz überhaupt wird nichts gewährt — eine fehlende Lizenz ist keine Temporary‑Lizenz.
Das gleiche Gating erscheint clientseitig: Viewer.ReferenceScripts() und ReferenceCss() erzeugen die Skript-/Style‑Bundles für die lizenzgesteuerten Funktionen (Suche, Annotation, …) nur wenn die Lizenz sie aktiviert, sodass die UI des Widgets konsistent bleibt mit dem, was der Server tatsächlich tut.
Funktions‑ und Plugin‑Karte
Die Produkt‑UI verwendet „Plugin“ als breiten Funktionsbegriff, aber die Server‑Registrierung unterscheidet sich:
| Feature | Wie es aktiviert wird | Fähigkeit | Trägt bei |
|---|---|---|---|
| Annotation | In den Viewer eingebaut; Annotation‑Ressourcen einschließen | Annotation | Browser‑Autorierung, Sitzungs‑Persistenz und eingebettete Exporte |
| Search | In durchsuchbare Format‑Viewer eingebaut; Such‑Ressourcen einschließen und Extraktion aktivieren, wo erforderlich | Search | Nativer Text‑Index, Hervorhebungen und Ergebnis‑Navigation |
| Converter | Installieren Sie Doconut.NET6.Converter und registrieren Sie ConverterPlugin | Converter | C#‑Konvertierungsservice und optionales Web‑Widget |
| DICOM | Installieren Sie Doconut.NET6.Dicom und registrieren Sie DicomPlugin | Dicom | Anzeige medizinischer Bilder für .dcm und .ima |
| Signer | Installieren Sie Doconut.NET6.Signer und registrieren Sie SignerPlugin | Signer | Sichtbare Signaturen und digitale Siegel für PDF und Word: C#‑Signaturservice und ein optionales Web‑Widget |
Annotation und die normale Suche verwenden nicht AddPlugin<TPlugin>(); ihre Bundles werden nur erzeugt, wenn die Lizenz die entsprechende Fähigkeit gewährt. Converter, DICOM und Signer sind opt‑in‑IDoconutPlugin‑Implementierungen.
Veröffentliche Plugin‑Pakete
| Plugin | Paket | Fähigkeit | Trägt bei |
|---|---|---|---|
| Converter | Doconut.NET6.Converter | Converter | Dokumentkonvertierungs‑Fähigkeit |
| DICOM | Doconut.NET6.Dicom | Dicom | Anzeige medizinischer Bilder (.dcm und .ima — nur‑Plugin‑Formate) |
| Signer | Doconut.NET6.Signer | Signer | PDF‑ und Word‑Signatur |
Jedes hat eine eigene Seite unter Plugins mit seiner Konfiguration und Nutzung.
Benutzerdefinierte Viewer — Ihr eigener Format‑Handler
Sie können einen Viewer in die Pipeline einbinden, ohne ein Plugin‑Paket zu schreiben, direkt von Program.cs:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implementiert IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // optionale Standardkonfiguration
});
// Der Format-Handler, den die Fabrik erstellt. Ersetzen Sie diese Mitglieder durch Ihre eigene Darstellung.
public sealed class MyCustomViewer : Doconut.Core.Interfaces.IFormatViewer
{
public ViewerType ViewerType => ViewerType.None;
public int TotalPages => 0;
public int DefaultWidth => 0;
public int DefaultHeight => 0;
public bool PreferOcr => false;
public Task LoadAsync(Stream documentStream, BaseConfig config, CancellationToken ct = default)
=> Task.CompletedTask;
public Task<byte[]> GetPageImageAsync(int pageNumber, CancellationToken ct = default)
=> Task.FromResult(Array.Empty<byte>());
public void Dispose() { }
}Benutzerdefinierte Viewer haben Vorrang vor allen — eingebauten und Plugins gleichermaßen — und sind nicht lizenzgesteuert (sie sind Ihr Code). Die Fabrik greift auf ein ImageConfig zurück, wenn Sie keine Standardkonfiguration bereitstellen.
Fazit
- Plugins werden explizit registriert und ihr
LicenseCapabilitywird währendAddDoconut()validiert — fehlende oder unzureichende nicht‑temporäre Berechtigung schlägt sofort fehl. - Override‑Style‑Plugins degradieren elegant; plugin‑only‑Formate schlagen mit einem
LicenseExceptionfehl. - Eine aktive Temporary‑Lizenz schaltet alles frei; die Produktionslizenz schaltet das frei, was Sie gekauft haben. Überprüfen Sie mit
IDoconutLicenseServicevor dem Versand.
War diese Seite hilfreich?