DoconutExtensions

Registrace služeb a middleware

DoconutExtensions (namespace Doconut.Middleware) je statická třída se třemi voláními, která každý hostitel Doconut provádí: jedno registraci 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ě (viz DoconutOptions → Ověření při spuštění) a zaregistruje kompletní graf služeb:

SlužbaŽivotnostRole
DoconutOptionsSingletonObjekt s konfigurací
IViewerFactorySingletonMapuje přípony na prohlížeče formátů
IDocumentSessionManagerSingletonToken → cache relace (IMemoryCache je také registrována)
IDoconutLicenseServiceSingletonLicence načtená jednou při spuštění (priorita: LicenseStreamLicenseContentLicensePath → automatické hledání)
PageImageServiceSingletonPipeline pro obrázky stránek (vodoznak/rotace/škálování/anotace)
Zabezpečení dokumentu (úložiště přístupů)SingletonUdělení oprávnění pro svázání tokenu s relací
ViewerTransientVeřejné rozhraní pro otevření/uzavření
DocumentConverterTransientRozhraní pro konverzi — vyžaduje plugin Converter
Kontrola zdraví "doconut"Zpráva o stavu licence/expirace prostřednictvím ASP.NET kontrol zdraví

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>().
  • Oprávnění pluginu je ověřeno při spuštění. Chybějící licence, starý soubor TRIAL nebo placená licence bez registrované schopnosti pluginu selže v okamžiku volání AddDoconut(). Dočasné/Demo registrace přežijí datum vypršení, 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:

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, miniatury, vyhledávání, anotace, akce na stránce (úplná tabulka požadavků je v Základní koncepty → Jak funguje prohlížeč). Když je UnsafeMode nastaveno na false, vrstva zabezpečení dokumentu je automaticky připojena 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 vieweru prázdná a konzole prohlížeče zobrazuje 404 chyby pro /doconut-res/..., toto 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)

Byla tato stránka užitečná?