DoconutExtensions
Registrace služeb a middleware
DoconutExtensions (namespace Doconut.Middleware) je statická třída se třemi voláními, která každý host Doconut provádí: jedno registraci služby a dvě registrace middleware.
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession(); // volat UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());UseDoconut() odpovídá na každý požadavek, který k ní dorazí, takže ji připojte na vlastní větev s app.Map.
AddDoconut
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)Vytváří DoconutOptions, validuje je fail-fast (viz DoconutOptions → Startup validation) a registruje celý graf služeb:
| Service | Lifetime | Role |
|---|---|---|
DoconutOptions | Singleton | Konfigurační objekt |
| Session cache service | Singleton | Token → mezipaměť relace (IMemoryCache je také registrován) |
IDoconutLicenseService | Singleton | Licence načtená jednou při spuštění (priorita: LicenseStream → LicenseContent → LicensePath → automatické hledání) |
| Page-image pipeline | Singleton | Provádí zpracování obrázků pro stránky (vodoznak, otáčení, škálování, anotace) |
| Document security (access store) | Singleton | Umožňuje vazbu token‑relace |
Viewer | Transient | Veřejná rozhraní pro otevření/uzavření |
DocumentConverter | Transient | Rozhraní pro konverzi — vyžaduje plugin Converter |
DocumentSigner | Transient | Rozhraní pro podepisování — vyžaduje plugin Signer (viz Plugin pro podepisování) |
DistributedDocumentPublisher | Transient | Publikuje artefakty dokumentu do sdíleného úložiště (viz Distribuovaná nasazení) |
Health check "doconut" | — | Zprávy o stavu licence/expirace prostřednictvím ASP.NET health checks |
Dvě chování, která stojí za to znát:
- Converter vyžaduje svůj plugin. Vyřešení
DocumentConverterbezoptions.AddPlugin<ConverterPlugin>()vyvolá výjimku:
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().DocumentSigner následuje stejné pravidlo: bez options.AddPlugin<SignerPlugin>() vyvolá No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().
- Oprávnění pluginu je ověřováno při spuštění. Chybějící licence, starý soubor
TRIALnebo placená licence bez registrované schopnosti pluginu selže v časeAddDoconut(). Registrace dočasné/Demo přežijí datum expirace, zatímco runtime brány odeberou vypršené schopnosti.
Kontrola zdraví se integruje se standardním mechanismem ASP.NET Core — namapujte ji, pokud chcete stav licence na vašem health endpointu:
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)Přidává middleware Doconut page-image. Obsluhuje každý požadavek nesoucí parametr dotazu ?token= — stránky, náhledy, vyhledávání, anotace, akce stránky (úplná tabulka požadavků je v Základních konceptech → Jak funguje prohlížeč) — a odpovídá na jakýkoli jiný požadavek s 404 (nebo bannerem ShowDoconutInfo): nikdy nepředává požadavek dál do zbytku pipeline. Připojte ji na vlastní větev, jako ve vzorcích na této stránce. Když je UnsafeMode false, vrstva zabezpečení dokumentu je automaticky zapojena před ní.
Běžná alternativa zachovává historický tvar požadavku DocImage.axd s větví MapWhen (klient pak používá BasePath: '/'):
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)Obsluhuje vložené JS, CSS, obrázky a fonty na DoconutOptions.ResourcesPath (výchozí /doconut-res). Toto jsou soubory, pro které Viewer.ReferenceCss() / ReferenceScripts() generují značky.
Vždy to zavolejte před UseDoconut(). Pokud je oblast prohlížeče prázdná a konzole prohlížeče ukazuje 404 pro /doconut-res/..., tento volání chybí nebo je na špatném místě.
Serving from shared storage
Další dvě registrace existují pro nasazení, kde uzel, který vykresluje dokument, není nutně uzel, který servíruje jeho stránky. Obě jsou podrobně popsány v Distribuovaná nasazení; signatury jsou:
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // volitelná fronta pro publikování na pozadí
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // sdílené úložiště pro nahrávání widgetůČtecí část je samostatné middleware z assembly Doconut.Clouds, které je součástí stejného balíčku:
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerOrdering recap
app.UseRouting();
app.UseSession(); // volat UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // nebo větev MapWhenByla tato stránka užitečná?