DoconutOptions

پیکربندی سرویس‌های Doconut

DoconutOptions (namespace Doconut) یک شیء پیکربندی تک برای کل SDK است. شما آن را یک بار، در کال‌بکی که به DoconutHost.Initialize در Application_Start می‌سپارید، پیکربندی می‌کنید.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

ویژگی‌ها

نوعویژگیپیش‌فرضتوضیح
boolUnsafeModefalseهنگامی که false، DocImage.axd فقط به نشست ASP.NET که سند را باز کرده است (یا در یک فارم، به مرورگری که بلیط امضاشده دارد) صفحه‌ای را سرو می‌کند. هنگامی که true، هر درخواستی که توکن را حمل می‌کند سرو می‌شود. آن را false بگذارید — ببینید جلسات و امنیت.
boolShowDoconutInfofalseهنگامی که true، یک درخواست DocImage.axd بدون توکن پاسخ Doconut <version> is running on <host> به جای 404 می‌دهد. برای بررسی سریع مفید است؛ در تولید false را بگذارید.
stringResourcesPath"/doconut-res"پیشوند URL که ماژول منبع اسکریپت‌ها، استایل‌ها و تصاویر جاسازی‌شده را سرو می‌کند.
stringLicensePath""مسیر کامل به فایل مجوز. خالی → منبع مجوز بعدی، سپس کشف خودکار؛ اگر چیزی یافت نشد → ارزیابی با واترمارک بدون قابلیت‌ها.
stringLicenseContent""محتوای خام مجوز (پایگاه داده، متغیر محیطی، مخزن راز). بر LicensePath اولویت دارد.
Stream?LicenseStreamnullمجوز به‌صورت جریان، یک بار در زمان راه‌اندازی خوانده می‌شود. بر هر دو منبع دیگر اولویت دارد.
stringMiddlewarePath"/doconut"در System.Web استفاده نمی‌شود. نقطه انتهای صفحه همیشه هندلر DocImage.axd اعلام‌شده در Web.config است. مقدار همچنان در زمان راه‌اندازی اعتبارسنجی می‌شود (به زیر نگاه کنید).
boolResetLicensefalseاستفاده نمی‌شود. مجوز یک بار در DoconutHost.Initialize خوانده می‌شود؛ پس از جایگزینی مجوز، استخر برنامه را بازنشانی کنید.
DoconutPluginRegistryPluginRegistry—ثبت‌نام فقط-خواندنی مشارکت‌های افزونه، پر شده توسط AddPlugin<T>().

اولویت مجوز: LicenseStream → LicenseContent → LicensePath → کشف خودکار (ببینید راه‌اندازی مجوز).

متدها

AddPlugin<TPlugin>()

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

یک افزونه (مبدل، DICOM، امضا کننده) را ثبت می‌کند. به‌صورت Fluent — نمونه options را برمی‌گرداند. Annotation و Search ویژگی‌های مجوزدار داخلی هستند و از آن استفاده نمی‌کنند.

اگر هیچ مجوز فعال قابلیت افزونه را اعطا نکند، DoconutHost.Initialize از Application_Start ، InvalidOperationException را پرتاب می‌کند، و سایت هر درخواست را با یک 500 خالی پاسخ می‌دهد تا این مشکل رفع شود؛ پیام در لاگ رویدادهای ویندوز است (ببینید سیستم افزونه).

Add…Widget()

text
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)

ویجت‌های drop-in به‌صورت پیش‌فرض غیرفعال هستند. هر فراخوانی Add…Widget() نقطه انتهای آن ویجت را در DocImage.axd فعال می‌کند و نیاز به ثبت افزونهٔ متناظر دارد. ماژول منبع اسکریپت ویجت را سرو می‌کند چه فعال شده باشد چه نه، بنابراین ویجتی که بارگذاری و رسم می‌شود اما در اولین اقدام خود به 404 پاسخ می‌دهد، این فراخوانی را ندارد. ویجت مبدل در افزونه مبدل مستند شده است؛ ویجت امضا کننده، AddSignerWidget()، در افزونه امضا کننده است.

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 پرتاب می‌کند.

اعتبارسنجی راه‌اندازی

DoconutHost.Initialize گزینه‌ها را قبل از ساخت هر چیزی اعتبارسنجی می‌کند:

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.

MiddlewarePath حتی اگر System.Web هرگز از آن استفاده نکند نیز بررسی می‌شود، پس آن را در حالت پیش‌فرض بگذارید. همانند هر استثنای پرتاب‌شده از Application_Start، یک شکست اعتبارسنجی به‌صورت یک 500 خالی در هر درخواست ظاهر می‌شود، با پیام در لاگ رویدادهای ویندوز.

پیکربندی‌های عمومی

csharp
// محیط تولید: مجوز صریح، بقیه همه به‌صورت پیش‌فرض امن خود.
public static void ProductionLicense() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
    });

// مسیر منبع سفارشی (مثلاً برای جلوگیری از تداخل مسیر). ResPath نمایشگر را حفظ کنید و هر MVC
// IgnoreRoute در هماهنگی با آن: "/docs-assets" به معنای ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.ResourcesPath = "/docs-assets";
    });

وقتی ResourcesPath را تغییر می‌دهید، سه مورد را همزمان تغییر دهید: گزینه، ResPath ویجت ('docs-assets/images' برای "/docs-assets")، و در MVC، IgnoreRoute برای مسیر منبع (routes.IgnoreRoute("docs-assets/{*pathInfo}")). نقطه انتهای DocImage.axd جابجا نمی‌شود: مسیر آن توسط ویژگی path هندلر در Web.config تنظیم می‌شود.

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