DoconutOptions

Διαμόρφωση των υπηρεσιών Doconut

DoconutOptions (namespace Doconut) είναι το μοναδικό αντικείμενο διαμόρφωσης για ολόκληρο το SDK. Το ρυθμίζετε μία φορά, μέσα στο AddDoconut(), και καταχωρείται ως singleton.

Αυτή είναι μια αλλαγή τοποθεσίας όσο και μορφής. Στη προηγούμενη βιβλιοθήκη .NET Standard, ένα DoconutOptions instance δημιουργούνταν κατά το χρόνο του pipeline και παραδίδονταν στο UseDoconut(new DoconutOptions { … }). Εδώ το middleware δεν παίρνει καθόλου επιλογές — όλα ορίζονται κατά την καταχώρηση της υπηρεσίας.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Ιδιότητες

ΤύποςΙδιότηταΠροεπιλογήΠεριγραφή
boolShowDoconutInfofalseΌταν true, ένα αίτημα middleware χωρίς διακριτικό επιστρέφει μια λωρίδα έκδοσης (Doconut <version> is running on <host>) αντί για 404. Χρήσιμο ως γρήγορος έλεγχος· αφήστε το false σε παραγωγή.
boolUnsafeModefalseΌταν true, παραλείπει τον έλεγχο ασφαλείας της συνεδρίας ASP.NET στα αιτήματα σελίδας. Αφήστε το false σε παραγωγή σε έναν μοναδικό κόμβο (δείτε Βασικές Έννοιες → Συνεδρίες & Ασφάλεια). Προηγουμένως γραμμένο ως UnSafeMode.
stringMiddlewarePath"/doconut"Τιμή συντονισμού για το endpoint page-image. Επικυρώνεται, αλλά δεν δημιουργεί κλάδο pipeline· διατηρήστε το ευθυγραμμισμένο με την πραγματική αντιστοίχιση UseDoconut() και τον πελάτη BasePath.
stringResourcesPath"/doconut-res"Πρόθεμα διαδρομής URL για τους ενσωματωμένους πόρους JS/CSS/εικόνας/γραμματοσειράς.
stringLicensePath""Διαδρομή προς το αρχείο άδειας. Κενό → επόμενη πηγή άδειας, μετά αυτόματη ανίχνευση· αν δεν βρεθεί τίποτα → κατάσταση αξιολόγησης με υδατογράφημα χωρίς δυνατότητες.
stringLicenseContent""Ακατέργαστο περιεχόμενο άδειας XML (βάση δεδομένων, μεταβλητή περιβάλλοντος, διαχειριστής μυστικών). Έχει προτεραιότητα έναντι LicensePath.
Stream?LicenseStreamnullΆδεια ως ροή, διαβάζεται μία φορά κατά την εκκίνηση. Έχει προτεραιότητα έναντι και των δύο άλλων πηγών.
boolResetLicensefalseΔεσμευμένη σημαία συμβατότητας. Η τρέχουσα υλοποίηση δεν τη χρησιμοποιεί· επανεκκινήστε την εφαρμογή μετά την αντικατάσταση μιας άδειας.
DoconutPluginRegistryPluginRegistry—Κατάλογος μόνο για ανάγνωση που συλλέγει συνεισφορές plugins· χρησιμοποιείται από το εργοστάσιο προβολέα. Συμπληρώστε μέσω AddPlugin<T>().

Προτεραιότητα αδειών (επιβάλλεται κατά την καταχώρηση της υπηρεσίας): LicenseStream → LicenseContent → LicensePath → αυτόματη ανίχνευση (δείτε Ξεκινώντας → Ρύθμιση Άδειας).

Μέθοδοι

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Χρησιμοποιήστε αυτή τη μέθοδο για τα κυκλοφορημένα πακέτα Converter, DICOM και Signer με επιλογή opt‑in. Η Σχόλιο και η κανονική Αναζήτηση είναι ενσωματωμένες λειτουργίες με άδεια και δεν χρησιμοποιούν AddPlugin<TPlugin>().

Καταχωρεί ένα plugin πρώτου μέρους (Converter, DICOM, Signer). Fluent — επιστρέφει το αντικείμενο επιλογών. AddDoconut() ρίχνει InvalidOperationException για έλλειψη άδειας, παλιό αρχείο TRIAL, ή πληρωμένη άδεια που δεν παρέχει τη δυνατότητα του plugin. Οι προσωρινές/Δοκιμαστικές καταχωρίσεις διατηρούνται μετά τη λήξη και γίνονται υπόκειται στην πύλη χρόνου εκτέλεσης (δείτε Βασικές Έννοιες → Σύστημα Plugin).

Το widget Converter με επιλογή opt‑in ενεργοποιείται με AddConverterWidget() και εμφανίζεται μέσω της μόνο για ανάγνωση ιδιότητας ConverterWidget· οι επιλογές του τεκμηριώνονται στη σελίδα Converter Plugin (Plugins → Converter Plugin). Το widget Signer με επιλογή opt‑in ενεργοποιείται με τον ίδιο τρόπο, με AddSignerWidget(), και εμφανίζεται μέσω της μόνο για ανάγνωση ιδιότητας SignerWidget· δείτε Πρόσθετο Υπογραφέα.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — προαιρετικό το αρχικό τελεία
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Καταχωρεί έναν προσαρμοσμένο προβολέα για μια επέκταση αρχείου. Οι προσαρμοσμένοι προβολείς έχουν προτεραιότητα έναντι των ενσωματωμένων και των προβολέων plugins και δεν περιορίζονται από άδεια. Όταν το defaultConfig παραλείπεται και ένα έγγραφο ανοίγει χωρίς ρητή διαμόρφωση, χρησιμοποιείται ένα ImageConfig.

Ρίχνει ArgumentException (Extension must be a non-empty file extension.) για κενή επέκταση και ArgumentNullException για null factory.

Επικύρωση εκκίνησης

AddDoconut() επικυρώνει τις επιλογές fail‑fast, ώστε μια λανθασμένη διαμόρφωση να εμφανίζεται ως σαφής εξαίρεση κατά την εκκίνηση αντί για μπερδεμένα 404 κατά το χρόνο αιτήματος:

text
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.

Κοινές διαμορφώσεις

csharp
// Production: ρητή άδεια, όλα κλειδωμένα (όλες οι προεπιλογές ασφαλείας)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// Προσαρμοσμένες διαδρομές (π.χ. για αποφυγή σύγκρουσης διαδρομής)
builder.Services.AddDoconut(options =>
{
    options.MiddlewarePath = "/docs-engine";
    options.ResourcesPath  = "/docs-assets";
});

Όταν αλλάζετε το ResourcesPath, διατηρήστε το ResPath του widget πελάτη σε συγχρονισμό (δείτε ViewerConfig). Αυτό είναι ένα από τα δύο client‑side settings που αποτυγχάνουν χωρίς μήνυμα σφάλματος.

MiddlewarePath δεν είναι αυτόματος χάρτης διαδρομών ASP.NET Core. Εάν το Doconut πρέπει να απαντά μόνο κάτω από ένα προσαρμοσμένο πρόθεμα, τοποθετήστε το UseDoconut() σε αυτόν τον κλάδο (για παράδειγμα με app.Map("/docs-engine", branch => branch.UseDoconut())) και ορίστε το client BasePath σε αυτό το πρόθεμα χωρίς το αρχικό / ('docs-engine'). Μια κοινή εναλλακτική διατηρεί το ιστορικό σχήμα αιτήματος DocImage.axd σε κλάδο MapWhen με BasePath: '/'.

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