הרחבות Doconut

רישום שירותים וביניים

DoconutExtensions (namespace Doconut.Middleware) היא המחלקה הסטטית עם שלוש הקריאות שכל מארח Doconut מבצע: רישום שירות אחד ושתי רישומי ביניים.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // קריאה ל-UseSession() לפני UseDoconut()
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הענקות לקישור token-ל-session
ViewerTransientהממשק הפומבי לפתיחה/סגירה
DocumentConverterTransientממשק המרה — דורש תוסף Converter
DocumentSignerTransientממשק חתימה — דורש תוסף Signer (ראו תוסף חותם)
DistributedDocumentPublisherTransientמפרסם את תוצרי המסמך לאחסון משותף (ראו פריסות מבוזרות)
בדיקת בריאות "doconut"—מדווח על מצב רישיון/פג תוקף דרך בדיקות בריאות של ASP.NET

שתי התנהגויות שכדאי לדעת:

  • Converter דורש תוסף משלו. פתרון של DocumentConverter ללא options.AddPlugin<ConverterPlugin>() גורם ל‑exception:
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 page-image. הוא משרת כל בקשה שנושאת פרמטר שאילתה ?token= — דפים, תמונות ממוזערות, חיפוש, הערות, פעולות דף (טבלת הבקשות המלאה נמצאת ב‑Core Concepts → How the Viewer Works) — ועונה על כל בקשה אחרת בעצמו עם 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(). אם אזור הצופה נשאר ריק וקונסול הדפדפן מציג 404 עבור /doconut-res/..., קריאה זו חסרה או במיקום שגוי.

שירות מאחסון משותף

שתי רישומים נוספים קיימים לפריסות שבהן הצומת שמרנדר מסמך אינו בהכרח הצומת שמשרת את הדפים שלו. שניהם מכוסים מקצה לקצה ב‑פריסות מבוזרות; החתימות הן:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // תור פרסום ברקע עם אפשרות הצטרפות
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // אחסון משותף לטעינת וידג'טים

צד הקריאה הוא ביניים נפרד מה‑assembly Doconut.Clouds, שנשלח באותו חבילה:

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

סיכום סדר

csharp
app.UseRouting();
app.UseSession();          // קריאה ל-UseSession() לפני UseDoconut()
app.UseDoconutResources(); // צריך להירשם לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // או סניף MapWhen

האם דף זה היה מועיל?