DoconutOptions
הגדרת שירותי Doconut
DoconutOptions (namespace Doconut) הוא האובייקט הקונפיגורציה היחיד לכל ה‑SDK. אתה מגדיר אותו פעם אחת, בתוך AddDoconut(), והוא נרשם כסינגלטון.
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 בייצור (ראה מושגי ליבה → מושבים ואבטחה). |
string | MiddlewarePath | "/doconut" | ערך תיאום עבור נקודת הקצה page-image. הוא מאומת, אך אינו יוצר ענף בצינור; שמור אותו תואם למיפוי UseDoconut() האמיתי ול‑BasePath של הלקוח. |
string | ResourcesPath | "/doconut-res" | קידומת נתיב URL עבור משאבי JS/CSS/תמונה/גופן המוטמעים. |
string | LicensePath | "" | נתיב לקובץ הרישיון. ריק → מקור רישיון הבא, ואז גילוי אוטומטי; אם לא נמצא דבר → מצב הערכה עם סימן מים וללא יכולות. |
string | LicenseContent | "" | תוכן רישיון XML גולמי (מסד נתונים, משתנה סביבתי, מנהל סודות). גובר על LicensePath. |
Stream? | LicenseStream | null | רישיון כזרם, נקרא פעם אחת בעת האתחול. גובר על שני המקורות האחרים. |
bool | ResetLicense | false | דגל תאימות שמור. המימוש הנוכחי של .NET 6 אינו משתמש בו; הפעל מחדש את היישום לאחר החלפת רישיון. |
DoconutPluginRegistry | PluginRegistry | — | רישום קריאה‑בלבד שמאגד תרומות של תוספים; נצרך על ידי מפעל הצופה. מלא באמצעות AddPlugin<T>(). |
עדיפות רישיון (מוכפפת ברישום השירות): LicenseStream → LicenseContent → LicensePath → גילוי אוטומטי (ראה התחלה → הגדרת רישיון).
מתודות
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()השתמש במתודה זו עבור חבילות Converter, DICOM ו‑Signer שהושקו עם אפשרות בחירה. אנוטציה ו
חיפוש רגיל הם תכונות מורשות מובנות ואינן משתמשות ב‑AddPlugin<TPlugin>().
רושם תוסף ראשון (Converter, DICOM, Signer). Fluent — מחזיר את מופע האופציות. AddDoconut() זורק InvalidOperationException עבור רישיון חסר, קובץ TRIAL מיושן, או רישיון בתשלום שאינו מעניק את היכולת לתוסף. רישומים זמניים/דמו נשמרים לאחר פקיעה והופכים להיות כפופים לשער זמן הריצה (ראה מושגי ליבה → מערכת תוספים).
הווידג'ט של Converter עם אפשרות בחירה מופעל באמצעות AddConverterWidget() ומוצג דרך המאפיין הקריאה‑בלבד ConverterWidget; אפשרויותיו מתועדות בעמוד תוסף Converter (תוספים → תוסף Converter). הווידג'ט של Signer עם אפשרות בחירה מופעל באותו אופן, עם 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() מאמת את האופציות fail-fast, כך שמצב קונפיגורציה שגוי מתגלה כחריגה ברורה באתחול במקום 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 של ווידג'ט הלקוח מסונכרן (ראה ViewerConfig).
MiddlewarePath אינו ממפה אוטומטי של נתיבי ASP.NET Core. אם Doconut צריך לענות רק מתחת לקידומת מותאמת, הרכב את UseDoconut() על הסניף הזה (לדוגמה עם app.Map("/docs-engine", branch => branch.UseDoconut())) והגדר את BasePath של הלקוח לקידומת הזו ללא ה‑/ המוביל ('docs-engine').
האם דף זה היה מועיל?