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.
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
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)Bygger DoconutOptions, validerar dem fail-fast (se DoconutOptions → Startup validation), och registrerar hela tjänstgrafen:
| Tjänst | Livstid | Roll |
|---|---|---|
DoconutOptions | Singleton | Konfigurationsobjektet |
| Session cache-tjänst | Singleton | Token → session cache (IMemoryCache är också registrerad) |
IDoconutLicenseService | Singleton | Licens laddas en gång vid start (precedens: LicenseStream → LicenseContent → LicensePath → auto-search) |
| Page-image pipeline | Singleton | Utför bildbehandling för sidor (vattenstämpel, rotera, skala, annotationer) |
| Document security (access store) | Singleton | Beviljar token‑till‑session bindning |
Viewer | Transient | Den offentliga öppna/stänga-fasaden |
DocumentConverter | Transient | Konverteringsfasad — kräver Converter‑pluginen |
DocumentSigner | Transient | Signeringsfasad — kräver Signer‑pluginen (se Signer‑plugin) |
DistributedDocumentPublisher | Transient | Publicerar 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
DocumentConverterutanoptions.AddPlugin<ConverterPlugin>()kastar:
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, legacy
TRIAL‑fil, eller betald licens utan en registrerad plugins kapacitet misslyckas vidAddDoconut()‑tid. Tillfälliga/Demo-registreringar överlever sitt utgångsdatum, medan runtime-gates å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:
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)Lägger till Doconut page-image middleware. Den hanterar varje begäran som bär en ?token= query‑parameter — 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 pipeline. Montera den på sin egen gren, som i exemplen på denna sida. När UnsafeMode är false, så 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: '/'):
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)Serverar den inbäddade JS, CSS, bilder och teckensnitt på DoconutOptions.ResourcesPath (standard /doconut-res). Detta är filerna som Viewer.ReferenceCss() / ReferenceScripts() emitterar taggar för.
Anropa alltid den före UseDoconut(). Om visningsområdet förblir tomt och webbläsarkonsolen visar 404‑fel för /doconut-res/..., så saknas eller är detta anrop felplacerat.
Servering från delad lagring
Ytterligare två registreringar finns för distributioner där noden som renderar ett dokument inte nödvändigtvis är noden som serverar dess sidor. Båda täcks end‑to‑end i Distribuerade distributioner; signaturerna är:
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // valfri bakgrundspubliceringskö
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // delad lagringsplats för widget-uppladdningarLäs‑sidan är en separat middleware från Doconut.Clouds‑assemblyn, som levereras i samma paket:
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerSammanfattning av beställning
app.UseRouting();
app.UseSession(); // anropa UseSession() innan UseDoconut()
app.UseDoconutResources(); // måste registreras innan UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // eller en MapWhen-grenVar den här sidan hjälpsam?