Εγκατάσταση

Προσθέστε το Doconut στην εφαρμογή web .NET Framework 4.7.2 σας

Doconut.NETFramework φιλοξενεί το Doconut viewer σε μια κλασική εφαρμογή ASP.NET στο .NET Framework 4.7.2 — IIS ή IIS Express, MVC 5 ή Web Forms. Η εγκατάσταση έχει τρία μέρη: το πακέτο NuGet, δύο καταχωρίσεις στο Web.config, και μία κλήση στο Global.asax. Αυτή η σελίδα καλύπτει και τα τρία· Γρήγορη Εκκίνηση στη συνέχεια τοποθετεί ένα έγγραφο σε μια σελίδα.

Απαιτήσεις

  • Το web project στοχεύει .NET Framework 4.7.2 ή νεότερο. Ένα project 4.7 δεν μπορεί να χρησιμοποιήσει αυτό το πακέτο· πρέπει πρώτα να αλλάξει στόχο.
  • Ο ιστότοπος εκτελείται στην ενσωματωμένη pipeline (η προεπιλογή για τις πισίνες εφαρμογών IIS και IIS Express).
  • Ο διακομιστής εκτελεί Windows. Το πακέτο είναι μόνο για Windows.

Αυτή η σελίδα καλύπτει το Doconut.NETFramework 26.9.0 και μεταγενέστερα. Οι εκδόσεις 26.8.0 και παλαιότερες στόχευαν .NET Framework 4.7 με διαφορετικό API· αυτή η γραμμή έχει διακοπεί. Η ενημέρωση μιας υπάρχουσας εφαρμογής πέρα από αυτό το όριο καλύπτεται στη Μεταφορά.

Εγκατάσταση του πακέτου

Από την Κονσόλα Διαχείρισης Πακέτων:

powershell
Install-Package Doconut.NETFramework

Ή, σε ένα έργο τύπου SDK:

bash
dotnet add package Doconut.NETFramework

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

powershell
Install-Package Doconut.NETFramework -Version 26.10.0
bash
dotnet add package Doconut.NETFramework --version 26.10.0

Η μηχανή απόδοσης είναι ενσωματωμένη στο πακέτο: δεν υπάρχει ξεχωριστό assembly μηχανής για αναφορά, αντιγραφή ή ανάπτυξη. Προαιρετικές δυνατότητες διανέμονται ως δικά τους πακέτα — για παράδειγμα Doconut.NETFramework.Converter και Doconut.NETFramework.Dicom — και το καθένα απαιτεί άδεια που το παρέχει (δείτε το Σύστημα Πρόσθετων).

Διαμόρφωση Web.config

