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í: jedna registrace služby a dvě registrace middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // zavolejte 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, provádí jejich okamžitou validaci (viz DoconutOptions → Startup validation) a registruje kompletní graf služeb:

SlužbaŽivotnostRole
DoconutOptionsSingletonKonfigurační objekt
Služba mezipaměti relaceSingletonToken → mezipaměť relace (IMemoryCache je také registrován)
IDoconutLicenseServiceSingletonLicence načtená jednou při startu (precedence: LicenseStream → LicenseContent → LicensePath → auto-search)
Pipeline pro obrázky stránekSingletonProvádí zpracování obrázků pro stránky (vodoznak, otáčení, škálování, anotace)
Zabezpečení dokumentu (úložiště přístupu)SingletonOprávnění pro vazbu token‑session
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ě
Health check "doconut"—Zprávy o stavu licence/expirace prostřednictvím ASP.NET health checks

V předchozí knihovně .NET Standard neexistuje ekvivalentní volání. Vytvářela new Viewer(cache, accessor) na požadavek a předávala možnosti middleware; oba jsou nahrazeny touto jednou registrací.

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 startu. Chybějící licence, starý soubor TRIAL nebo placená licence bez registrované schopnosti pluginu selže v čase 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ává middleware Doconut pro obrázky stránek. Obsluhuje každý požadavek nesoucí parametr dotazu ?token= — stránky, miniatury, vyhledávání, anotace, akce na stránkách (úplná tabulka požadavků je v Základní koncepty → Jak funguje prohlížeč) — a na jakýkoli jiný požadavek odpovídá pomocí 404 (nebo banneru ShowDoconutInfo): nikdy nepředává požadavek dál do zbytku pipeline. Připojte jej 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ím.

Nevyžaduje žádné argumenty. Předání instance DoconutOptions zde bylo ve staré knihovně a již se nekóduje.

Běžné nastavení 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). 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 pro /doconut-res/..., toto volání chybí nebo je na špatném místě.

Jedná se o podporovanou náhradu za ruční zapojení middleware pro zpracování vložených zdrojů.

Serving from shared storage

Další dvě registrace existují pro nasazení, kde uzel, který vykresluje dokument, není nutně uzel, který obsluhuje jeho stránky. Obě jsou kompletně pokryty v Distribuovaná nasazení; podpisy jsou:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // dobrovolná 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

UseDoconutWebFarm(...) a WebFarmOptions v tomto vydání neexistují. Viz průvodce migrací pro mapování nastavení po nastavení.

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // zavolejte 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á?