DoconutExtensions
Enregistrement des services et du middleware
DoconutExtensions (namespace Doconut.Middleware) est la classe statique contenant les trois appels que chaque hôte Doconut effectue : un enregistrement de service et deux enregistrements de middleware.
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession(); // appelez UseSession() avant UseDoconut()
app.UseDoconutResources(); // doit être enregistré avant UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());UseDoconut() répond à chaque requête qui l'atteint, donc montez‑le sur sa propre branche avec app.Map.
AddDoconut
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)Construit le DoconutOptions, les valide en échec rapide (voir DoconutOptions → Validation du démarrage), et enregistre le graphe complet des services :
| Service | Lifetime | Role |
|---|---|---|
DoconutOptions | Singleton | L'objet de configuration |
| Service de cache de session | Singleton | Token → cache de session (IMemoryCache est également enregistré) |
IDoconutLicenseService | Singleton | Licence chargée une fois au démarrage (priorité : LicenseStream → LicenseContent → LicensePath → recherche automatique) |
| Pipeline d'images de page | Singleton | Effectue le traitement d'image pour les pages (filigrane, rotation, mise à l'échelle, annotations) |
| Sécurité du document (magasin d'accès) | Singleton | Accorde la liaison token‑session |
Viewer | Transient | La façade publique d'ouverture/fermeture |
DocumentConverter | Transient | Façade de conversion — nécessite le plugin Converter |
DocumentSigner | Transient | Façade de signature — nécessite le plugin Signer (voir Plugin de signature) |
DistributedDocumentPublisher | Transient | Publie les artefacts d'un document vers le stockage partagé (voir Déploiements distribués) |
Health check "doconut" | — | Rapporte l'état de licence/expiration via les contrôles de santé ASP.NET |
Deux comportements utiles à connaître :
- Le convertisseur nécessite son plugin. Résoudre
DocumentConvertersansoptions.AddPlugin<ConverterPlugin>()génère :
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().DocumentSigner suit la même règle : sans options.AddPlugin<SignerPlugin>() il génère No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().
- L'attribution du plugin est validée au démarrage. Une licence manquante, un fichier legacy
TRIAL, ou une licence payante sans la capacité d'un plugin enregistré échoue au momentAddDoconut(). Les enregistrements temporaires/Demo survivent à leur date d'expiration, tandis que les garde‑fous d'exécution révoquent les capacités expirées.
Le contrôle de santé s'intègre au mécanisme standard d'ASP.NET Core — mappez‑le si vous souhaitez l'état de licence sur votre point de terminaison de santé :
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)Ajoute le middleware d'images de page Doconut. Il sert chaque requête contenant un paramètre de requête ?token= — pages, miniatures, recherche, annotations, actions de page (le tableau complet des requêtes se trouve dans Concepts de base → Comment le visualiseur fonctionne) — et répond à toute autre requête lui‑même avec 404 (ou la bannière ShowDoconutInfo) : il ne transmet jamais la requête au reste du pipeline. Montez‑le sur sa propre branche, comme dans les exemples de cette page. Lorsque UnsafeMode est false, la couche de sécurité du document est automatiquement connectée avant lui.
Une alternative courante conserve la forme historique de la requête DocImage.axd avec une branche MapWhen (le client utilise alors BasePath: '/') :
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)Serre les JS, CSS, images et polices intégrés à DoconutOptions.ResourcesPath (par défaut /doconut-res). Ce sont les fichiers pour lesquels Viewer.ReferenceCss() / ReferenceScripts() émettent des balises.
Appelez‑le toujours avant UseDoconut(). Si la zone du visualiseur reste vide et que la console du navigateur affiche des 404 pour /doconut-res/..., cet appel est manquant ou mal placé.
Servir depuis le stockage partagé
Deux enregistrements supplémentaires existent pour les déploiements où le nœud qui rend un document n'est pas forcément le nœud qui sert ses pages. Les deux sont couverts de bout en bout dans Déploiements distribués ; les signatures sont :
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // file d'attente de publication en arrière-plan opt-in
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // stockage de secours partagé pour les téléchargements de widgetsLe côté lecture est un middleware séparé provenant de l'assembly Doconut.Clouds, qui est fourni dans le même paquet :
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerRécapitulatif de l'ordre
app.UseRouting();
app.UseSession(); // appelez UseSession() avant UseDoconut()
app.UseDoconutResources(); // doit être enregistré avant UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // ou une branche MapIfCette page était-elle utile ?