התקנה
הוסף את Doconut לפרויקט .NET Standard 2.1 שלך
צופה הבסיס של Doconut עבור .NET Standard מגיע כחבילה יחידה של NuGet שניתן לחבר לכל יישום ASP.NET Core. תוספים אופציונליים משתמשים בחבילות נפרדות. דף זה מתקין את חבילת הבסיס, מאשר שהשרת שלך יכול לצרוך אותה, ורושם את ה‑middleware — המינימום הדרוש לפני הרינדור הראשון שלך.
בדוק תחילה את מסגרת השרת
הספרייה ממקדת את netstandard2.1. זהו חוזה צמוד יותר מהגרסה הקודמת netstandard2.0, והוא הדבר הראשון לאימות:
| שרת | נתמך |
|---|---|
| .NET Core 3.0 או מאוחר יותר, כולל .NET 5/6/7/8 | כן |
| .NET Framework (כל גרסה) | לא — netstandard2.1 אינו ניתן לצריכה על‑ידי .NET Framework |
החבילה פועלת רק על Windows. עבור שרת Linux, השתמש בDoconut.NET8 או בDoconut.NET6.
אם היישום פועל על .NET Framework, זו איננה החבילה המתאימה. השתמש בDoconut.NETFramework במקום; החל מ‑26.9.0 היא דורשת .NET Framework 4.7.2.
התקנת החבילה
dotnet add package Doconut.NETStandardהפקודה ללא גרסה מתקינה את הגרסה היציבה האחרונה. כדי לנעול את הגרסה המתוארת בתיעוד זה, העבר את הגרסה כאופציה נפרדת:
dotnet add package Doconut.NETStandard --version 26.10.0Doconut.NETStandard הוא מזהה החבילה. סיומת הגרסה שייכת לקובץ Doconut.NETStandard.<version>.nupkg שהורד ואינה חלק מהמזהה.
מספר הגרסה הוא הדור
זה חשוב יותר כאן מאשר שם החבילה. שני הדורות של ספריית .NET Standard מתפרסמים תחת אותו מזהה חבילה, ורק הגרסה מבחינה ביניהם:
| גרסה | יעד | API |
|---|---|---|
| 26.7.0 ומטה | netstandard2.0 | האינטגרציה הקודמת |
| 26.8.0 ומעלה | netstandard2.1 | האינטגרציה המתועדת כאן |
אין שכבת תאימות ואין חבילה ציד-צד. העלאת הגרסה היא השדרוג, והקומפיילר ידווח על ההבדלים ב‑API מיד.
אל תבחר תיעוד רק משם החבילה:
new Viewer(_cache, _accessor, …),UnSafeMode, synchronousOpenDocument(...),viewer.InitCache(),UseDoconutWebFarm, ו‑סקריפטים של הצופה שהועתקו ידנית מזהים את האינטגרציה הקודמת;AddDoconut(),UseDoconutResources(), injectedViewer, ו‑OpenDocumentAsync(...)מזהים את האינטגרציה הנוכחית המתועדת כאן.
המדריך המתורגם מדריך ההגדרה הקודם עדיין זמין. השתמש במדריך ההגירה כדי לשנות דורות; עדכון חבילה אינו ממיר את אתחול, חיי הצופה, או משאבי הדפדפן באופן אוטומטי.
רישום Doconut
AddDoconut() הוא נקודת הכניסה היחידה לרישום — יש עומס יחיד, והוא מחבר את שירות Viewer, שירות הרישיון, ותשתית הרינדור למכולת ה‑DI.
שני קריאות middleware משלים את ההגדרה, והסדר שלהן חשוב: UseDoconutResources() חייב לרוץ לפני UseDoconut(). UseDoconut() הוא middleware סופי, ולכן קריאה אליו ראשון גורמת לכך שכל בקשה לנכס /doconut-res לעולם לא תגיע למטפל המשאבים ותחזיר 404. UseDoconut() משיב לכל בקשה שמגיעה אליו, ולכן יש למקם אותו בסניף משלו עם app.Map. חיבור הסשן נדרש גם הוא — האבטחה ברירת המחדל של מסמכי Doconut מאמתת כל בקשת עמוד מול מצב הסשן של ASP.NET.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // מצב הסשן צריך מטמון (MVC/Razor Pages כבר מוסיפים אחד)
builder.Services.AddSession(); // אבטחת המסמך של Doconut מתבססת על מצב הסשן של ASP.NET
app.UseSession(); // קרא UseSession() לפני UseDoconut()
app.UseDoconutResources(); // חייב להיות רשום לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());מרחבי שמות
סוגי התצורה אינם מפוזרים יותר על פני ארבעה מרחבי שמות. במהדורה זו כמעט הכל נמצא במרחב השמות השורש Doconut:
using Doconut; // Viewer, DoconutOptions, DocOptions, כל תצורות הפורמט
using Doconut.Middleware; // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds; // תצורות ענן ושיתוף קבצים
using Doconut.Configs.Conversion; // ConversionTargetשמות הסוגים עצמם לא השתנו — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig והשאר עדיין קיימים. אם אתה מעביר יישום קיים, רוב הקבצים זקוקים רק לשתי שורות using שנמחקו; ראה את מדריך ההגירה.
כל האפשרויות
DoconutOptions מקבל את המאפיינים הניתנים להגדרה הבאים. כל אחד הוא אופציונלי — ברירות המחדל שלהלן חלות כאשר מאפיין נשאר ללא ערך.
| מאפיין | ברירת מחדל | תיאור |
|---|---|---|
ShowDoconutInfo | false | כאשר true, בקשה ללא token מחזירה באנר גרסה במקום 404. שימושי כבדיקה מהירה; השאר מושבת בייצור. |
UnsafeMode | false | כאשר true, מדלג על בדיקת האבטחה של ASP.NET‑session בבקשות עמוד. השאר מושבת בייצור. שים לב לאיות — הספרייה הקודמת קראה לזה UnSafeMode. |
MiddlewarePath | "/doconut" | ערך תיאום עבור נקודת הקצה page-image. הוא מאומת, אך אינו יוצר סניף בעצמו; שמור אותו מתואם עם המיפוי האמיתי של UseDoconut() והלקוח BasePath. |
ResourcesPath | "/doconut-res" | המקום שממנו משרתים משאבי JS/CSS/תמונה המוטמעים. |
LicensePath | "" (מחרוזת ריקה) | נתיב לקובץ הרישיון. ריק משמעותו לעבור למקור הבא, ואז חיפוש אוטומטי. |
LicenseContent | "" (מחרוזת ריקה) | תוכן רישיון גולמי — ממשתנה סביבתי, מנהל סודות, או מסד נתונים. |
LicenseStream | null | רישיון כזרם, נקרא פעם אחת באתחול. |
ResetLicense | false | דגל תאימות שמור. הרישיון נקרא במהלך AddDoconut(); הפעל מחדש את האפליקציה לאחר החלפת רישיון. |
MaxConcurrentEditorSessions | 200 | המספר המרבי של סשני עריכה חיה (מסמכים שנפתחים עם DocOptions.EditMode). מעליו, סשן עריכה לא פעיל שהשתמש בפחות זמן נסגר. סשני צופה רגילים אינם נספרים. 0 או ערך שלילי משמעותו שאין מגבלה. |
EditorSnapshotEveryOps | 50 | כאשר שמירת עריכה מופעלת (AddDoconutEditorPersistence), לוכד תמונת מצב של המסמך החי כל N שינויים מוקלטים. 0 או ערך שלילי אף פעם לא לוכד תמונת מצב באמצע סשן. אין השפעה כאשר שמירה מושבתת. |
קדימות רישיון כאשר מוגדר יותר ממקור אחד: LicenseStream גובר על LicenseContent גובר על LicensePath גובר על חיפוש אוטומטי — ראה את הגדרת רישיון.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.MiddlewarePath = "/doconut"; // תאם עם מיפוי האפליקציה ו‑BasePath של הלקוח
options.ResourcesPath = "/doconut-res"; // מאיפה משרתים את קבצי ה‑JS/CSS/תמונות של ה‑viewer
options.UnsafeMode = false; // שמור על אבטחת הסשן פעילה
options.ShowDoconutInfo = false;
});הצעדים הבאים
- התחלה מהירה — פתח את המסמך הראשון שלך והצג אותו בדפדפן.
- הגדרת רישיון — המקום שבו Doconut מחפש את קובץ הרישיון שלך.
האם דף זה היה מועיל?