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، يُعيد طلب الوسيط بدون رمز توكن شارة الإصدار (Doconut <version> is running on <host>) بدلاً من 404. مفيد كاختبار سريع؛ اترك false في بيئة الإنتاج.
boolUnsafeModefalseعند true، يتخطى فحص أمان جلسة ASP.NET على طلبات الصفحات. اترك false في بيئة الإنتاج (انظر المفاهيم الأساسية → الجلسات والأمان).
stringMiddlewarePath"/doconut"قيمة التنسيق لنقطة النهاية page-image. يتم التحقق منها، لكنها لا تُنشئ فرعًا في خط الأنابيب؛ حافظ على توافقها مع خريطة UseDoconut() الفعلية وBasePath للعميل.
stringResourcesPath"/doconut-res"بادئة مسار URL للموارد المدمجة JS/CSS/الصورة/الخط.
stringLicensePath""مسار ملف الترخيص. فارغ → مصدر الترخيص التالي، ثم الاكتشاف التلقائي؛ إذا لم يُعثر على شيء → حالة تقييم مائية العلامة بدون أي قدرات.
stringLicenseContent""محتوى الترخيص XML الخام (قاعدة البيانات، متغير البيئة، مدير الأسرار). له أولوية أعلى من LicensePath.
Stream?LicenseStreamnullالترخيص كتيار، يُقرأ مرة واحدة عند بدء التشغيل. له أولوية أعلى من كلا المصدرين الآخرين.
boolResetLicensefalseعلامة توافق محجوزة. تنفيذ .NET 6 الحالي لا يستخدمها؛ أعد تشغيل التطبيق بعد استبدال الترخيص.
DoconutPluginRegistryPluginRegistry—سجل للقراءة فقط يجمع مساهمات الإضافات؛ يُستهلك بواسطة مصنع العارض. املأه عبر AddPlugin<T>().

أولوية الترخيص (تُفرض عند تسجيل الخدمة): LicenseStream → LicenseContent → LicensePath → الاكتشاف التلقائي (انظر البدء → إعداد الترخيص).

الطرق

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

استخدم هذه الطريقة لحزم Converter و DICOM و Signer المتاحة بالاختيار. التعليقات والبحث العادي هي ميزات مرخصة مدمجة ولا تستخدم AddPlugin<TPlugin>().

يسجل إضافة من الطرف الأول (Converter، DICOM، Signer). طريقة سلسة — تُعيد كائن الخيارات. 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 عند وجود مصنع فارغ.

التحقق من بدء التشغيل

AddDoconut() يتحقق من صحة الخيارات بالفشل السريع، بحيث تظهر الأخطاء في التكوين كاستثناء واضح عند بدء التشغيل بدلاً من 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
// الإنتاج: ترخيص صريح، كل شيء مقفل (جميع إعدادات الأمان الافتراضية)
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').

هل كانت هذه الصفحة مفيدة؟