DoconutExtensions

Registrering av tjänster och middleware

DoconutExtensions (namespace Doconut.Middleware) är den statiska klassen med de tre anrop 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:

TjänstLifetimeRoll
DoconutOptionsSingletonKonfigurationsobjektet
Session cache-tjänstSingletonToken → session cache (IMemoryCache är också registrerad)
IDoconutLicenseServiceSingletonLicens laddad en gång vid start (precedens: LicenseStream → LicenseContent → LicensePath → auto-search)
Page-image-pipelineSingletonUtför bildbehandling för sidor (vattenstämpel, rotera, skala, annotationer)
Dokumentsäkerhet (åtkomstlager)SingletonBeviljar bindning mellan token och session
ViewerTransientDet offentliga öppna/stänga‑gränssnittet
DocumentConverterTransientKonverteringsgränssnitt — kräver Converter‑plugin
DocumentSignerTransientSigneringsgränssnitt — kräver Signer‑plugin (se Signer-plugin)
DistributedDocumentPublisherTransientPublicerar ett dokuments artefakter till delat lagringsutrymme
Health check "doconut"—Rapporterar licens-/utgångstillstånd via ASP.NET health checks

Det finns inget motsvarande anrop i det tidigare .NET Standard‑biblioteket. Det konstruerade new Viewer(cache, accessor) per begäran och skickade alternativ till middleware; båda ersätts av denna enda registrering.

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, legacy 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 funktionerna.

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 hanterar varje begäran som har en ?token=‑frågeparameter — sidor, miniatyrer, sök, annotationer, sidåtgärder (den fullständiga begärantabellen finns i Kärnbegrepp → 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å denna sida. När UnsafeMode är false, så kopplas dokument‑säkerhetslagret in automatiskt före den.

Det tar inga argument. Att skicka en DoconutOptions‑instans här var det tidigare bibliotekets form och kompilerar inte längre.

En vanlig konfiguration behåller den historiska DocImage.axd‑begäransformen med en MapWhen‑gren (klienten använder sedan 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)

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

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

Detta är den stödjade ersättningen för att manuellt ansluta middleware för hantering av inbäddade resurser.

Serving from shared storage

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 helt 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ä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

UseDoconutWebFarm(...) och WebFarmOptions finns inte i denna version. Se migrationsguiden för inställning‑för‑inställning‑mappning.

Ordering recap

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?