DoconutOptions

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

DoconutOptions (namespace Doconut) είναι το μοναδικό αντικείμενο διαμόρφωσης για ολόκληρο το SDK. Το διαμορφώνετε μία φορά, στην κλήση επιστροφής που περνάτε στο DoconutHost.Initialize στο Application_Start.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Ιδιότητες

ΤύποςΙδιότηταΠροεπιλογήΠεριγραφή
boolUnsafeModefalseΌταν false, το DocImage.axd εξυπηρετεί μια σελίδα μόνο στη συνεδρία ASP.NET που άνοιξε το έγγραφο (ή, σε φάρμα, στον περιηγητή με υπογεγραμμένα ονόματα εισιτηρίων). Όταν true, εξυπηρετείται οποιοδήποτε αίτημα που μεταφέρει το token. Αφήστε το false — δείτε Συνεδρίες & Ασφάλεια.
boolShowDoconutInfofalseΌταν true, ένα αίτημα DocImage.axd χωρίς token απαντά Doconut <version> is running on <host> αντί για 404. Χρήσιμο ως έλεγχος καπνού· αφήστε το false σε παραγωγή.
stringResourcesPath"/doconut-res"Πρόθεμα URL κάτω από το οποίο το μοντέλο πόρων εξυπηρετεί τα ενσωματωμένα σενάρια, στυλ και εικόνες.
stringLicensePath""Πλήρης διαδρομή προς το αρχείο άδειας. Κενό → η επόμενη πηγή άδειας, μετά αυτόματη ανίχνευση· αν δεν βρεθεί τίποτα → αξιολόγηση με υδατογράφημα χωρίς δυνατότητες.
stringLicenseContent""Ακατέργαστο περιεχόμενο άδειας (βάση δεδομένων, μεταβλητή περιβάλλοντος, αποθήκη μυστικών). Έχει προτεραιότητα έναντι του LicensePath.
Stream?LicenseStreamnullΆδεια ως ροή, διαβάζεται μία φορά κατά την εκκίνηση. Έχει προτεραιότητα έναντι και των άλλων πηγών.
stringMiddlewarePath"/doconut"Δεν χρησιμοποιείται από το System.Web. Το σημείο λήξης της σελίδας είναι πάντα ο χειριστής DocImage.axd που δηλώνεται στο Web.config. Η τιμή εξακολουθεί να επικυρώνεται κατά την εκκίνηση (δείτε παρακάτω).
boolResetLicensefalseΔεν χρησιμοποιείται. Η άδεια διαβάζεται μία φορά, στο DoconutHost.Initialize· επαναλάβετε το pool της εφαρμογής μετά την αντικατάσταση μιας άδειας.
DoconutPluginRegistryPluginRegistry—Καταχώρηση μόνο για ανάγνωση των συνεισφορών plugin, γεμίζεται από το AddPlugin<T>().

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

Μέθοδοι

AddPlugin<TPlugin>()

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

Καταχωρεί ένα plugin (Converter, DICOM, Signer). Fluent — επιστρέφει το αντικείμενο επιλογών. Τα Annotation και Search είναι ενσωματωμένα χαρακτηριστικά με άδεια και δεν το χρησιμοποιούν.

Εάν καμία ενεργή άδεια δεν χορηγεί τη δυνατότητα του plugin, το DoconutHost.Initialize ρίχνει το InvalidOperationException από το Application_Start, και ο ιστότοπος απαντά κάθε αίτημα με ένα κενό 500 μέχρι να διορθωθεί· το μήνυμα βρίσκεται στο αρχείο καταγραφής συμβάντων των Windows (δείτε Σύστημα Πρόσθετων).

Add…Widget()

text
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)

Τα ενσωματωμένα widgets είναι απενεργοποιημένα από προεπιλογή. Κάθε κλήση Add…Widget() ενεργοποιεί τα σημεία λήξης του widget στο DocImage.axd και απαιτεί την καταχώρηση του αντίστοιχου plugin. Το μοντέλο πόρων εξυπηρετεί το script του widget είτε το έχετε ενεργοποιήσει είτε όχι, έτσι ένα widget που φορτώνει και σχεδιάζει αλλά απαντά 404 στην πρώτη του ενέργεια λείπει αυτή η κλήση. Το widget Converter τεκμηριώνεται στο Plugin Μετατροπέα; το widget Signer, AddSignerWidget(), στο Plugin Υπογραφέα.

RegisterViewer(extension, factory, defaultConfig?)

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

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

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

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

DoconutHost.Initialize επικυρώνει τις επιλογές πριν δημιουργηθεί οτιδήποτε:

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.

MiddlewarePath ελέγχεται παρόλο που το System.Web δεν το χρησιμοποιεί ποτέ, οπότε αφήστε το στην προεπιλογή του. Όπως κάθε εξαίρεση που ρίχνεται από το Application_Start, μια αποτυχία επικύρωσης εμφανίζεται ως κενό 500 σε κάθε αίτημα, με το μήνυμα στο αρχείο καταγραφής συμβάντων των Windows.

Συνηθισμένες διαμορφώσεις

csharp
// Παραγωγή: ρητή άδεια, όλα τα υπόλοιπα στην ασφαλή προεπιλογή τους.
public static void ProductionLicense() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
    });

// Προσαρμοσμένη διαδρομή πόρων (π.χ. για αποφυγή σύγκρουσης διαδρομής). Διατηρήστε το ResPath του viewer και οποιοδήποτε MVC
// IgnoreRoute σε συγχρονισμό με αυτό: "/docs-assets" σημαίνει ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.ResourcesPath = "/docs-assets";
    });

Όταν αλλάζετε το ResourcesPath, αλλάξτε τρία πράγματα μαζί: την επιλογή, το ResPath του widget ('docs-assets/images' για "/docs-assets"), και, στο MVC, το IgnoreRoute για τη διαδρομή του πόρου (routes.IgnoreRoute("docs-assets/{*pathInfo}")). Το σημείο λήξης DocImage.axd δεν μετακινείται: η διαδρομή του ορίζεται από το χαρακτηριστικό path του χειριστή στο Web.config.

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