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.

csharp
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

text
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:

ServiceLifetimeRole
DoconutOptionsSingletonKonfigurační objekt
Session cache serviceSingletonToken → mezipaměť relace (IMemoryCache je také registrován)
IDoconutLicenseServiceSingletonLicence načtená jednou při spuštění (priorita: LicenseStream → LicenseContent → LicensePath → automatické hledání)
Page-image pipelineSingletonProvádí zpracování obrázků pro stránky (vodoznak, otáčení, škálování, anotace)
Document security (access store)SingletonUmožňuje vazbu token‑relace
ViewerTransientVeřejná rozhraní pro otevření/uzavření
DocumentConverterTransientRozhraní pro konverzi — vyžaduje plugin Converter
DocumentSignerTransientRozhraní pro podepisování — vyžaduje plugin Signer (viz Plugin pro podepisování)
DistributedDocumentPublisherTransientPublikuje 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í DocumentConverter bez options.AddPlugin<ConverterPlugin>() vyvolá výjimku:
text
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 TRIAL nebo placená licence bez registrované schopnosti pluginu selže v čase AddDoconut(). 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:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
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: '/'):

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). 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:

text
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:

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();          // volat UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // nebo větev MapWhen

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