DoconutExtensions

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

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.

הוספת Doconut

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

בונה את DoconutOptions, מאמת אותם באופן של כשל מהיר (ראו DoconutOptions → אימות אתחול), ורושם את גרף השירות המלא:

שירותאורך חייםתפקיד
DoconutOptionsSingletonאובייקט התצורה
שירות מטמון סשןSingletonToken → מטמון סשן (IMemoryCache נרשם גם הוא)
IDoconutLicenseServiceSingletonרישיון נטען פעם אחת באתחול (קדימות: LicenseStream → LicenseContent → LicensePath → חיפוש אוטומטי)
צינור עיבוד תמונות דףSingletonמבצע עיבוד תמונות לדפים (סימן מים, סיבוב, שינוי גודל, הערות)
אבטחת מסמך (מאגר גישה)Singletonהענקות לקישור token-ל‑session
ViewerTransientהממשק הפומבי לפתיחה/סגירה
DocumentConverterTransientממשק המרה — דורש את תוסף Converter
DocumentSignerTransientממשק חתימה — דורש את תוסף Signer (ראו תוסף חותם)
DistributedDocumentPublisherTransientמפרסם את המוצרים של מסמך לאחסון משותף
בדיקת בריאות "doconut"—מדווח על מצב רישיון/פג תוקף דרך בדיקות בריאות של ASP.NET

אין קריאה שוות ערך בספריית .NET Standard הקודמת. היא בנתה את new Viewer(cache, accessor) לכל בקשה והעבירה אפשרויות לביניים; שניהם מוחלפים ברישום היחיד הזה.

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

  • 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");

שימוש ב‑Doconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

מוסיף את ביניים העיבוד של תמונות דף של Doconut. הוא משרת כל בקשה שנושאת פרמטר שאילתה ?token= — דפים, תמונות ממוזערות, חיפוש, הערות, פעולות דף (טבלת הבקשות המלאה נמצאת ב‑מושגים בסיסיים → איך הצופה עובד) — ומשיב לכל בקשה אחרת בעצמו עם 404 (או עם הבאנר ShowDoconutInfo): הוא אף פעם לא מעביר בקשה לשאר הצינור. מקמו אותו בענף משלו, כמו בדוגמאות בעמוד זה. כאשר UnsafeMode הוא false, שכבת האבטחה של המסמך מחוברת אוטומטית לפניו.

אין לו ארגומנטים. העברת מופע של DoconutOptions כאן הייתה צורת הספרייה הקודמת ואינה מתקמפל עוד.

הגדרה נפוצה שומרת על צורת הבקשה ההיסטורית DocImage.axd עם ענף MapWhen (הלקוח אז משתמש ב‑BasePath: '/'):

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

שימוש במשאבי Doconut

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

משרת את ה‑JS, CSS, תמונות וגופנים המוטמעים ב‑DoconutOptions.ResourcesPath (ברירת מחדל /doconut-res). אלו הקבצים ש‑Viewer.ReferenceCss() / ReferenceScripts() מייצרים תגיות עבורם.

תמיד קראו זאת לפני UseDoconut(). אם אזור הצופה נשאר ריק וקונסולת הדפדפן מציגה 404 עבור /doconut-res/..., קריאה זו חסרה או ממוקמת במקום הלא נכון.

זהו ההחלפה הנתמכת לחיבור ידני של ביניים טיפול במשאבי‑embedded.

הגשה מאחסון משותף

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

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

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

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

UseDoconutWebFarm(...) ו‑WebFarmOptions אינם קיימים בגרסה זו. ראו את מדריך ההגירה למיפוי הגדרה‑ב‑הגדרה.

סיכום סדר

csharp
app.UseRouting();
app.UseSession();          // קרא UseSession() לפני UseDoconut()
app.UseDoconutResources(); // חייב להיות רשום לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // או ענף MapWhen

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