DoconutExtensions

Καταχώρηση υπηρεσιών και middleware

DoconutExtensions (namespace Doconut.Middleware) είναι η στατική κλάση με τις τρεις κλήσεις που κάνει κάθε φιλοξενητής Doconut: μία καταχώρηση υπηρεσίας και δύο καταχωρήσεις middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // καλέστε UseSession() πριν UseDoconut()
app.UseDoconutResources(); // πρέπει να καταχωρηθεί πριν UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() απαντά σε κάθε αίτηση που το φθάνει, οπότε τοποθετήστε το σε δικό του κλάδο με app.Map.

AddDoconut

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

Δημιουργεί το DoconutOptions, τα επικυρώνει άμεσα (δείτε DoconutOptions → Startup validation), και καταχωρεί το πλήρες γράφημα υπηρεσιών:

ΥπηρεσίαΔιάρκεια ζωήςΡόλος
DoconutOptionsSingletonΤο αντικείμενο διαμόρφωσης
Υπηρεσία προσωρινής μνήμης συνεδρίαςSingletonToken → session cache (IMemoryCache εγγράφεται επίσης)
IDoconutLicenseServiceSingletonΆδεια που φορτώνεται μία φορά κατά την εκκίνηση (προτεραιότητα: LicenseStream → LicenseContent → LicensePath → auto-search)
Διαδικασία εικόνας σελίδαςSingletonΕκτελεί επεξεργασία εικόνας για σελίδες (υδατογράφημα, περιστροφή, κλιμάκωση, σημειώσεις)
Ασφάλεια εγγράφου (αποθήκη πρόσβασης)SingletonΔικαιώματα για σύνδεση token-σε-συνεδρία
ViewerTransientΗ δημόσια διεπαφή ανοίγματος/κλεισίματος
DocumentConverterTransientΔιεπαφή μετατροπής — απαιτεί το πρόσθετο Converter
DocumentSignerTransientΔιεπαφή υπογραφής — απαιτεί το πρόσθετο Signer (δείτε Πρόσθετο Υπογραφής)
DistributedDocumentPublisherTransientΔημοσιεύει τα τεχνικά στοιχεία ενός εγγράφου σε κοινόχρηστη αποθήκευση
Health check "doconut"—Αναφέρει την κατάσταση άδειας/λήξης μέσω ελέγχων υγείας ASP.NET

Δεν υπάρχει αντίστοιχη κλήση στην προηγούμενη βιβλιοθήκη .NET Standard. Δημιούργησε new Viewer(cache, accessor) ανά αίτηση και πέρασε επιλογές στο middleware· και τα δύο αντικαθίστανται από αυτή τη μοναδική καταχώρηση.

Δύο συμπεριφορές που αξίζει να γνωρίζετε:

  • Ο Converter απαιτεί το πρόσθετό του. Η επίλυση του DocumentConverter χωρίς options.AddPlugin<ConverterPlugin>() προκαλεί εξαίρεση:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner ακολουθεί τον ίδιο κανόνα: χωρίς options.AddPlugin<SignerPlugin>() προκαλεί No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Η δικαιοδοσία του πρόσθετου επικυρώνεται κατά την εκκίνηση. Ένα ελλιπές άδεια, αρχείο legacy TRIAL, ή επί πληρωμή άδεια χωρίς καταχωρημένη δυνατότητα πρόσθετου αποτυγχάνει στην ώρα AddDoconut(). Οι προσωρινές/Δοκιμαστικές καταχωρήσεις επιβιώνουν μετά τη λήξη τους, ενώ οι πύλες χρόνου εκτέλεσης ανακαλούν τις ληγμένες δυνατότητες.

Ο έλεγχος υγείας ενσωματώνεται με τον τυπικό μηχανισμό ASP.NET Core — χαρτογραφήστε το αν θέλετε την κατάσταση της άδειας στο health endpoint σας:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Προσθέτει το middleware εικόνας σελίδας Doconut. Εξυπηρετεί κάθε αίτηση που περιέχει την παράμετρο ερωτήματος ?token= — σελίδες, μικρογραφίες, αναζήτηση, σημειώσεις, ενέργειες σελίδας (ο πλήρης πίνακας αιτήσεων βρίσκεται στα Core Concepts → How the Viewer Works) — και απαντά σε οποιαδήποτε άλλη αίτηση με 404 (ή το banner ShowDoconutInfo): δεν περνάει ποτέ μια αίτηση στο υπόλοιπο pipeline. Τοποθετήστε το σε δικό του κλάδο, όπως στα παραδείγματα σε αυτή τη σελίδα. Όταν UnsafeMode είναι false, το επίπεδο ασφάλειας εγγράφου ενσωματώνεται αυτόματα πριν από αυτό.

Δεν παίρνει ορίσματα. Η μεταβίβαση ενός αντικειμένου DoconutOptions εδώ ήταν η μορφή της προηγούμενης βιβλιοθήκης και πλέον δεν μεταγλωττίζεται.

Μια κοινή ρύθμιση διατηρεί το ιστορικό σχήμα αίτησης DocImage.axd με έναν κλάδο MapWhen (ο πελάτης τότε χρησιμοποιεί 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)

Εξυπηρετεί τα ενσωματωμένα JS, CSS, εικόνες και γραμματοσειρές στο DoconutOptions.ResourcesPath (προεπιλογή /doconut-res). Αυτά είναι τα αρχεία για τα οποία τα Viewer.ReferenceCss() / ReferenceScripts() δημιουργούν ετικέτες.

Πάντα καλέστε το πριν από UseDoconut(). Αν η περιοχή προβολής παραμένει κενή και η κονσόλα του προγράμματος περιήγησης εμφανίζει 404 για /doconut-res/..., αυτή η κλήση λείπει ή είναι τοποθετημένη λανθασμένα.

Αυτή είναι η υποστηριζόμενη αντικατάσταση για τη χειροκίνητη σύνδεση του middleware διαχείρισης ενσωματωμένων πόρων.

Serving from shared storage

Δύο επιπλέον καταχωρήσεις υπάρχουν για αναπτύξεις όπου ο κόμβος που δημιουργεί ένα έγγραφο δεν είναι απαραίτητα ο κόμβος που εξυπηρετεί τις σελίδες του. Και οι δύο καλύπτονται πλήρως στο Κατανεμημένες Αναπτύξεις; οι υπογραφές είναι:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // ουρά δημοσίευσης παρασκηνίου με επιλογή συμμετοχής
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // κοινόχρηστη αποθήκη υποστήριξης για μεταφορτώσεις widget

Η πλευρά ανάγνωσης είναι ένα ξεχωριστό middleware από τη συναρμολόγηση Doconut.Clouds, η οποία διανέμεται στο ίδιο πακέτο:

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

UseDoconutWebFarm(...) και WebFarmOptions δεν υπάρχουν σε αυτή την έκδοση. Δείτε τον οδηγός μετάβασης για τη χαρτογράφηση ρύθμισης-προς-ρύθμιση.

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // καλέστε UseSession() πριν UseDoconut()
app.UseDoconutResources(); // πρέπει να καταχωρηθεί πριν UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // ή κλάδος MapWhen

Ήταν αυτή η σελίδα χρήσιμη;