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 على طلبات الصفحات. اترك false في بيئة الإنتاج على عقدة واحدة (انظر Core Concepts → Sessions & Security). كان يُكتب سابقاً UnSafeMode. |
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 | علامة توافق محجوزة. التنفيذ الحالي لا يستخدمها؛ أعد تشغيل التطبيق بعد استبدال الترخيص. |
DoconutPluginRegistry | PluginRegistry | — | سجل قراءة فقط يجمع مساهمات الإضافات؛ يُستهلك من قبل مصنع العارض. املأه عبر AddPlugin<T>(). |
أولوية الترخيص (تُفرض عند تسجيل الخدمة): LicenseStream → LicenseContent → LicensePath → الاكتشاف التلقائي (انظر Getting Started → License Setup).
الطرق
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()استخدم هذه الطريقة للحزم المصدرة من Converter و DICOM و Signer التي تتطلب اختيارًا. التعليقات والبحث العادي هما ميزتان مدمجتان مرخصتان ولا تستخدمان AddPlugin<TPlugin>().
يسجل إضافة من الطرف الأول (Converter، DICOM، Signer). سائل — يُعيد كائن الخيارات. AddDoconut() يطرح InvalidOperationException عند عدم وجود ترخيص، أو ملف TRIAL قديم، أو ترخيص مدفوع لا يمنح قدرة الإضافة. تُحفظ التسجيلات المؤقتة/التجريبية بعد انتهاء الصلاحية وتصبح خاضعة لبوابة وقت التشغيل (انظر Core Concepts → Plugin System).
يتم تمكين عنصر واجهة Converter الاختياري باستخدام AddConverterWidget() ويظهر عبر الخاصية القراءة فقط ConverterWidget؛ خياراته موثقة في صفحة إضافة Converter (Plugins → Converter Plugin). يتم تمكين عنصر واجهة Signer الاختياري بنفس الطريقة، باستخدام AddSignerWidget()، ويظهر عبر الخاصية القراءة فقط SignerWidget؛ انظر Signer Plugin.
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 عند وجود مصنع فارغ.
التحقق من بدء التشغيل
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 لعنصر واجهة العميل (انظر ViewerConfig). هذا أحد الإعدادين على جانب العميل الذين يفشلان دون رسالة خطأ.
MiddlewarePath ليس مُحدد مسارات ASP.NET Core تلقائيًا. إذا كان يجب على Doconut الرد فقط تحت بادئة مخصصة، قم بتركيب UseDoconut() على ذلك الفرع (مثلاً باستخدام app.Map("/docs-engine", branch => branch.UseDoconut())) واضبط عميل BasePath على تلك البادئة بدون الـ / المتقدم ('docs-engine'). بديل شائع يحافظ على شكل طلب DocImage.axd التاريخي على فرع MapWhen مع BasePath: '/'.
هل كانت هذه الصفحة مفيدة؟