DoconutExtensions – Doconut Dokumentace

DoconutExtensions (namespace Doconut.Middleware) je statická třída se třemi voláními, která každý host Doconut provádí: jedna registrace služby a dvě registrace middleware.

csharp

builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseDoconutResources(); // BEFORE UseDoconut()
app.UseDoconut();

AddDoconut

text

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

Vytvoří DoconutOptions, prověří je okamžitě (fail-fast) (viz DoconutOptions → Startup validation) a zaregistruje kompletní graf služeb:

Služba	Životnost	Role
`DoconutOptions`	Singleton	Konfigurační objekt
`IViewerFactory`	Singleton	Mapuje rozšíření na prohlížeče formátů
`IDocumentSessionManager`	Singleton	Token → cache relace (`IMemoryCache` je také registrováno)
`IDoconutLicenseService`	Singleton	Licence načtená jednou při startu (priorita: `LicenseStream` → `LicenseContent` → `LicensePath` → automatické hledání)
`PageImageService`	Singleton	Pipeline pro obrázky stránek (vodoznak/rotace/škálování/poznámky)
Zabezpečení dokumentu (úložiště přístupů)	Singleton	Oprávnění pro vazbu token‑session
`Viewer`	Transient	Veřejná rozhraní pro otevření/uzavření
`DocumentConverter`	Transient	Rozhraní pro konverzi — vyžaduje plugin Converter
Kontrola zdraví `"doconut"`	—	Zpráva 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. Pokus o získání DocumentConverter bez options.AddPlugin<ConverterPlugin>() vyvolá výjimku:

text

InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

Plugin entitlement je ověřováno při startu. Chybějící licence, starý soubor TRIAL nebo placená licence bez registrované schopnosti pluginu selže v čase volání AddDoconut(). Dočasné/Demo registrace přežijí datum expirace, zatímco runtime brány odeberou vypršené schopnosti.

Health check se integruje se standardním mechanismem ASP.NET Core — namapujte jej, pokud chcete stav licence na vašem health endpointu:

csharp

app.MapHealthChecks("/health");

UseDoconut

text

IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Přidá middleware Doconut pro obrázky stránek. Odpovídá na každý požadavek obsahující dotazový parametr ?token= — stránky, náhledy, vyhledávání, poznámky, akce na stránkách (úplná tabulka požadavků je v Core Concepts → How the Viewer Works). Když je UnsafeMode nastaveno na false, vrstva zabezpečení dokumentu je automaticky zapojena před ní.

Referenční ukázka směruje požadavky widgetu přes větev cesty:

csharp

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

UseDoconutResources

text

IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

Obsluhuje vložené JS, CSS, obrázky a fonty na DoconutOptions.ResourcesPath (výchozí /doconut-res). Jedná se o soubory, pro které Viewer.ReferenceCss() / ReferenceScripts() generují značky.

Vždy jej zavolejte před UseDoconut(). Pokud je oblast prohlížeče prázdná a konzole prohlížeče ukazuje 404 chyby pro /doconut-res/..., tento volání chybí nebo je na špatném místě.

Shrnutí pořadí

csharp

app.UseRouting();
app.UseSession();          // required when UnsafeMode = false
app.UseDoconutResources(); // 1st Doconut call
app.UseDoconut();          // 2nd Doconut call (or via a MapWhen branch)