Το Doconut εξυπηρετεί δύο είδη αιτήσεων, και το IIS δρομολογεί και τα δύο μέσω του Web.config:

  • DocImage.axd — η σελίδα του viewer, το μικρογραφία, η αναζήτηση και το σημείο ανάλυσης, εξυπηρετούνται από το Doconut.DocImageHandler.
  • /doconut-res/* — τα δικά του scripts, stylesheets και εικονίδια του viewer, ενσωματωμένα στο assembly και εξυπηρετούνται από το Doconut.DoconutResourceModule.

Προσθέστε και τα δύο, μαζί με τις ρυθμίσεις από τις οποίες εξαρτώνται:

xml
<configuration>
  <system.web>
    <!-- Μόνο MVC 5: Το Razor μεταγλωττίζει τις προβολές κατά το χρόνο εκτέλεσης και χρειάζεται το πλαίσιο netstandard. -->
    <compilation targetFramework="4.7.2">
      <assemblies>
        <add assembly="netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51" />
      </assemblies>
    </compilation>
    <!-- maxRequestLength είναι σε KILOBYTES: 200 MB. -->
    <httpRuntime targetFramework="4.7.2" maxRequestLength="204800" />
    <!-- Διαβάστε τα αρχεία .cshtml και .aspx ως UTF-8, όχι ως τη σελίδα κώδικα ANSI του διακομιστή. -->
    <globalization fileEncoding="utf-8" requestEncoding="utf-8" responseEncoding="utf-8" />
  </system.web>
  <system.webServer>
    <security>
      <requestFiltering>
        <!-- maxAllowedContentLength είναι σε BYTES: το ίδιο 200 MB. -->
        <requestLimits maxAllowedContentLength="209715200" />
      </requestFiltering>
    </security>
    <modules runAllManagedModulesForAllRequests="true">
      <add name="DoconutResourceModule" type="Doconut.DoconutResourceModule, Doconut" />
    </modules>
    <handlers>
      <add name="DocImage" verb="GET,HEAD,POST" path="DocImage.axd"
           type="Doconut.DocImageHandler, Doconut" />
    </handlers>
  </system.webServer>
</configuration>

Κάθε γραμμή αποτρέπει μια αποτυχία που δεν εγείρει εξαίρεση:

  • verb="GET,HEAD,POST" — διατηρήστε το HEAD. Ο viewer στέλνει ένα αίτημα HEAD για τη σελίδα 1 ώστε να εντοπίσει κινούμενες εικόνες. Χωρίς το ρήμα, το IIS απαντά 404 πριν τρέξει ο διαχειριστής: τα έγγραφα εμφανίζονται, αλλά η ανίχνευση κίνησης δεν λειτουργεί ποτέ και η κονσόλα του προγράμματος περιήγησης γεμίζει με 404.
  • runAllManagedModulesForAllRequests="true" — τα /doconut-res/*.js, .css και .png μοιάζουν με στατικά αρχεία, και το IIS θα τα παραδώσει στον διαχειριστή στατικών αρχείων πριν το module πόρων τα δει. Το αποτέλεσμα είναι ένας viewer χωρίς scripts ή εικονίδια.
  • <globalization fileEncoding="utf-8"> — τα αρχεία σελίδας που αποθηκεύονται ως UTF-8 χωρίς byte-order mark διαβάζονται με την κωδικοποίηση ANSI του διακομιστή, έτσι κάθε μη-ASCII χαρακτήρας φθάνει στο πρόγραμμα περιήγησης διπλά κωδικοποιημένος (ένα em dash εμφανίζεται ως —). Το αρχείο είναι σωστό στο δίσκο, και η σελίδα εξακολουθεί να δηλώνει <meta charset="utf-8">.
  • Το assembly netstandard (MVC 5) — το Razor μεταγλωττίζει τις προβολές όταν ζητούνται για πρώτη φορά, με τη δική του λίστα αναφορών που δεν περιλαμβάνει αυτή τη διεπαφή. Μια προβολή που κάνει κάτι δυναμικό πέρα από απλή πρόσβαση σε μέλος αποτυγχάνει με CS0012 και επιστρέφει ένα κενό 500, και μόνο οι σελίδες που την ενεργοποιούν αποτυγχάνουν. Το σφάλμα μεταγλωττιστή εμφανίζεται μόνο στο αρχείο καταγραφής συμβάντων των Windows (πηγή ASP.NET). Οι εφαρμογές Web Forms δεν χρειάζονται αυτή τη γραμμή.
  • Όρια ανεβάσματος — το ASP.NET διαβάζει ολόκληρο το σώμα του αιτήματος πριν τρέξει οποιοσδήποτε διαχειριστής, έτσι ένα ανέβασμα πάνω από αυτά τα όρια απορρίπτεται από το IIS με τη δική του σελίδα σφάλματος. Διατηρήστε το maxRequestLength (kilobytes) και το maxAllowedContentLength (bytes) σε ισορροπία, και πάνω από το μεγαλύτερο αρχείο που οι χρήστες σας ανοίγουν ή ανεβάζουν.

Δύο ακόμη ρυθμίσεις έχουν σημασία, και και οι δύο συνήθως είναι ήδη σωστές:

  • Η κατάσταση συνεδρίας παραμένει ενεργή. Από προεπιλογή μια σελίδα εξυπηρετείται μόνο στη συνεδρία ASP.NET που άνοιξε το έγγραφο, έτσι ο ιστότοπος δεν πρέπει να ορίσει το <sessionState mode="Off" />. Δείτε το Συνεδρίες & Ασφάλεια.
  • Ανακατευθύνσεις binding. Διατηρήστε τις ανακατευθύνσεις binding <runtime> που το NuGet γράφει στο Web.config. Σε ένα έργο τύπου SDK, αντιγράψτε τις από το παραγόμενο bin\<YourApp>.dll.config, επειδή το κλασικό ASP.NET διαβάζει ανακατευθύνσεις μόνο από το Web.config. Μια ανακατεύθυνση που αναφέρει μια έκδοση που λείπει από το bin\ σταματά όλη την εφαρμογή με ένα κενό 500 κατά την εκκίνηση.

Καταχώριση Doconut στο Global.asax

Δεν υπάρχει δημιουργός και δεν υπάρχει pipeline μεσαίου λογισμικού στο System.Web. Το Doconut συντίθεται μία φορά ανά διεργασία εργαζόμενου από DoconutHost.Initialize στο Application_Start, και απελευθερώνεται από DoconutHost.Shutdown στο Application_End:

csharp
// Global.asax.cs
protected void Application_Start()
{
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    });
}

protected void Application_End()
{
    Doconut.DoconutHost.Shutdown();
}

DoconutHost.Initialize δημιουργεί τις υπηρεσίες, τον χειριστή, το μονάδα πόρων, και τη χρήση του δικού σας κώδικα. Ο κώδικάς σας τα προσεγγίζει μέσω DoconutHost.Services (δείτε DoconutHost). Μόνο η πρώτη κλήση ρυθμίζει οτιδήποτε· μια δεύτερη κλήση αγνοείται. Σε μια εφαρμογή MVC, διατηρήστε επίσης τις δύο διαδρομές του Doconut εκτός δρομολόγησης — Γρήγορη Εκκίνηση δείχνει το πλήρες Application_Start.

Όλες οι επιλογές

DoconutOptions δέχεται τις παρακάτω ρυθμιζόμενες ιδιότητες. Κάθε μία είναι προαιρετική.

ΙδιότηταΠροεπιλογήΠεριγραφή
UnsafeModefalseΌταν false, το DocImage.axd εξυπηρετεί μια σελίδα μόνο στη συνεδρία ASP.NET που άνοιξε το έγγραφο. Όταν true, εξυπηρετείται οποιοδήποτε αίτημα που μεταφέρει το token. Αφήστε το false.
ShowDoconutInfofalseΌταν true, ένα αίτημα DocImage.axd χωρίς token απαντά με μια μπάνερ έκδοσης αντί για 404. Χρήσιμο ως έλεγχος καπνού· αφήστε το απενεργοποιημένο στην παραγωγή.
ResourcesPath"/doconut-res"Πού το μονάδα πόρων εξυπηρετεί τα ενσωματωμένα σενάρια, στυλ και εικονίδια. Αλλάξτε το μόνο μαζί με το ResPath του προβολέα και οποιοδήποτε MVC IgnoreRoute.
LicensePath""Πλήρης διαδρομή προς το αρχείο άδειας. Κενό σημαίνει μετάβαση στην επόμενη πηγή, και μετά στην αυτόματη ανίχνευση.
LicenseContent""Ακατέργαστο περιεχόμενο άδειας — από μεταβλητή περιβάλλοντος, αποθήκη μυστικών ή βάση δεδομένων.
LicenseStreamnullΆδεια ως ροή, διαβάζεται μία φορά κατά την εκκίνηση.
MiddlewarePath"/doconut"Δεν χρησιμοποιείται σε αυτό το πακέτο. Το σημείο λήξης της σελίδας είναι ο χειριστής DocImage.axd που δηλώνεται στο Web.config, ό,τι και αν έχει οριστεί. Εξακολουθεί να επικυρώνεται: πρέπει να αρχίζει με / και να διαφέρει από ResourcesPath.
ResetLicensefalseΔεν χρησιμοποιείται σε αυτό το πακέτο. Η άδεια διαβάζεται μία φορά, στο DoconutHost.Initialize· επαναλάβετε την κυκλοφορία του application pool μετά την αντικατάσταση του αρχείου άδειας.
MaxConcurrentEditorSessions200Μέγιστος αριθμός ενεργών συνεδριών επεξεργαστή (έγγραφα ανοιγμένα με DocOptions.EditMode). Πάνω από αυτό, η λιγότερο πρόσφατα χρησιμοποιημένη αδρανής συνεδρία επεξεργαστή κλείνει. Οι κανονικές συνεδρίες προβολέα δεν μετρώνται ποτέ. 0 ή μια αρνητική τιμή σημαίνει χωρίς όριο.
EditorSnapshotEveryOps50Με ενεργοποιημένη τη διατήρηση επεξεργαστή (AddDoconutEditorPersistence), δημιουργήστε στιγμιότυπο του ζωντανού εγγράφου κάθε N καταγεγραμμένες αλλαγές. 0 ή μια αρνητική τιμή δεν δημιουργεί ποτέ στιγμιότυπα κατά τη διάρκεια της συνεδρίας. Δεν έχει καμία επίδραση όταν η διατήρηση είναι απενεργοποιημένη.

Όταν ορίζεται περισσότερη από μία πηγή άδειας, το LicenseStream υπερισχύει του LicenseContent, το οποίο υπερισχύει του LicensePath, το οποίο υπερισχύει της αυτόματης ανίχνευσης — δείτε Ρύθμιση Άδειας.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.ResourcesPath   = "/doconut-res"; // από πού εξυπηρετούνται τα JS/CSS/εικόνες του viewer
    options.UnsafeMode      = false;          // διατηρήστε την ασφάλεια του session ενεργή
    options.ShowDoconutInfo = false;
});
// Το σημείο λήξης της σελίδας δεν είναι επιλογή εδώ: είναι ο χειριστής DocImage.axd που δηλώνεται στο Web.config.

Επόμενα βήματα

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