DoconutExtensions

Rejestracja usług i middleware

DoconutExtensions (namespace Doconut.Middleware) jest statyczną klasą z trzema wywołaniami, które każdy host Doconut wykonuje: jedną rejestrację usługi i dwie rejestracje middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // wywołaj UseSession() przed UseDoconut()
app.UseDoconutResources(); // musi być zarejestrowany przed UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() odpowiada na każde żądanie, które do niego dotrze, więc zamontuj go na własnej gałęzi z app.Map.

AddDoconut

text
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)

Tworzy DoconutOptions, waliduje je w trybie fail-fast (zobacz DoconutOptions → weryfikacja uruchamiania) i rejestruje pełny graf usług:

UsługaCzas życiaRola
DoconutOptionsSingletonObiekt konfiguracji
Usługa pamięci podręcznej sesjiSingletonToken → pamięć podręczna sesji (IMemoryCache jest również zarejestrowany)
IDoconutLicenseServiceSingletonLicencja ładowana raz przy uruchomieniu (priorytet: LicenseStream → LicenseContent → LicensePath → auto-wyszukiwanie)
Potok obrazów stronSingletonWykonuje przetwarzanie obrazów dla stron (znak wodny, obrót, skalowanie, adnotacje)
Bezpieczeństwo dokumentu (magazyn dostępu)SingletonUprawnienia do powiązania token‑sesji
ViewerTransientPubliczna fasada otwierania/zamykania
DocumentConverterTransientFasada konwersji — wymaga wtyczki Converter
DocumentSignerTransientFasada podpisywania — wymaga wtyczki Signer (zobacz Wtyczka Signer)
DistributedDocumentPublisherTransientPublikuje artefakty dokumentu w udostępnionym magazynie (zobacz Rozproszone wdrożenia)
Sprawdzenie stanu "doconut"—Zgłasza stan licencji/wygaśnięcia poprzez kontrole zdrowia ASP.NET

Dwa zachowania warte poznania:

  • Converter wymaga swojej wtyczki. Rozwiązanie DocumentConverter bez options.AddPlugin<ConverterPlugin>() powoduje błąd:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner podąża za tą samą zasadą: bez options.AddPlugin<SignerPlugin>() rzuca No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Uprawnienia wtyczki są weryfikowane przy uruchomieniu. Brakująca licencja, starszy plik TRIAL lub płatna licencja bez zarejestrowanej możliwości wtyczki powoduje błąd w czasie AddDoconut(). Rejestracje tymczasowe/demo przetrwają po upływie daty ważności, podczas gdy bramki w czasie wykonania odwołują wygasłe możliwości.

Sprawdzenie stanu integruje się ze standardowym mechanizmem ASP.NET Core — zamapuj je, jeśli chcesz stan licencji w swoim punkcie końcowym zdrowia:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Dodaje middleware Doconut page-image. Obsługuje każde żądanie zawierające parametr zapytania ?token= — strony, miniatury, wyszukiwanie, adnotacje, akcje stron (pełna tabela żądań znajduje się w Podstawowe pojęcia → Jak działa przeglądarka) — i odpowiada na każde inne żądanie samodzielnie za pomocą 404 (lub baneru ShowDoconutInfo): nigdy nie przekazuje żądania dalej w potoku. Zamontuj go na własnej gałęzi, tak jak w przykładach na tej stronie. Gdy UnsafeMode jest false, warstwa bezpieczeństwa dokumentu jest automatycznie podłączana przed nim.

Popularna alternatywa zachowuje historyczny kształt żądania DocImage.axd przy użyciu gałęzi MapWhen (klient wtedy używa BasePath: '/'):

csharp
app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconutResources

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

Serwuje osadzone pliki JS, CSS, obrazy i czcionki pod adresem DoconutOptions.ResourcesPath (domyślnie /doconut-res). Są to pliki, dla których Viewer.ReferenceCss() / ReferenceScripts() generują znaczniki.

Zawsze wywołuj to przed UseDoconut(). Jeśli obszar przeglądarki pozostaje pusty, a konsola przeglądarki wyświetla 404 dla /doconut-res/..., to wywołanie jest brakujące lub nie na miejscu.

Serving from shared storage

Dwie dodatkowe rejestracje istnieją dla wdrożeń, w których węzeł renderujący dokument nie jest koniecznie węzłem serwującym jego strony. Obie są opisane od początku do końca w Rozproszone wdrożenia; sygnatury są:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // opcjonalna kolejka publikacji w tle
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // wspólne zaplecze przechowywania dla przesyłania widgetów

Strona odczytu jest osobnym middleware z zestawu Doconut.Clouds, który jest dostarczany w tym samym pakiecie:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // wywołaj UseSession() przed UseDoconut()
app.UseDoconutResources(); // musi być zarejestrowany przed UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // lub gałąź MapWhen

Czy ta strona była pomocna?