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 ograniczenia licencyjne zachowują się w czasie wykonywania oraz jak podłączyć własną przeglądarkę.

Rejestrowanie wtyczki

Każdy pakiet wtyczki udostępnia jedną klasę wtyczki. Rejestrujesz ją raz, przy uruchamianiu:

csharp
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 metodę zwrotną Register w rejestrze wtyczek przechowywanym w DoconutOptions. Wszystko, co wtyczka dostarcza, jest oznaczone wymaganą zdolnością wtyczki. AddDoconut() natychmiast waliduje zarejestrowane wtyczki: brak licencji, starszy 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:

text
public interface IDoconutPlugin
{
    string Name { get; }                          // e.g. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // the license gate
    void Register(IDoconutPluginBuilder builder); // contribute viewers/services
}

Wewnątrz Register, builder przyjmuje dwa rodzaje wkładów:

  • builder.RegisterViewer(".dcm", () => new DicomViewer()) — przeglądarka dla rozszerzenia pliku,
  • builder.RegisterService<TContract>(() => …) — typowa usługa, którą inne części potoku mogą wyszukać.

Zdolności i ograniczenia

Zdolności są jednostkami licencyjnymi. Converter i Dicom są dostarczane jako wtyczki opcjonalne; Search i Annotation są wbudowanymi funkcjami ograniczanymi w ten sam sposób. Podstawowa przeglądarka nie jest zdolnością — jest warunkiem wstępnym, udostępnionym jako IsViewerLicensed w usłudze licencji.

Walidacja przy uruchamianiu zazwyczaj zapobiega wprowadzeniu nielicencjonowanej wtyczki do potoku żądań. Fabryka przeglądarek 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 (np. .dcm — DICOM nie ma wbudowanej przeglądarki): bez zdolności wywołanie otwarcia kończy się twardą awarią:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Aktywna tymczasowa licencja przyznaje wszystkie zdolności (z czystym, nieoznaczonym podglądem podstawowym). To klasyczne źródło niespodzianek przy uruchomieniu: rejestracja tych samych wtyczek z zakupioną licencją, która pomija jedną z ich zdolności, powoduje, że AddDoconut() nie powodzi się podczas uruchamiania. Porównaj IsCapabilityGranted(...) ze swoim planem przed wdrożeniem. Druga strona: przy braku jakiejkolwiek licencji, nic nie jest przyznane — brak licencji nie jest tymczasową licencją.

To samo ograniczenie pojawia się po stronie klienta: Viewer.ReferenceScripts() i ReferenceCss() emitują pakiety skryptów/style dla funkcji ograniczonych licencją (wyszukiwanie, adnotacje, …) tylko wtedy, gdy licencja je włącza, więc interfejs widgetu pozostaje spójny z tym, co serwer faktycznie wykona.

Mapa funkcji i wtyczek

Produkt UI używa „wtyczki” jako szerokiej etykiety funkcji, ale rejestracja po stronie serwera różni się:

FunkcjaJak jest włączaneZdolnośćWkład
AnnotationWbudowane w przeglądarkę; zawiera zasoby adnotacjiAnnotationTworzenie w przeglądarce, utrzymanie sesji i eksporty z wbudowanymi adnotacjami
SearchWbudowane w przeglądarki obsługujące formaty przeszukiwalne; zawiera zasoby wyszukiwania i umożliwia ekstrakcję tam, gdzie jest wymaganaSearchNatywny indeks tekstu, podświetlenia i nawigacja wyników
ConverterZainstaluj Doconut.NET6.Converter i zarejestruj ConverterPluginConverterUsługa konwersji C# i opcjonalny widget internetowy
DICOMZainstaluj Doconut.NET6.Dicom i zarejestruj DicomPluginDicomWyświetlanie obrazów medycznych dla .dcm i .ima

Adnotacje i zwykłe wyszukiwanie nie używają AddPlugin<TPlugin>(); ich pakiety są emitowane tylko wtedy, gdy licencja przyznaje odpowiednią zdolność. Converter i DICOM są wydanymi opcjonalnymi implementacjami IDoconutPlugin dla tego zestawu dokumentacji.

Zatwierdzone artefakty .NET 6 zawierają Doconut.NET6.Converter i Doconut.NET6.Dicom w tej samej wersji co pakiet podstawowy.

Udostępnione pakiety wtyczek

WtyczkaPakietZdolnośćWkład
ConverterDoconut.NET6.ConverterConverterZdolność konwersji dokumentów
DICOMDoconut.NET6.DicomDicomWyświetlanie obrazów medycznych (.dcm — format tylko wtyczkowy)

Każda ma dedykowaną stronę w sekcji Plugins z konfiguracją i użyciem.

Niestandardowe przeglądarki — własny obsługiwacz formatu

Możesz podłączyć przeglądarkę do potoku bez tworzenia pakietu wtyczki, bezpośrednio z Program.cs:

text
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implements IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // optional default config
});

Niestandardowe 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 podasz domyślnej konfiguracji.

Najważniejsze wnioski

  • Wtyczki są rejestrowane explicite i ich LicenseCapability jest walidowana podczas AddDoconut() — brak lub niewystarczające nie‑tymczasowe uprawnienia powodują szybkie niepowodzenie.
  • Wtyczki typu override degradują się łagodnie; formaty tylko wtyczkowe kończą się LicenseException.
  • Aktywna tymczasowa licencja odblokowuje wszystko; produkcyjna odblokowuje to, co zostało zakupione. Zweryfikuj przy pomocy IDoconutLicenseService przed wydaniem.

Czy ta strona była pomocna?