DoconutExtensions

Service and middleware registration

DoconutExtensions (namespace Doconut.Middleware) کلاس استاتیک است که سه فراخوانی را که هر میزبان Doconut انجام می‌دهد شامل می‌شود: یک ثبت سرویس و دو ثبت میدل‌ویر.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // قبل از UseDoconut()، UseSession() را فراخوانی کنید
app.UseDoconutResources(); // باید قبل از UseDoconut() ثبت شود
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() به هر درخواستی که به آن می‌رسد پاسخ می‌دهد، بنابراین آن را در شاخهٔ جداگانه‌ای با app.Map نصب کنید.

AddDoconut

text
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)

DoconutOptions را می‌سازد، آن‌ها را به‌صورت سریع‑خطا (fail‑fast) اعتبارسنجی می‌کند (به DoconutOptions → اعتبارسنجی راه‌اندازی مراجعه کنید) و گراف کامل سرویس‌ها را ثبت می‌کند:

سرویسطول عمرنقش
DoconutOptionsSingletonشیء پیکربندی
سرویس حافظهٔ کش جلسهSingletonToken → حافظهٔ کش جلسه (IMemoryCache نیز ثبت شده است)
IDoconutLicenseServiceSingletonمجوز یک‌بار در راه‌اندازی بارگذاری می‌شود (اولویت: LicenseStream → LicenseContent → LicensePath → جستجوی خودکار)
خط لولهٔ صفحه‑تصویرSingletonپردازش تصویر برای صفحات را انجام می‌دهد (علامت‌گذاری، چرخش، مقیاس، حاشیه‌نویسی)
امنیت سند (ذخیره‌سازی دسترسی)Singletonمجوزها برای اتصال توکن به جلسه
ViewerTransientنمای باز/بسته عمومی
DocumentConverterTransientنمای تبدیل — نیاز به افزونهٔ Converter دارد
DocumentSignerTransientنمای امضا — نیاز به افزونهٔ Signer دارد (به افزونهٔ امضاکننده مراجعه کنید)
DistributedDocumentPublisherTransientآثار یک سند را به ذخیره‌سازی مشترک منتشر می‌کند (به استقرارهای توزیع‌شده مراجعه کنید)
بررسی سلامت "doconut"—وضعیت مجوز/انقضا را از طریق بررسی‌های سلامت ASP.NET گزارش می‌دهد

دو رفتار که ارزش دانستن دارند:

  • Converter نیاز به افزونهٔ خود دارد. دریافت DocumentConverter بدون options.AddPlugin<ConverterPlugin>() خطا می‌اندازد:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner همان قانون را دنبال می‌کند: بدون options.AddPlugin<SignerPlugin>() خطا می‌اندازد No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • اعتبار افزونه در زمان راه‌اندازی اعتبارسنجی می‌شود. یک مجوز گمشده، فایل قدیمی TRIAL، یا مجوز پرداخت‌شده بدون قابلیت افزونهٔ ثبت‌شده در زمان AddDoconut() شکست می‌خورد. ثبت‌نام‌های موقت/دمویی تا تاریخ انقضای خود باقی می‌مانند، در حالی که دروازه‌های زمان اجرا قابلیت‌های منقضی‌شده را لغو می‌کنند.

بررسی سلامت با مکانیزم استاندارد ASP.NET Core یکپارچه می‌شود — اگر می‌خواهید وضعیت مجوز را در نقطهٔ سلامت خود داشته باشید، آن را نقشه‌گذاری کنید:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

میان‌افزار صفحه‑تصویر Doconut را اضافه می‌کند. این میان‌افزار هر درخواستی که پارامتر پرس‌وجوی ?token= را دارد سرویس می‌دهد — صفحات، تصویرهای کوچک، جستجو، حاشیه‌نویسی، اقدامات صفحه (جدول کامل درخواست‌ها در مفاهیم اصلی → نحوه کار Viewer) — و هر درخواست دیگری را خود با 404 (یا بنر ShowDoconutInfo) پاسخ می‌دهد: هرگز درخواست را به بقیهٔ لوله‌کشی منتقل نمی‌کند. آن را در شاخهٔ جداگانه‌ای نصب کنید، همان‌طور که در نمونه‌های این صفحه نشان داده شده است. وقتی UnsafeMode برابر با false باشد، لایهٔ امنیت سند به‌صورت خودکار قبل از آن وصل می‌شود.

یک جایگزین رایج شکل تاریخی درخواست DocImage.axd را با یک شاخهٔ MapWhen حفظ می‌کند (سپس مشتری از BasePath: '/' استفاده می‌کند):

csharp
app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconutResources

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

JS، CSS، تصویرها و فونت‌های جاسازی‌شده را در DoconutOptions.ResourcesPath (پیش‌فرض /doconut-res) سرو می‌کند. این‌ها فایل‌هایی هستند که Viewer.ReferenceCss() / ReferenceScripts() برای آن‌ها برچسب تولید می‌کنند.

همیشه قبل از UseDoconut() آن را فراخوانی کنید. اگر ناحیهٔ Viewer خالی بماند و کنسول مرورگر 404ها برای /doconut-res/... نشان دهد، این فراخوانی گم شده یا در مکان نادرست قرار گرفته است.

Serving from shared storage

دو ثبت‌نام دیگر برای استقرارهایی که در آن گره‌ای که سند را رندر می‌کند لزوماً گره‌ای که صفحات آن را سرو می‌کند نیست، وجود دارد. هر دو در استقرارهای توزیع‌شده به‌صورت انتها به انتها پوشش داده شده‌اند؛ امضاها عبارتند از:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // صف انتشار پس‌زمینه به صورت انتخابی
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // ذخیره‌ساز مشترک برای بارگذاری ویجت‌ها

سمت خواندن یک میدل‌ویر جداگانه از اسمبلی Doconut.Clouds است که در همان بسته ارائه می‌شود:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // قبل از UseDoconut()، UseSession() را فراخوانی کنید
app.UseDoconutResources(); // باید قبل از UseDoconut() ثبت شود
app.Map("/doconut", branch => branch.UseDoconut()); // یا یک شاخه MapWhen

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