איך הצופה עובד
מחזור חיי בקשת המסמך
Doconut מציג מסמכים כתמונות ממודפות, המוגשות על ידי מטפל HTTP שהWeb.config שלך רושמת. הבנת מחזור החיים — פתיחה, אסימון, בקשות עמודים, סגירה — מסבירה כמעט כל התנהגות שתצפה, כולל הודעות השגיאה.
החלקים הנעים
Viewer— השירות הציבורי שאתה מקבל מDoconutHost.Services. הוא פותח מסמכים ומחזיר אסימוני סשן.- סשן המסמך — אובייקט בצד השרת המחזיק את המסמך הטעון, נשמר בזיכרון תחת האסימון שלו.
DocImage.axd— הDoconut.DocImageHandlerשהוגדר בWeb.config. הוא משיב לכל בקשה שהווידג'ט של הדפדפן עושה (עמודים, תמונות ממוזערות, חיפוש, הערות, …), תמיד מזוהה על ידי האסימון./doconut-res/*— הDoconut.DoconutResourceModule, שמשרת את הסקריפטים, הסגנונות והאייקונים של הווידג'ט עצמו.
Viewer הוא חסר מצב — בתכנון
Viewer אינו מחזיק במצב מסמך לכל בקשה ואינו מממש IDisposable. סשנים קיימים באופן עצמאי ממנו ומנוקים על ידי תפוגה או CloseDocument(token) מפורש. ל‑System.Web אין הזרקת קונסטרוקטור, ולכן יש לפתור אותו במקום שבו אתה צריך אותו — בדרך כלל בפעולת בקר:
// POST /ViewerApi/Open?fileName=Sample.pdf
[HttpPost]
public async Task<ActionResult> Open(string fileName)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
var path = Server.MapPath("~/files/" + Path.GetFileName(fileName));
var token = await viewer.OpenDocumentAsync(path);
return Content(token, "text/plain");
}מה קורה בתוך OpenDocumentAsync
- שער הרישיון. רישיון שנדחה (מותקף, ברשימה שחורה, או בנייה מחוץ לחלון העדכון של הרישיון) זורק
LicenseExceptionמיידית, עם הסיבה כהודעה. הפתיחה לעולם לא מתדרדרת בשקט עבור רישיון לא תקף; רישיון חסר מוסיף רק סימן מים. - יצירת סשן. מפעל הצופה בוחר את צופה הפורמט עבור סיומת הקובץ וטוען את המסמך (ראה צינור רינדור). הסשן מאוחסן בזיכרון תחת אסימון אקראי חדש עם תפוגה מתגלגלת של
DocOptions.TimeOutדקות (ברירת מחדל 60). כל בקשת עמוד מאפסת את השעון. - מתן גישה. עם
UnsafeMode = false(ברירת המחדל), האסימון קשור לסשן ASP.NET של הבקשה שפתחה אותו: רשומתsecure-{token}נכתבת לאותו סשן. לכן הפתיחה חייבת להתבצע בבקשה עם מצב סשן — ראה סשנים ואבטחה. - האסימון מוחזר. הוא המזהה היחיד שהדפדפן צריך לכל מה שבא אחרי זה.
הגרסאות האסינכרוניות מקבלות נתיב קובץ, נתיב קובץ בתוספת תצורת פורמט‑פרטית (PdfConfig, WordConfig, …), או Stream בתוספת FileInfo שהסיומת שלו בוחרת את הפורמט. עבור קוד‑מאחורי של Web Forms שאינו משתמש בעמודים אסינכרוניים, OpenDocument מציע את שלושת הקלטים האלה באופן סינכרוני (נתיב, זרם עם שם קובץ, או מערך בתים עם שם קובץ).
איך הווידג'ט מקבל עמודים
הווידג'ט קורא לDocImage.axd עם האסימון במחרוזת השאילתה. מה שהמתאם עושה תלוי בבקשה:
| שאילתה | מטרה |
|---|---|
?token=…&page=N | תמונת עמוד רנדור (PNG) |
?token=…&page=N&thumb=1 | תמונה ממוזערת |
?token=…&zoom=… | רינדור עמוד מוגדל |
?token=…&search=term | חיפוש טקסט מלא (מבוסס רישיון) |
?token=…&bookmarks | מתאר המסמך וסימניות |
?token=…© / &showlinks / &fileFormat | העתקת טקסט, קישורים והמידע על הפורמט |
?token=…&meta | מטא‑נתונים טכניים של DICOM — לא זמינים בחבילה זו (עונה על 404) |
?token=…&action=rotate/flip/close | פעולות עמוד וסגירה מפורשת (POST) |
?token=…&AnnSave=… / &AnnLoad | שמירה וטעינת הערות |
כל בקשה נבדקת תחילה:
- אין אסימון →
404, או באנר גרסה כאשרShowDoconutInfo = true. - האסימון לא נמסר לסשן ASP.NET זה → תמונת שגיאה עם הטקסט
You Are Not Authorized To View This Page. - אסימון לא ידוע או פג תוקף → תמונת שגיאה עם הטקסט
Document session not found. Please re-open document.
תמונות השגיאה הן קבצי PNG רגילים שנשלחים עם סטטוס 200, כך שהווידג'ט יכול להציג אותן במקום העמוד. בדיקת ניטור שמסתכלת רק על קוד הסטטוס תדווח עליהן כעמודים שסופקו; עמוד אמיתי הוא בגודל של עשרות עד מאות קילובייט, תמונת שגיאה כ‑2 ק״ב.
סגירת מסמך
viewer.CloseDocument(token);CloseDocument מסיר את הסשן (משחרר את מנוע המסמך ואת הזיכרון שלו מייד), מסיר את רשומת secure-{token} מהסשן ASP.NET של הבקשה הנוכחית, ומבטל את האסימון. זה אופציונלי — תפוגה מתגלגלת עושה את אותה ניקוי — אך עבור מסמכים גדולים זה משחרר זיכרון ברגע שהמשתמש מסיים. מהדפדפן, objViewer.Close(true) שולח את בקשת הסגירה המקבילה לDocImage.axd.
מסקנות
- מסמך פתוח אחד = סשן אחד = אסימון אחד, נמסר לסשן ASP.NET שפתח אותו.
- האסימון פג בתפוגה מתגלגלת; צופה שנשאר ללא פעילות מעבר ל
DocOptions.TimeOutצריך פתיחה מחדש. Viewerניתן לפתור ולשתף בחופשיות; הסשנים נושאים את כל המצב.
האם דף זה היה מועיל?