DoconutOptions

הגדרת שירותי Doconut

DoconutOptions (namespace Doconut) הוא האובייקט התצורה היחיד לכל ה‑SDK. אתה מגדיר אותו פעם אחת, בתוך AddDoconut(), והוא נרשם כסינגלטון.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

מאפיינים

סוגמאפייןברירת מחדלתיאור
boolShowDoconutInfofalseכאשר true, בקשת middleware ללא טוקן מחזירה באנר גרסה (Doconut <version> is running on <host>) במקום 404. שימושי כבדיקה מהירה; השאר את false בייצור.
boolUnsafeModefalseכאשר true, מדלג על בדיקת האבטחה של ASP.NET‑session בבקשות דף. השאר את false בייצור (ראה מושגים מרכזיים → מושבים ואבטחה).
stringMiddlewarePath"/doconut"ערך תיאום עבור נקודת הקצה page‑image. הוא מאומת, אך אינו מרים סניף צינור; שמור אותו תואם למיפוי UseDoconut() האמיתי ול‑BasePath של הלקוח.
stringResourcesPath"/doconut-res"קידומת נתיב URL עבור משאבי JS/CSS/תמונה/גופן המוטמעים.
stringLicensePath""נתיב לקובץ הרישיון. ריק → מקור רישיון הבא, ואז גילוי אוטומטי; אם לא נמצא דבר → מצב הערכה עם סימן מים וללא יכולות.
stringLicenseContent""תוכן רישיון XML גולמי (מסד נתונים, משתנה סביבתי, מנהל סודות). גובר על LicensePath.
Stream?LicenseStreamnullרישיון כזרם, נקרא פעם אחת באתחול. גובר על שני מקורות אחרים.
boolResetLicensefalseדגל תאימות שמור. מימוש .NET 8 הנוכחי אינו משתמש בו; הפעל מחדש את היישום לאחר החלפת רישיון.
DoconutPluginRegistryPluginRegistry—רישום קריאה בלבד האוסף תרומות תוספים; נצרך על ידי מפעל הצופים. מלא דרך AddPlugin<T>().

קדימות רישיון (מוכלת ברישום השירות): LicenseStream → LicenseContent → LicensePath → גילוי אוטומטי (ראה התחלה → הגדרת רישיון).

שיטות

AddPlugin<TPlugin>()

text
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?)

text
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, כך שהגדרה שגויה מתגלה כחריגה ברורה באתחול במקום 404 מבלבל בזמן הבקשה:

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.

תצורות נפוצות

csharp
// Production: רישיון מפורש, הכל נעול (כל ברירות המחדל של האבטחה)
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').

האם דף זה היה מועיל?