วิธีการทำงานของ Viewer

วงจรการร้องขอเอกสาร

Doconut แสดงเอกสารเป็นภาพแบบแบ่งหน้าโดยให้บริการผ่าน middleware ของ ASP.NET Core การเข้าใจกระบวนการ — เปิด, โทเค็น, คำขอหน้า, ปิด — จะอธิบายพฤติกรรมเกือบทั้งหมดที่คุณจะพบ รวมถึงข้อความแสดงข้อผิดพลาดด้วย

ส่วนประกอบสำคัญสามส่วน

  • Viewer — บริการสาธารณะที่คุณฉีดเข้าไป มันเปิดเอกสารและคืนค่าโทเค็นเซสชัน
  • The document session — วัตถุฝั่งเซิร์ฟเวอร์ที่เก็บเอกสารที่โหลดแล้ว โดยใช้โทเค็นใน IMemoryCache เป็นคีย์
  • The Doconut middleware — ถูกเพิ่มโดย UseDoconut(); ตอบสนองต่อทุกคำขอที่วิดเจ็ตของเบราว์เซอร์ทำ (pages, thumbnails, search, annotations, …) โดยยืนยันตัวตนด้วยโทเค็นเสมอ

Viewer เป็นแบบไม่มีสถานะ — ตามการออกแบบ

Viewer ถูกปิดกั้น, ไม่เก็บสถานะเอกสารต่อคำขอ, และโดยเจตนา ไม่ ทำการ implement IDisposable. เซสชันดำรงอยู่แยกจากกันในตัวจัดการเซสชันและจะถูกทำความสะอาดโดยการหมดอายุของแคชหรือโดย CloseDocument(token) ที่ชัดเจน

ฉีดเข้าไปที่ใดก็ได้ที่คุณต้องการ:

csharp
app.MapPost("/api/open", async (string fileName, Viewer viewer) =>
{
    var token = await viewer.OpenDocumentAsync($"files/{fileName}");
    return Results.Content(token, "text/plain");
});

สิ่งที่เกิดขึ้นภายใน OpenDocumentAsync

  1. License gate. ใบอนุญาตที่ถูกปฏิเสธหรือหมดอายุรุ่น (อยู่ในรายการดำ, ถูกดัดแปลง, หรือเป็นบิลด์ที่อยู่นอกหน้าต่างอัปเดตของใบอนุญาต) จะโยน LicenseException ทันทีพร้อมเหตุผลการปฏิเสธเป็นข้อความ — การเปิดจะไม่ลดคุณภาพอย่างเงียบ ๆ สำหรับใบอนุญาตที่ไม่ถูกต้อง (ตรงกันข้ามกับการไม่มีใบอนุญาต). ใบอนุญาตชั่วคราวหรือแบบสมัครสมาชิกที่หมดอายุตามปฏิทินเป็นข้อยกเว้น: จะไม่โยน — จะลดคุณภาพเป็นลายน้ำ
  2. Session creation. โรงงาน viewer จะเลือก viewer ที่เหมาะสมกับรูปแบบไฟล์ตามส่วนขยายและโหลดเอกสาร (ดู Rendering Pipeline). เซสชันจะถูกเก็บใน IMemoryCache ภายใต้โทเค็น GUID ใหม่พร้อม การหมดอายุแบบเลื่อน — DocOptions.TimeOut นาที, ค่าเริ่มต้น 60. ทุกคำขอหน้า จะรีเซ็ตนาฬิกา
  3. Security registration. ด้วย UnsafeMode = false (ค่าเริ่มต้น), โทเค็นจะผูกกับเซสชัน ASP.NET ของผู้เรียก: จะเขียนเครื่องหมาย secure-{token} ลงในเซสชัน, ดังนั้นเฉพาะเซสชันของเบราว์เซอร์ที่เปิดเอกสารเท่านั้นที่สามารถขอหน้าของมันได้
  4. The token is returned. มันเป็นข้อมูลประจำตัวเดียวสำหรับทุกอย่างที่ตามมา

