DoconutExtensions

Καταχώρηση υπηρεσιών και μεσαζόντων

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

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 → προσωρινή μνήμη συνεδρίας (IMemoryCache επίσης καταχωρείται)
IDoconutLicenseServiceSingletonΆδεια που φορτώνεται μία φορά κατά την εκκίνηση (προτεραιότητα: LicenseStream → LicenseContent → LicensePath → αυτόματη αναζήτηση)
Διαδικασία εικόνας σελίδαςSingletonΕκτελεί επεξεργασία εικόνας για σελίδες (υδατογράφημα, περιστροφή, κλιμάκωση, σημειώσεις)
Ασφάλεια εγγράφου (αποθήκευση πρόσβασης)SingletonΠαρέχει δικαιώματα για σύνδεση token-σε-συνεδρία
ViewerTransientΗ δημόσια διεπαφή ανοίγματος/κλεισίματος
DocumentConverterTransientΔιεπαφή μετατροπής — απαιτεί το πρόσθετο Converter
DocumentSignerTransientΔιεπαφή υπογραφής — απαιτεί το πρόσθετο Signer (δείτε Πρόσθετο Signer)
DistributedDocumentPublisherTransientΔημοσιεύει τα τεχνικά αρχεία ενός εγγράφου σε κοινόχρηστη αποθήκευση (δείτε Διανεμημένες Υλοποιήσεις)
Έλεγχος υγείας "doconut"—Αναφέρει την κατάσταση άδειας/λήξης μέσω ελέγχων υγείας ASP.NET

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

  • Ο 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>().

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

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

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

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

Μια κοινή εναλλακτική διατηρεί το ιστορικό σχήμα αιτήματος 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/..., αυτή η κλήση λείπει ή είναι τοποθετημένη λανθασμένα.

Εξυπηρέτηση από κοινόχρηστη αποθήκευση

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

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

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

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

Περίληψη σειράς

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

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