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 na podstawie twojej licencji. Ta strona wyjaśnia model rejestracji, jak ograniczenia licencyjne zachowują 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 była częścią samej przeglądarki, a licencje wtyczek instalowano poprzez statyczne wywołania Viewer.SetLicensePlugin(...). Żadne z nich nie jest tutaj mechanizmem rejestracji.

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 Register callback w rejestrze wtyczek przechowywanym na DoconutOptions. Wszystko, co wtyczka wnosi, jest oznaczone wymaganą funkcją wtyczki. AddDoconut() natychmiast waliduje zarejestrowane wtyczki: brak licencji, przestarzały plik TRIAL lub płatna licencja bez tej funkcji powodują niepowodzenie uruchomienia z InvalidOperationException. Rejestracja tymczasowa/Demo jest zachowywana po wygaśnięciu, ale jej możliwości w czasie działania są cofane po dacie wygaśnięcia.

Umowa

Wtyczka implementuje celowo mały interfejs:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // np. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // bramka licencyjna
    void Register(IDoconutPluginBuilder builder); // dodaj przeglądarki/usługi
}

Wewnątrz Register, konstruktor akceptuje dwa rodzaje wkładów:

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

Uprawnienia i ograniczenia

Uprawnienia są jednostkami licencyjnymi. Converter i Dicom są dostarczane jako wtyczki opcjonalne; Search i Annotation to wbudowane funkcje ograniczane w ten sam sposób. Podstawowa przeglądarka nie jest uprawnieniem — jest warunkiem wstępnym, udostępnianym 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 działania, które mają znaczenie, jeśli uprawnienia zmieniają się po uruchomieniu:

  • Wtyczka nadpisuje wbudowaną przeglądarkę (wtyczka żąda rozszerzenia, które obsługuje również wbudowany rejestr): przy licencjonowanej funkcji, 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 uprawnienia wywołanie otwarcia kończy się twardą awarią:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Aktywna tymczasowa licencja przyznaje wszystkie uprawnienia (z czystym, nieoznaczonym podglądem bazowym). To klasyczne źródło niespodzianek przy uruchamianiu: rejestracja tych samych wtyczek z zakupioną licencją, która pomija jedno z ich uprawnień, powoduje niepowodzenie AddDoconut() podczas uruchamiania. Porównaj IsCapabilityGranted(...) ze swoim planem przed wdrożeniem. Odwrotna sytuacja: 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, dzięki czemu interfejs widgetu pozostaje spójny z tym, co serwer faktycznie zrobi.

Mapa funkcji i wtyczek

Interfejs produktu używa terminu „wtyczka” jako szerokiej etykiety funkcji, ale rejestracja po stronie serwera różni się:

FunkcjaJak jest włączanaUprawnienieWnosi
AdnotacjaWbudowane w przeglądarkę; zawiera zasoby adnotacjiAnnotationTworzenie w przeglądarce, utrzymanie sesji i eksporty wbudowane
WyszukiwanieWbudowane w przeglądarki obsługujące formaty przeszukiwalne; zawiera zasoby wyszukiwania i włącza ekstrakcję tam, gdzie wymaganaSearchNatywny indeks tekstu, podświetlenia i nawigacja wynikami
KonwerterZainstaluj Doconut.NETStandard.Converter i zarejestruj ConverterPluginConverterUsługa konwersji C# oraz opcjonalny widget internetowy
DICOMZainstaluj Doconut.NETStandard.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 odpowiednie uprawnienie. Konwerter i DICOM są wydanymi opcjonalnymi implementacjami IDoconutPlugin dla tego zestawu dokumentacji.

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

Udostępnione pakiety wtyczek

WtyczkaPakietUprawnienieWnosi
KonwerterDoconut.NETStandard.ConverterConverterMożliwość konwersji dokumentów
DICOMDoconut.NETStandard.DicomDicomWyświetlanie obrazów medycznych (.dcm — format tylko wtyczkowy)

Każda ma dedykowaną stronę w sekcji Wtyczki z jej 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:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implementuje IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // opcjonalna domyślna konfiguracja
});

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

Najważniejsze wnioski

  • Wtyczki są rejestrowane explicite i ich LicenseCapability jest walidowane podczas AddDoconut() — brak lub niewystarczające nie‑tymczasowe uprawnienie powoduje szybkie niepowodzenie.
  • Wtyczki typu nadpisanie degradują się łagodnie; formaty tylko wtyczkowe kończą się niepowodzeniem z LicenseException.
  • Aktywna tymczasowa licencja odblokowuje wszystko; licencja produkcyjna odblokowuje to, co kupiłeś. Zweryfikuj z IDoconutLicenseService przed wypuszczeniem.

Czy ta strona była pomocna?