วิธีการทำงานของ Viewer
วงจรชีวิตของการร้องขอเอกสาร
Doconut แสดงเอกสารเป็นภาพที่แบ่งหน้าและให้บริการผ่าน middleware ของ ASP.NET Core การเข้าใจวงจรชีวิต — การเปิด, โทเค็น, การร้องขอหน้า, การปิด — จะอธิบายพฤติกรรมเกือบทั้งหมดที่คุณจะสังเกตเห็น รวมถึงข้อความแสดงข้อผิดพลาด
สามส่วนที่เคลื่อนที่
Viewer— บริการสาธารณะที่คุณฉีดเข้าไป มันเปิดเอกสารและคืนค่าโทเค็นเซสชัน- เซสชันเอกสาร — วัตถุฝั่งเซิร์ฟเวอร์ที่เก็บเอกสารที่โหลดแล้ว โดยใช้โทเค็นใน
IMemoryCacheเป็นคีย์ - มิดเดิลแวร์ Doconut — ถูกเพิ่มโดย
UseDoconut(); ตอบสนองต่อทุกคำขอที่วิดเจ็ตเบราว์เซอร์ทำ (pages,thumbnails,search,annotations, …) โดยยืนยันตัวตนด้วยโทเค็นเสมอ
Viewer เป็นแบบไม่มีสถานะ — ตามการออกแบบ
Viewer ถูกปิดกั้น, ไม่เก็บสถานะเอกสารต่อคำขอ, และโดยเจตนา ไม่ ทำการ implement IDisposable. เซสชันดำรงอยู่แยกจากกันในตัวจัดการเซสชันและจะถูกทำความสะอาดโดยการหมดอายุของแคชหรือโดย CloseDocument(token) ที่ชัดเจน
คุณไม่ต้องสร้างมันอีกต่อไป AddDoconut() ลงทะเบียนเป็นบริการแบบชั่วคราว; ฉีดเข้าไปที่ใดก็ได้ที่คุณต้องการ:
app.MapPost("/api/open", async (string fileName, Viewer viewer) =>
{
var token = await viewer.OpenDocumentAsync($"files/{fileName}");
return Results.Content(token, "text/plain");
});ในแอปพลิเคชัน MVC, รับเป็นพารามิเตอร์ของคอนสตรัคเตอร์; ใน Razor view, ใช้ @inject Doconut.Viewer Viewer. แคชที่เป็นของแอปพลิเคชันสำหรับอินสแตนซ์ของ Viewer ไม่จำเป็นอีกต่อไป — และไม่ถูกต้องอีกต่อไป เพราะมันไม่ได้เก็บอะไรที่คุ้มค่าที่จะเก็บในแคช
สิ่งที่เกิดขึ้นภายใน OpenDocumentAsync
- ประตูใบอนุญาต. ใบอนุญาตที่ถูกปฏิเสธหรือหมดอายุเวอร์ชัน (อยู่ในรายการดำ, ถูกดัดแปลง, หรือเป็นบิลด์ที่อยู่นอกหน้าต่างอัปเดตของใบอนุญาต) จะโยน
LicenseExceptionทันที พร้อมเหตุผลการปฏิเสธเป็นข้อความ — การเปิดจะไม่ลดคุณภาพอย่างเงียบ ๆ สำหรับใบอนุญาตที่ไม่ถูกต้อง (ต่างจากไม่มีใบอนุญาต) ใบอนุญาตชั่วคราวหรือแบบสมัครสมาชิกที่หมดอายุตามปฏิทินเป็นข้อยกเว้น: มันไม่โยน — แต่จะลดเป็นลายน้ำ - การสร้างเซสชัน. โรงงาน viewer จะเลือก viewer ที่เหมาะกับรูปแบบไฟล์ตามส่วนขยายและโหลดเอกสาร (ดู Rendering Pipeline). เซสชันจะถูกเก็บใน
IMemoryCacheภายใต้โทเค็น GUID ใหม่พร้อม การหมดอายุแบบเลื่อน —DocOptions.TimeOutนาที, ค่าเริ่มต้น 60. ทุกการร้องขอหน้า จะรีเซ็ตนาฬิกา - การลงทะเบียนความปลอดภัย. ด้วย
UnsafeMode = false(ค่าเริ่มต้น), โทเค็นจะถูกผูกกับเซสชัน ASP.NET ของผู้เรียก: มาร์กเกอร์secure-{token}จะถูกเขียนลงในเซสชัน, ดังนั้นเฉพาะเซสชันเบราว์เซอร์ที่เปิดเอกสารเท่านั้นที่สามารถร้องขอหน้าของมันได้ - โทเค็นถูกส่งกลับ. มันเป็นข้อมูลรับรองเดียวสำหรับทุกอย่างที่ตามมา
ไม่มีขั้นตอนอุ่นเครื่องแยกออกไป ไลบรารีก่อนหน้านี้ได้เปิดเผย InitCache() เพื่อจุดประสงค์นั้น; ตอนนี้ไม่มีแล้วและไม่มีอะไรมาแทนที่มัน
การโอเวอร์โหลดสามแบบแตกต่างกันเพียงในอินพุต: เส้นทางไฟล์, เส้นทางไฟล์พร้อมการกำหนดค่าตามรูปแบบ (PdfConfig, WordConfig, …), หรือ Stream พร้อมกับ FileInfo ที่ส่วนขยายของมันกำหนดการตรวจจับรูปแบบ
วิธีที่วิดเจ็ตรับหน้า
วิดเจ็ตของไคลเอนต์เรียกมิดเดิลแวร์ Doconut พร้อมโทเค็นใน query string สิ่งที่มิดเดิลแวร์ทำขึ้นอยู่กับคำขอ:
| คิวรี | วัตถุประสงค์ |
|---|---|
?token=…&page=N | ภาพหน้าที่เรนเดอร์ (PNG) |
?token=…&page=N&thumb=1 | ภาพย่อ |
?token=…&zoom=… | การเรนเดอร์หน้าที่ซูม |
?token=…&search=term | การค้นหาข้อความเต็ม (จำกัดโดยใบอนุญาต) |
?token=…&bookmarks | โครงร่าง/บุ๊กมาร์กของเอกสาร |
?token=…© / &showlinks / &fileFormat | คัดลอกข้อความ, ลิงก์, และข้อมูลรูปแบบ |
?token=…&meta | เมตาดาต้าเทคนิคของ DICOM; คืนค่า 501 สำหรับเซสชัน DICOM บนแพคเกจนี้ |
?token=…&action=rotate/flip/close | การกระทำของหน้าและการปิดอย่างชัดเจน |
?token=…&AnnSave=… / &AnnLoad | บันทึก/โหลดคำอธิบายประกอบ |
แต่ละเส้นทางเหล่านี้จะตรวจสอบความถูกต้องก่อน:
- ไม่มีโทเค็น → มิดเดิลแวร์จะคืนค่า 404 (หรือแบนเนอร์เวอร์ชันเมื่อ
ShowDoconutInfo = true). - โทเค็นที่ไม่รู้จักหรือหมดอายุ → ภาพข้อผิดพลาดพร้อม
Document session not found. Please re-open document. - มิดเดิลแวร์เซสชันหายไป (กับ
UnsafeMode = false) → HTTP 500 พร้อมSession middleware not configured. Call UseSession() before UseDoconut(). - โทเค็นที่เปิดโดยเซสชันเบราว์เซอร์อื่น → ภาพข้อผิดพลาดพร้อม
You Are Not Authorized To View This Page.
ที่ที่มิดเดิลแวร์ถูกเมานท์
UseDoconut() ตอบสนองต่อคำขอที่มีโทเค็น, ไม่ว่าคุณจะเมานท์ที่ไหน การตั้งค่าทั่วไปจะรักษารูปแบบคำขอ DocImage.axd แบบเก่าไว้บนสาขา MapWhen, ดังนั้นไคลเอนต์ที่มีอยู่จะยังคงเรียก URL เดิมที่เคยใช้ ไม่ว่าคุณจะเลือกอะไร, BasePath ของไคลเอนต์ต้องสอดคล้องกับมัน — ดู ViewerConfig.
การให้บริการหน้าจากที่เก็บข้อมูลร่วมแทนโหนดที่เปิดเป็นการจัดเรียงที่แตกต่างอย่างสิ้นเชิง; ดู การปรับใช้แบบกระจาย.
การปิดเอกสาร
viewer.CloseDocument(token);CloseDocument ลบเซสชันออกจากแคช (ซึ่งทำลายเอนจินเอกสารพื้นฐานและปล่อยหน่วยความจำทันที), ลบมาร์กเกอร์ secure-{token}, และเพิกถอนการให้สิทธิ์การเข้าถึง. การเรียกใช้เป็นทางเลือก — การหมดอายุแบบเลื่อนทำความสะอาดเดียวกันโดยอัตโนมัติ — แต่สำหรับเอกสารขนาดใหญ่เป็นวิธีที่สุภาพในการปล่อยหน่วยความจำเมื่อผู้ใช้เสร็จสิ้น.
มันถูกเรียกบน Viewer ที่ฉีดเข้าไป. รูปแบบก่อนหน้า — การสร้าง Viewer ชั่วคราวในบล็อก using เพียงเพื่อปิดโทเค็น — ไม่มีเทียบเท่าและไม่จำเป็น.
สิ่งที่ควรจำ
- เอกสารที่เปิดหนึ่งไฟล์ = เซสชันหนึ่ง = โทเค็นหนึ่ง. โทเค็นเป็นต่อเซสชันเบราว์เซอร์, ไม่ใช่ URL ทั้งหมด.
- โทเค็นหมดอายุบนหน้าต่างแบบเลื่อน; viewer ที่ว่างเปล่านานเกิน
DocOptions.TimeOutต้องเปิดใหม่. Viewerสามารถฉีดและแชร์ได้อย่างอิสระ; เซสชันถือสถานะทั้งหมด.
หน้านี้เป็นประโยชน์หรือไม่?