DoconutOptions
پیکربندی سرویسهای Doconut
DoconutOptions (namespace Doconut) یک شیء پیکربندی تک برای کل SDK است. شما آن را یک بار، داخل AddDoconut()، پیکربندی میکنید و به عنوان یک تکنمونه (singleton) ثبت میشود.
این تغییر هم در مکان و هم در شکل است. در کتابخانه قبلی .NET Standard یک نمونه DoconutOptions در زمان خط لوله ساخته میشد و به UseDoconut(new DoconutOptions { … }) تحویل داده میشد. در اینجا میدلور هیچ گزینهای نمیگیرد — همه چیز در زمان ثبت سرویس تنظیم میشود.
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، یک درخواست میدلور بدون توکن بنر نسخه (Doconut <version> is running on <host>) را به جای 404 برمیگرداند. برای بررسی سریع مفید است؛ در محیط تولید false را نگه دارید. |
bool | UnsafeMode | false | هنگامی که true، بررسی امنیتی جلسه ASP.NET را در درخواستهای صفحه نادیده میگیرد. در محیط تولید بر روی یک گره واحد false را نگه دارید (به مفاهیم اصلی → جلسات و امنیت مراجعه کنید). پیش از این به صورت UnSafeMode نوشته میشد. |
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 | پرچم سازگاری رزرو شده. پیادهسازی فعلی از آن استفاده نمیکند؛ پس از جایگزینی مجوز، برنامه را مجدداً راهاندازی کنید. |
DoconutPluginRegistry | PluginRegistry | — | ثبتنام فقط-خواندنی که مشارکتهای افزونه را جمعآوری میکند؛ توسط کارخانه نمایشگر مصرف میشود. از طریق AddPlugin<T>() پر کنید. |
اولویت مجوز (در زمان ثبت سرویس اعمال میشود): LicenseStream → LicenseContent → LicensePath → کشف خودکار (به شروع کار → تنظیم مجوز مراجعه کنید).
متدها
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()از این متد برای بستههای Converter، DICOM و Signer که بهصورت opt‑in منتشر شدهاند استفاده کنید. حاشیهنویسی و جستجوی معمولی ویژگیهای دارای مجوز داخلی هستند و از AddPlugin<TPlugin>() استفاده نمیکنند.
یک افزونهٔ داخلی (Converter، DICOM، Signer) را ثبت میکند. بهصورت Fluent — نمونهٔ گزینهها را برمیگرداند. AddDoconut() برای مجوز گمشده، فایل قدیمی TRIAL یا مجوز پرداختی که قابلیت افزونه را اعطا نمیکند، InvalidOperationException را پرتاب میکند. ثبتنامهای موقت/دموی پس از انقضا حفظ میشوند و تحت دروازهٔ زمان اجرا قرار میگیرند (به مفاهیم اصلی → سیستم افزونه مراجعه کنید).
ویجت Converter که بهصورت opt‑in فعال است با AddConverterWidget() فعال میشود و از طریق ویژگی فقط‑خواندنی ConverterWidget در دسترس است؛ گزینههای آن در صفحهٔ افزونهٔ Converter (افزونهها → افزونه Converter) مستند شدهاند. ویجت Signer که بهصورت opt‑in فعال است به همان روش، با 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.) و برای کارخانهٔ null ArgumentNullException پرتاب میکند.
اعتبارسنجی هنگام راهاندازی
AddDoconut() گزینهها را بهسرعت‑شکست اعتبارسنجی میکند، بنابراین یک پیکربندی نادرست بهصورت استثنای واضحی در زمان راهاندازی ظاهر میشود نه 404های گیجکننده در زمان درخواست:
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: '/' حفظ میکند.
آیا این صفحه مفید بود؟