DoconutExtensions

Registrering av tjänster och middleware

DoconutExtensions (namespace Doconut.Middleware) är den statiska klassen med de tre anropen som varje Doconut‑värd gör: en tjänstregistrering och två middleware‑registreringar.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // anropa UseSession() innan UseDoconut()
app.UseDoconutResources(); // måste registreras innan UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() svarar på varje begäran som når den, så montera den på sin egen gren med app.Map.

AddDoconut

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

Bygger DoconutOptions, validerar dem snabbt (se DoconutOptions → Startup validation), och registrerar hela tjänstgrafen:

ServiceLifetimeRole
DoconutOptionsSingletonKonfigurationsobjektet
Session cache serviceSingletonToken → session cache (IMemoryCache är också registrerad)
IDoconutLicenseServiceSingletonLicens laddad en gång vid start (prioritet: LicenseStream → LicenseContent → LicensePath → auto-search)
Page-image pipelineSingletonUtför bildbehandling för sidor (vattenstämpel, rotera, skala, annotationer)
Document security (access store)SingletonBeviljar token‑till‑sessionsbindning
ViewerTransientDen offentliga öppna/stänga-fasaden
DocumentConverterTransientKonverteringsfasad — kräver Converter‑plugin
DocumentSignerTransientSigneringsfasad — kräver Signer‑plugin (se Signer-plugin)
DistributedDocumentPublisherTransientPublicerar ett dokuments artefakter till delad lagring (se Distribuerade distributioner)
Health check "doconut"—Rapporterar licens-/utgångstillstånd via ASP.NET health checks

Två beteenden som är värda att känna till:

  • Converter kräver sin plugin. Att lösa DocumentConverter utan options.AddPlugin<ConverterPlugin>() kastar:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner följer samma regel: utan options.AddPlugin<SignerPlugin>() kastar den No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Pluginbehörighet valideras vid start. En saknad licens, gammal TRIAL‑fil, eller betald licens utan en registrerad plugins kapacitet misslyckas vid AddDoconut()‑tid. Tillfälliga/Demo‑registreringar överlever sitt utgångsdatum, medan körningstidens grindar återkallar de utgångna kapaciteterna.

Health check integreras med den standard ASP.NET Core‑mekanismen — mappa den om du vill ha licenstillstånd på ditt health‑endpoint:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Lägger till Doconut page-image‑middleware. Den betjänar varje begäran som har en ?token=‑frågeparameter — sidor, miniatyrer, sök, annotationer, sidåtgärder (den fullständiga begärantabellen finns i Core Concepts → Hur visaren fungerar) — och svarar på alla andra begäranden själva med 404 (eller ShowDoconutInfo‑banner): den vidarebefordrar aldrig en begäran till resten av pipelinen. Montera den på sin egen gren, som i exemplen på den här sidan. När UnsafeMode är false, kopplas dokument‑säkerhetslagret in automatiskt före den.

Ett vanligt alternativ behåller den historiska DocImage.axd‑begäransformen med en MapWhen‑gren (klienten använder då 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)

Servar den inbäddade JS, CSS, bilder och typsnitt på DoconutOptions.ResourcesPath (standard /doconut-res). Detta är filerna som Viewer.ReferenceCss() / ReferenceScripts() emitterar taggar för.

Anropa alltid den innan UseDoconut(). Om visningsområdet förblir tomt och webbläsarkonsolen visar 404‑fel för /doconut-res/..., saknas detta anrop eller är felplacerat.

Servering från delad lagring

Två ytterligare registreringar finns för distributioner där noden som renderar ett dokument inte nödvändigtvis är den nod som serverar dess sidor. Båda täcks helt och hållet i Distribuerade distributioner; signaturerna är:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // valfri bakgrundspubliceringskö
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // delad lagringsplats för widget-uppladdningar

Läs‑sidan är en separat middleware från Doconut.Clouds‑assemblyn, som levereras i samma paket:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

Sammanfattning av beställning

csharp
app.UseRouting();
app.UseSession();          // anropa UseSession() innan UseDoconut()
app.UseDoconutResources(); // måste registreras innan UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // eller en MapWhen-gren

Var den här sidan hjälpsam?