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‑session را در درخواست‌های صفحه نادیده می‌گیرد. در محیط تولید false را نگه دارید (به Core Concepts → Sessions & Security مراجعه کنید).
stringMiddlewarePath"/doconut"مقدار هماهنگی برای نقطه انتهایی page‑image. این مقدار اعتبارسنجی می‌شود، اما شاخه‌ای از خط لوله را نصب نمی‌کند؛ آن را با نگاشت واقعی UseDoconut() و کلاینت BasePath هم‌راستا نگه دارید.
stringResourcesPath"/doconut-res"پیشوند مسیر URL برای منابع جاسازی‌شده JS/CSS/image/font.
stringLicensePath""مسیر فایل لایسنس. خالی → منبع لایسنس بعدی، سپس کشف خودکار؛ اگر چیزی یافت نشد → حالت ارزیابی با واترمارک و بدون قابلیت‌ها.
stringLicenseContent""محتوای خام XML لایسنس (پایگاه داده، متغیر محیطی، مدیر راز). بر LicensePath اولویت دارد.
Stream?LicenseStreamnullلایسنس به‌صورت جریان، یک‌بار در زمان راه‌اندازی خوانده می‌شود. بر هر دو منبع دیگر اولویت دارد.
boolResetLicensefalseپرچم سازگاری رزرو شده. پیاده‌سازی فعلی .NET 8 از آن استفاده نمی‌کند؛ پس از تعویض لایسنس برنامه را مجدداً راه‌اندازی کنید.
DoconutPluginRegistryPluginRegistry—ثبت‌نام فقط‑خواندنی که مشارکت‌های افزونه را جمع‌آوری می‌کند؛ توسط کارخانه نمایشگر مصرف می‌شود. از طریق AddPlugin<T>() پر کنید.

اولویت لایسنس (در زمان ثبت سرویس اعمال می‌شود): LicenseStream → LicenseContent → LicensePath → کشف خودکار (به Getting Started → License Setup مراجعه کنید).

متدها

AddPlugin<TPlugin>()

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

از این متد برای بسته‌های منتشر شدهٔ Converter، DICOM و Signer که به‌صورت opt‑in هستند استفاده کنید. ویژگی‌های حاشیه‌نویسی و جستجوی عادی به‌صورت داخلی دارای لایسنس هستند و از AddPlugin<TPlugin>() استفاده نمی‌کنند.

یک افزونهٔ داخلی (Converter، DICOM، Signer) را ثبت می‌کند. به‌صورت Fluent — نمونهٔ options را برمی‌گرداند. AddDoconut() برای لایسنس مفقود، فایل قدیمی TRIAL یا لایسنس پرداختی که قابلیت افزونه را اعطا نمی‌کند، InvalidOperationException را پرتاب می‌کند. ثبت‌نام‌های موقت/دمو پس از انقضا حفظ می‌شوند و تحت دروازهٔ زمان اجرا قرار می‌گیرند (به Core Concepts → Plugin System مراجعه کنید).

ویجت opt‑in Converter با AddConverterWidget() فعال می‌شود و از طریق ویژگی فقط‑خواندنی ConverterWidget در دسترس است؛ گزینه‌های آن در صفحهٔ افزونهٔ Converter (Plugins → Converter Plugin) مستند شده‌اند. ویجت opt‑in 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.) و برای کارخانهٔ null 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').

آیا این صفحه مفید بود؟