การ overload สามแบบแตกต่างกันเพียงแค่ในอินพุต: เส้นทางไฟล์, เส้นทางไฟล์พร้อมการกำหนดค่าตามรูปแบบ (PdfConfig, WordConfig, …), หรือ Stream พร้อมกับ FileInfo ที่ส่วนขยายของมันกำหนดการตรวจจับรูปแบบ

วิธีที่วิดเจ็ตรับหน้าต่าง

วิดเจ็ตของไคลเอนต์เรียก Doconut middleware พร้อมโทเค็นใน query string. สิ่งที่ middleware ทำขึ้นอยู่กับคำขอ:

QueryPurpose
?token=…&page=Nภาพหน้าที่เรนเดอร์ (PNG)
?token=…&page=N&thumb=1ภาพย่อ
?token=…&zoom=…การเรนเดอร์หน้าที่ขยาย
?token=…&search=termการค้นหาข้อความเต็ม (ต้องมีใบอนุญาต)
?token=…&bookmarksโครงร่าง/บุ๊กมาร์กของเอกสาร
?token=…&copy / &showlinks / &fileFormatคัดลอกข้อความ, ลิงก์, และข้อมูลรูปแบบ
?token=…&metaเมตาดาต้าเทคนิคของ DICOM; คืนค่า 501 สำหรับเซสชัน DICOM บน .NET 6
?token=…&action=rotate/flip/closeการกระทำของหน้าและการปิดอย่างชัดเจน
?token=…&AnnSave=… / &AnnLoadบันทึก/โหลดคำอธิบายประกอบ

แต่ละเส้นทางเหล่านี้จะตรวจสอบความถูกต้องก่อน:

  • No token → middleware จะคืนค่า 404 (หรือแบนเนอร์เวอร์ชันเมื่อ ShowDoconutInfo = true)
  • Unknown or expired token → รูปภาพข้อผิดพลาดพร้อม Document session not found. Please re-open document.
  • Session middleware missing (กับ UnsafeMode = false) → HTTP 500 พร้อม Session middleware not configured. Call UseSession() before UseDoconut().
  • Token opened by a different browser session → รูปภาพข้อผิดพลาดพร้อม You Are Not Authorized To View This Page.

การให้บริการหน้าจากที่เก็บข้อมูลร่วมแทนโหนดที่เปิดเป็นการจัดเรียงที่แตกต่างอย่างสิ้นเชิง; ดู การปรับใช้แบบกระจาย.

ปิดเอกสาร

csharp
viewer.CloseDocument(token);

CloseDocument จะลบเซสชันออกจากแคช (ซึ่งทำลายเอนจินเอกสารพื้นฐานและปล่อยหน่วยความจำทันที), ลบเครื่องหมาย secure-{token}, และเพิกถอนการให้สิทธิ์การเข้าถึง. การเรียกใช้เป็นทางเลือก — การหมดอายุแบบเลื่อนจะทำความสะอาดเช่นเดียวกันโดยอัตโนมัติ — แต่สำหรับเอกสารขนาดใหญ่เป็นวิธีที่สุภาพในการปล่อยหน่วยความจำทันทีที่ผู้ใช้เสร็จสิ้น.

สรุป

  • เอกสารที่เปิดหนึ่งไฟล์ = เซสชันหนึ่ง = โทเค็นหนึ่ง. โทเค็นเป็นต่อเซสชันของเบราว์เซอร์, ไม่ใช่ URL ทั่วโลก.
  • โทเค็นหมดอายุตามหน้าต่างเลื่อน; viewer ที่ไม่มีการใช้งานเกิน DocOptions.TimeOut จะต้องเปิดใหม่.
  • Viewer สามารถฉีดและแชร์ได้อย่างอิสระ; เซสชันบรรจุสถานะทั้งหมด.

หน้านี้เป็นประโยชน์หรือไม่?