DoconutExtensions
רישום שירותים וביניים
DoconutExtensions (namespace Doconut.Middleware) היא המחלקה הסטטית עם שלוש הקריאות שכל מארח Doconut מבצע: רישום שירות אחד ושתי רישומי אמצעי ביניים.
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession(); // קרא ל-UseSession() לפני UseDoconut()
app.UseDoconutResources(); // חייב להיות רשום לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());UseDoconut() משיב לכל בקשה שמגיעה אליו, ולכן יש למקם אותו בענף משלו עם app.Map.
AddDoconut
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)בונה את DoconutOptions, מאמת אותם באופן fail‑fast (ראו DoconutOptions → Startup validation), ורושם את גרף השירות המלא:
| שירות | משך חיים | תפקיד |
|---|---|---|
DoconutOptions | Singleton | אובייקט הקונפיגורציה |
| שירות מטמון סשן | Singleton | Token → מטמון סשן (IMemoryCache גם רשום) |
IDoconutLicenseService | Singleton | רישיון נטען פעם אחת בהפעלה (קדימות: LicenseStream → LicenseContent → LicensePath → auto-search) |
| צינור עיבוד תמונות דף | Singleton | מבצע עיבוד תמונות לדפים (סימן מים, סיבוב, שינוי גודל, אנוטציות) |
| אבטחת מסמך (מאגר גישה) | Singleton | הענקת קישוריות token‑ל‑session |
Viewer | Transient | הממשק הפומבי לפתיחה/סגירה |
DocumentConverter | Transient | ממשק המרה — דורש את תוסף Converter |
DocumentSigner | Transient | ממשק חתימה — דורש את תוסף Signer (ראו Signer Plugin) |
DistributedDocumentPublisher | Transient | מפרסם את תוצרי המסמך לאחסון משותף (ראו Distributed Deployments) |
בדיקת בריאות "doconut" | — | מדווח על מצב רישיון/תפוגה דרך בדיקות בריאות של ASP.NET |
שתי התנהגויות שכדאי לדעת:
- Converter דורש את התוסף שלו. פתרון של
DocumentConverterללאoptions.AddPlugin<ConverterPlugin>()גורם לשגיאה:
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 — מיפוי אם תרצו מצב רישיון בנקודת הבריאות שלכם:
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)מוסיף את האמצעי הביניים של Doconut לעיבוד תמונות דף. הוא משרת כל בקשה שנושאת פרמטר שאילתה ?token= — דפים, תצלומים ממוזערים, חיפוש, אנוטציות, פעולות דף (טבלת הבקשות המלאה נמצאת ב‑Core Concepts → How the Viewer Works) — ומשיב לכל בקשה אחרת בעצמו עם 404 (או עם הבאנר ShowDoconutInfo): הוא לעולם לא מעביר בקשה לשאר הצינור. מקם אותו בענף משלו, כפי בדוגמאות בדף זה. כאשר UnsafeMode הוא false, שכבת אבטחת המסמך מחוברת אוטומטית לפניו.
חלופה נפוצה שומרת על צורת הבקשה ההיסטורית DocImage.axd עם ענף MapWhen (הלקוח אז משתמש ב‑BasePath: '/'):
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)משרת את ה‑JS, CSS, תמונות, וגופנים המוטמעים ב‑DoconutOptions.ResourcesPath (ברירת מחדל /doconut-res). אלו הקבצים ש‑Viewer.ReferenceCss() / ReferenceScripts() מייצרים תגיות עבורם.
תמיד קראו זאת לפני UseDoconut(). אם אזור הצופה נשאר ריק וקונסולת הדפדפן מציגה 404 עבור /doconut-res/..., קריאה זו חסרה או במיקום שגוי.
שירות מאחסון משותף
שתי רישומים נוספים קיימים לפריסות שבהן הצומת שמרנדר מסמך אינו בהכרח הצומת שמשרת את דפיו. שניהם מכוסים מקצה לקצה ב‑Distributed Deployments; החתימות הן:
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // תור פרסום ברקע עם אפשרות הצטרפות
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // אחסון משותף להעלאות widgetצד הקריאה הוא אמצעי ביניים נפרד מה‑assembly Doconut.Clouds, שנשלח באותו חבילה:
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerסיכום סדר
app.UseRouting();
app.UseSession(); // קרא ל-UseSession() לפני UseDoconut()
app.UseDoconutResources(); // חייב להיות רשום לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // או ענף MapWhenהאם דף זה היה מועיל?