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 على طلبات الصفحات. اترك false في بيئة الإنتاج (انظر Core Concepts → Sessions & Security). |
string | MiddlewarePath | "/doconut" | قيمة التنسيق لنقطة النهاية page-image. يتم التحقق منها، لكنها لا تُنشئ فرعًا في خط الأنابيب؛ حافظ على توافقها مع خريطة UseDoconut() الفعلية وعميل BasePath. |
string | ResourcesPath | "/doconut-res" | بادئة مسار URL للموارد المدمجة JS/CSS/image/font. |
string | LicensePath | "" | المسار إلى ملف الترخيص. فارغ → مصدر الترخيص التالي، ثم الاكتشاف التلقائي؛ إذا لم يُعثر على شيء → حالة تقييم مائية العلامة بدون أي قدرات. |
string | LicenseContent | "" | محتوى الترخيص XML الخام (قاعدة البيانات، متغير البيئة، مدير الأسرار). له أولوية أعلى من LicensePath. |
Stream? | LicenseStream | null | الترخيص كتيار، يُقرأ مرة واحدة عند بدء التشغيل. له أولوية أعلى من كلا المصدرين الآخرين. |
bool | ResetLicense | false | علامة توافق محجوزة. تنفيذ .NET 8 الحالي لا يستخدمها؛ أعد تشغيل التطبيق بعد استبدال الترخيص. |
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.
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').
هل كانت هذه الصفحة مفيدة؟