DoconutOptions
הגדרת שירותי Doconut
DoconutOptions (namespace Doconut) הוא האובייקט היחיד לתצורה של כל ה‑SDK. אתה מגדיר אותו פעם אחת, בתוך AddDoconut(), והוא נרשם כסינגלטון.
זה שינוי במיקום כמו גם בצורה. בספרייה הקודמת של .NET Standard,
DoconutOptions נוצר בזמן הצינור והועבר ל‑UseDoconut(new DoconutOptions { … }). כאן ה‑middleware אינו מקבל שום אפשרויות —
הכל מוגדר במהלך רישום השירות.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});מאפיינים
| סוג | מאפיין | ברירת מחדל | תיאור |
|---|---|---|---|
bool | ShowDoconutInfo | false | כאשר true, בקשת middleware ללא אסימון מחזירה באנר גרסה (Doconut <version> is running on <host>) במקום 404. שימושי כבדיקה מהירה; השאר את false בייצור. |
bool | UnsafeMode | false | כאשר true, מדלג על בדיקת האבטחה של ASP.NET‑session בבקשות דף. השאר את false בייצור על צומת יחיד (ראה מושגים מרכזיים → הפעלות & אבטחה). בעבר נכתב UnSafeMode. |
string | MiddlewarePath | "/doconut" | ערך תיאום לנקודת הקצה page-image. הוא מאומת, אך אינו יוצר ענף בצינור; שמור אותו תואם למיפוי UseDoconut() האמיתי ול‑client BasePath. |
string | ResourcesPath | "/doconut-res" | קידומת נתיב URL למשאבי JS/CSS/תמונה/גופן המוטמעים. |
string | LicensePath | "" | נתיב לקובץ הרישיון. ריק → מקור רישיון הבא, ואז גילוי אוטומטי; אם לא נמצא → מצב הערכה עם סימן מים וללא יכולות. |
string | LicenseContent | "" | תוכן רישיון XML גולמי (מסד נתונים, משתנה סביבתי, מנהל סודות). גובר על LicensePath. |
Stream? | LicenseStream | null | רישיון כזרם, נקרא פעם אחת בעת האתחול. גובר על שני המקורות האחרים. |
bool | ResetLicense | false | דגל תאימות שמור. המימוש הנוכחי אינו משתמש בו; הפעל מחדש את האפליקציה לאחר החלפת רישיון. |
DoconutPluginRegistry | PluginRegistry | — | רישום קריאה בלבד שאוסף תרומות תוספים; נצרך על ידי מפעל הצופה. מלא דרך AddPlugin<T>(). |
עדיפות רישיון (מוכלת ברישום השירות): LicenseStream → LicenseContent → LicensePath → גילוי אוטומטי (ראה התחלה → הגדרת רישיון).
שיטות
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()השתמש בשיטה זו עבור חבילות Converter, DICOM ו‑Signer שהושקו באופציית opt‑in. אנוטציה וחיפוש רגיל הם תכונות מורשות מובנות ואינן משתמשות ב‑AddPlugin<TPlugin>().
רושם תוסף ראשון‑צד (Converter, DICOM, Signer). שיטה זורמת — מחזיר את מופע האפשרויות. AddDoconut() זורק InvalidOperationException עבור רישיון חסר, קובץ TRIAL מיושן, או רישיון בתשלום שאינו מעניק לתוסף את היכולת. רישומים זמניים/דמו נשמרים לאחר תפוגה והופכים לחלק משער זמן הריצה (ראה מושגים מרכזיים → מערכת תוספים).
ווידג'ט ה‑Converter באופציית opt‑in מופעל עם AddConverterWidget() ומוצג דרך המאפיין הקריאה‑בלבד ConverterWidget; אפשרויותיו מתועדות בעמוד תוסף ה‑Converter (תוספים → תוסף Converter). ווידג'ט ה‑Signer באופציית opt‑in מופעל באותו אופן, עם AddSignerWidget(), ומוצג דרך המאפיין הקריאה‑בלבד SignerWidget; ראה תוסף Signer.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — הנקודה המקדימה אופציונלית
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)רושם צופה מותאם עבור סיומת קובץ. צופים מותאמים גוברים על צופים מובנים ותוספים ואינם מוגבלים ברישיון. כאשר defaultConfig מושמט וקובץ נפתח ללא תצורה מפורשת, משתמשים ב‑ImageConfig.
זורק ArgumentException (Extension must be a non-empty file extension.) עבור סיומת ריקה ו‑ArgumentNullException עבור מפעל null.
אימות אתחול
AddDoconut() מאמת את האפשרויות כשל‑מהיר, כך שהגדרה שגויה מתגלה כחריגה ברורה באתחול במקום 404s מבלבלים בזמן הבקשה:
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.תצורות נפוצות
// ייצור: רישיון מפורש, הכל נעול (כל ברירות המחדל של האבטחה)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// נתיבים מותאמים (למשל כדי להימנע מקונפליקט נתיב)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});כאשר אתה משנה את ResourcesPath, שמור את ResPath של ווידג'ט ה‑client מסונכרן (ראה ViewerConfig). זהו אחד משני ההגדרות בצד ה‑client שנכשלות ללא הודעת שגיאה.
MiddlewarePath אינו ממפה אוטומטי של נתיבי ASP.NET Core. אם Doconut צריך לענות רק מתחת לקידומת מותאמת, הרכב את UseDoconut() על אותו ענף (למשל עם app.Map("/docs-engine", branch => branch.UseDoconut())) והגדר את BasePath של ה‑client לאותה קידומת ללא ה‑/ המוביל ('docs-engine'). חלופה נפוצה שומרת על צורת הבקשה ההיסטורית DocImage.axd על ענף MapWhen עם BasePath: '/'.
האם דף זה היה מועיל?