DoconutOpcje

Konfiguruj usługi Doconut

DoconutOptions (namespace Doconut) jest jedynym obiektem konfiguracyjnym dla całego SDK. Konfigurujesz go raz, wewnątrz AddDoconut(), i jest rejestrowany jako singleton.

Jest to zmiana zarówno lokalizacji, jak i struktury. W poprzedniej bibliotece .NET Standard DoconutOptions instancja była tworzona w czasie potoku i przekazywana do UseDoconut(new DoconutOptions { … }). Tutaj middleware nie przyjmuje żadnych opcji — wszystko jest ustawiane podczas rejestracji usług.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Właściwości

TypWłaściwośćDomyślneOpis
boolShowDoconutInfofalseGdy true, żądanie middleware bez tokenu zwraca baner wersji (Doconut <version> is running on <host>) zamiast 404. Przydatne jako szybki test; pozostaw false w środowisku produkcyjnym.
boolUnsafeModefalseGdy true, pomija kontrolę bezpieczeństwa sesji ASP.NET przy żądaniach stron. Pozostaw false w produkcji na pojedynczym węźle (zobacz Podstawowe pojęcia → Sesje i bezpieczeństwo). Wcześniej zapisane jako UnSafeMode.
stringMiddlewarePath"/doconut"Wartość koordynacji dla punktu końcowego page-image. Jest walidowana, ale nie montuje gałęzi potoku; utrzymuj ją zgodną z rzeczywistym mapowaniem UseDoconut() i klientem BasePath.
stringResourcesPath"/doconut-res"Prefiks ścieżki URL dla osadzonych zasobów JS/CSS/obrazów/czcionek.
stringLicensePath""Ścieżka do pliku licencji. Pusta → następne źródło licencji, potem automatyczne wykrywanie; brak wyniku → stan oceny z znakowanym wododrukiem bez możliwości.
stringLicenseContent""Surowa zawartość licencji XML (baza danych, zmienna środowiskowa, menedżer tajemnic). Ma pierwszeństwo przed LicensePath.
Stream?LicenseStreamnullLicencja jako strumień, odczytywana raz przy starcie. Ma pierwszeństwo przed obiema innymi źródłami.
boolResetLicensefalseZarezerwowany znacznik kompatybilności. Obecna implementacja go nie wykorzystuje; uruchom ponownie aplikację po wymianie licencji.
DoconutPluginRegistryPluginRegistry—Rejestr tylko do odczytu zbierający wkłady wtyczek; wykorzystywany przez fabrykę podglądów. Wypełnij za pomocą AddPlugin<T>().

Priorytet licencji (wyegzekwowany podczas rejestracji usług): LicenseStream → LicenseContent → LicensePath → automatyczne wykrywanie (zobacz Rozpoczęcie → Konfiguracja licencji).

Metody

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Użyj tej metody dla wydanych pakietów Converter, DICOM i Signer dostępnych na zasadzie opt-in. Adnotacje i zwykłe wyszukiwanie są wbudowanymi funkcjami objętymi licencją i nie używają AddPlugin<TPlugin>().

Rejestruje wtyczkę pierwszej strony (Converter, DICOM, Signer). Fluent — zwraca instancję opcji. AddDoconut() rzuca InvalidOperationException przy brakującej licencji, starszym pliku TRIAL lub płatnej licencji, która nie przyznaje możliwości wtyczki. Rejestracje tymczasowe/demo są zachowywane po wygaśnięciu i podlegają bramce w czasie działania (zobacz Podstawowe pojęcia → System wtyczek).

Widżet Converter dostępny na zasadzie opt-in jest włączony przy użyciu AddConverterWidget() i udostępniony poprzez właściwość tylko do odczytu ConverterWidget; jego opcje są opisane na stronie wtyczki Converter (Wtyczki → Wtyczka Converter). Widżet Signer dostępny na zasadzie opt-in jest włączony w ten sam sposób, przy użyciu AddSignerWidget(), i udostępniony poprzez właściwość tylko do odczytu SignerWidget; zobacz Wtyczka Signer.

RegisterViewer(rozszerzenie, fabryka, domyślnaKonfiguracja?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — kropka początkowa opcjonalna
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Rejestruje niestandardowy podgląd dla rozszerzenia pliku. Niestandardowe podglądy mają pierwszeństwo przed wbudowanymi i podglądami wtyczek i nie są ograniczone licencją. Gdy defaultConfig jest pominięte i dokument otwiera się bez wyraźnej konfiguracji, używany jest ImageConfig.

Rzuca ArgumentException (Extension must be a non-empty file extension.) przy pustym rozszerzeniu i ArgumentNullException przy null factory.

Walidacja przy starcie

AddDoconut() waliduje opcje fail-fast, więc błędna konfiguracja objawia się jako wyraźny wyjątek przy starcie zamiast mylących 404 w czasie żądania:

text
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.

Typowe konfiguracje

csharp
// Produkcja: wyraźna licencja, wszystko zabezpieczone (wszystkie domyślne ustawienia bezpieczeństwa)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// Niestandardowe ścieżki (np. aby uniknąć konfliktu trasy)
builder.Services.AddDoconut(options =>
{
    options.MiddlewarePath = "/docs-engine";
    options.ResourcesPath  = "/docs-assets";
});

Gdy zmienisz ResourcesPath, utrzymaj synchronizację ResPath widżetu klienta (zobacz ViewerConfig). To jedno z dwóch ustawień po stronie klienta, które zawodzą bez komunikatu o błędzie.

MiddlewarePath nie jest automatycznym mapowaniem tras ASP.NET Core. Jeśli Doconut ma odpowiadać tylko pod niestandardowym prefiksem, zamontuj UseDoconut() na tej gałęzi (na przykład przy użyciu app.Map("/docs-engine", branch => branch.UseDoconut())) i ustaw klienta BasePath na ten prefiks bez wiodącego / ('docs-engine'). Popularna alternatywa zachowuje historyczny kształt żądania DocImage.axd na gałęzi MapWhen z BasePath: '/'.

Czy ta strona była pomocna?