System Wtyczek
Rozszerz przeglądarkę za pomocą wtyczek
Rdzeń Doconut pozostaje lekki; opcjonalna funkcjonalność jest dostarczana jako wtyczki — oddzielne pakiety NuGet, które dostarczają przeglądarki lub usługi i są włączane przez twoją licencję. Ta strona wyjaśnia model rejestracji, jak ograniczanie licencją zachowuje się w czasie wykonywania oraz jak podłączyć własną przeglądarkę.
Ten model jest nowy w tej wersji. Poprzednia biblioteka .NET Standard nie posiadała rejestru wtyczek: konwersja odbywała się w samej przeglądarce, a licencje wtyczek były instalowane poprzez statyczne wywołania Viewer.SetLicensePlugin(...). Żadne z nich nie jest mechanizmem rejestracji tutaj.
Rejestrowanie wtyczki
Każdy pakiet wtyczki udostępnia jedną klasę wtyczki. Rejestrujesz ją raz, przy uruchamianiu:
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() tworzy instancję wtyczki i wywołuje jej Register callback wobec rejestru wtyczek przechowywanego w DoconutOptions. Wszystko, co wtyczka wnosi, jest oznaczone wymaganą zdolnością wtyczki. AddDoconut() natychmiast weryfikuje zarejestrowane wtyczki: brak licencji, przestarzały plik TRIAL lub płatna licencja bez tej zdolności powoduje niepowodzenie uruchomienia z InvalidOperationException. Rejestracja tymczasowa/Demo jest zachowywana po wygaśnięciu, ale jej zdolności w czasie wykonywania są cofane po dacie wygaśnięcia.
Umowa
Wtyczka implementuje celowo mały interfejs:
public interface IDoconutPlugin
{
string Name { get; } // np. "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // brama licencyjna
void Register(IDoconutPluginBuilder builder); // dodaj przeglądarki/usługi
}Wewnątrz Register, konstruktor akceptuje dwa rodzaje wkładów:
builder.RegisterViewer(extension, factory)— przeglądarka dla rozszerzenia pliku; fabryka zwracaIFormatViewer(wtyczka DICOM rejestruje.dcmi.imaw ten sposób),builder.RegisterService<TContract>(() => …)— typowana usługa, którą inne części potoku mogą wyszukać.
Zdolności i ograniczenia
Zdolności są jednostkami licencyjnymi. Converter, Dicom i Signer są dostarczane jako wtyczki opcjonalne; Search i Annotation to wbudowane funkcje ograniczane w ten sam sposób. Podstawowa przeglądarka nie jest zdolnością — jest warunkiem wstępnym, udostępnianym jako IsViewerLicensed w usłudze licencji.
Walidacja przy starcie zazwyczaj zapobiega wprowadzeniu nielicencjonowanej wtyczki do potoku żądań. Fabryka przeglądarki stosuje również dwie defensywne reguły w czasie wykonywania, które mają znaczenie, jeśli uprawnienia zmieniają się po uruchomieniu:
- Wtyczka nadpisuje wbudowaną przeglądarkę (wtyczka zgłasza rozszerzenie, które obsługuje również wbudowany rejestr): przy licencjonowanej zdolności przeglądarka wtyczki wygrywa; bez niej Doconut cicho przełącza się na wbudowaną przeglądarkę. Użytkownicy nadal widzą swój dokument — po prostu nie otrzymują funkcji wtyczki.
- Format tylko wtyczkowy (
.dcmi.ima— DICOM nie ma wbudowanej przeglądarki): bez zdolności wywołanie otwarcia kończy się twardą awarią:
LicenseException: This document type requires the 'Dicom' plugin license.Aktywna tymczasowa licencja przyznaje wszystkie zdolności (z czystym, nieoznakowanym podstawowym podglądem). To klasyczne źródło niespodzianek przy uruchomieniu: rejestracja tych samych wtyczek z zakupioną licencją, która pomija jedną z ich zdolności, powoduje niepowodzenie AddDoconut() podczas uruchamiania. Porównaj IsCapabilityGranted(...) ze swoim planem przed wdrożeniem. Z drugiej strony: przy braku jakiejkolwiek licencji, nic nie jest przyznane — brak licencji nie jest tymczasową licencją.
To samo ograniczanie pojawia się po stronie klienta: Viewer.ReferenceScripts() i ReferenceCss() emitują pakiety skryptów/style dla funkcji ograniczonych licencją (wyszukiwanie, adnotacje, …) tylko gdy licencja je włącza, więc interfejs widgetu pozostaje spójny z tym, co serwer faktycznie zrobi.
Mapa funkcji i wtyczek
Interfejs produktu używa terminu „plugin” jako szerokiej etykiety funkcji, ale rejestracja po stronie serwera różni się:
| Funkcja | Jak jest włączane | Zdolność | Wnosi |
|---|---|---|---|
| Adnotacja | Wbudowane w przeglądarkę; zawiera zasoby adnotacji | Annotation | Tworzenie w przeglądarce, utrzymywanie sesji i eksporty wbudowane |
| Wyszukiwanie | Wbudowane w przeglądarki obsługujące formaty przeszukiwalne; zawiera zasoby wyszukiwania i umożliwia ekstrakcję tam, gdzie jest wymagana | Search | Natychmiastowy indeks tekstu, podświetlenia i nawigacja wyników |
| Konwerter | Zainstaluj Doconut.NETStandard.Converter i zarejestruj ConverterPlugin | Converter | Usługa konwersji C# oraz opcjonalny widget internetowy |
| DICOM | Zainstaluj Doconut.NETStandard.Dicom i zarejestruj DicomPlugin | Dicom | Przeglądanie obrazów medycznych dla .dcm i .ima |
| Podpisujący | Zainstaluj Doconut.NETStandard.Signer i zarejestruj SignerPlugin | Signer | Widoczne podpisy i pieczęcie cyfrowe dla PDF i Word: usługa podpisywania C# oraz opcjonalny widget internetowy |
Adnotacje i zwykłe wyszukiwanie nie używają AddPlugin<TPlugin>(); ich pakiety są emitowane tylko wtedy, gdy licencja przyznaje odpowiednią zdolność. Konwerter, DICOM i Podpisujący są implementacjami opt‑in IDoconutPlugin.
Opublikowane pakiety wtyczek
| Wtyczka | Pakiet | Zdolność | Wnosi |
|---|---|---|---|
| Konwerter | Doconut.NETStandard.Converter | Converter | Zdolność konwersji dokumentów |
| DICOM | Doconut.NETStandard.Dicom | Dicom | Przeglądanie obrazów medycznych (.dcm i .ima — formaty tylko wtyczkowe) |
| Podpisujący | Doconut.NETStandard.Signer | Signer | Podpisywanie PDF i Word |
Każda ma dedykowaną stronę w sekcji Plugins z jej konfiguracją i użyciem.
Własne przeglądarki — obsługa własnego formatu
Możesz podłączyć przeglądarkę do potoku bez tworzenia pakietu wtyczki, bezpośrednio z Program.cs:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implementuje IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // opcjonalna domyślna konfiguracja
});
// Obsługa formatu tworzona przez fabrykę. Zastąp te elementy własnym renderowaniem.
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() { }
}Własne przeglądarki mają pierwszeństwo przed wszystkim — zarówno wbudowanymi, jak i wtyczkami — i nie są ograniczane licencją (są twoim kodem). Fabryka przełącza się na ImageConfig, gdy nie dostarczysz domyślnej konfiguracji.
Wnioski
- Wtyczki są rejestrowane explicite, a ich
LicenseCapabilityjest weryfikowany podczasAddDoconut()— brak lub niewystarczające uprawnienia nie‑tymczasowe powodują szybkie niepowodzenie. - Wtyczki typu override degradują się łagodnie; formaty tylko wtyczkowe kończą się niepowodzeniem z
LicenseException. - Aktywna tymczasowa licencja odblokowuje wszystko; wersja produkcyjna odblokowuje to, co kupiłeś. Zweryfikuj z
IDoconutLicenseServiceprzed wypuszczeniem.
Czy ta strona była pomocna?