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

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

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

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

  • Viewer — บริการสาธารณะที่คุณฉีดเข้าไป มันเปิดเอกสารและคืนค่าโทเคนเซสชัน
  • เซสชันเอกสาร — วัตถุฝั่งเซิร์ฟเวอร์ที่เก็บเอกสารที่โหลดแล้ว โดยใช้โทเคนใน IMemoryCache เป็นคีย์
  • มิดเดิลแวร์ Doconut — ถูกเพิ่มโดย 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. ประตูตรวจใบอนุญาต. ใบอนุญาตที่ถูกปฏิเสธหรือหมดอายุเวอร์ชัน (อยู่ในรายการสีดำ, ถูกดัดแปลง, หรือเป็นบิลด์ที่อยู่นอกหน้าต่างอัปเดตของใบอนุญาต) จะโยน LicenseException ทันทีพร้อมข้อความเหตุผลการปฏิเสธ — การเปิดจะไม่ลดคุณภาพอย่างเงียบสำหรับใบอนุญาตที่ไม่ถูกต้อง (ต่างจากไม่มีใบอนุญาต) ใบอนุญาต Temporary หรือแบบสมัครสมาชิกที่หมดอายุตามปฏิทินเป็นข้อยกเว้น: จะไม่โยน — จะลดเป็นลายน้ำ
  2. การสร้างเซสชัน. โรงงาน viewer เลือก viewer ที่เหมาะสมกับรูปแบบไฟล์และโหลดเอกสาร (ดู Rendering Pipeline) เซสชันจะถูกเก็บใน IMemoryCache ภายใต้โทเคน GUID ใหม่พร้อม การหมดอายุแบบเลื่อน — DocOptions.TimeOut นาที, ค่าเริ่มต้น 60. ทุกคำขอหน้า จะรีเซ็ตนาฬิกา
  3. การลงทะเบียนความปลอดภัย. ด้วย UnsafeMode = false (ค่าเริ่มต้น), โทเคนจะผูกกับเซสชัน ASP.NET ของผู้เรียก: มาร์คเกอร์ secure-{token} จะถูกเขียนลงในเซสชัน, ดังนั้นเฉพาะเซสชันเบราว์เซอร์ที่เปิดเอกสารเท่านั้นที่สามารถขอหน้าของมันได้
  4. โทเคนถูกส่งกลับ. มันเป็นข้อมูลรับรองเดียวสำหรับทุกอย่างที่ตามมา

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

วิดเจ็ตรับหน้าต่างอย่างไร

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

คำค้นวัตถุประสงค์
?token=…&page=Nภาพหน้าที่เรนเดอร์ (PNG)
?token=…&page=N&thumb=1ภาพย่อ
?token=…&zoom=…การเรนเดอร์หน้าที่ซูม
?token=…&search=termการค้นหาข้อความเต็ม (จำกัดด้วยใบอนุญาต)
?token=…&bookmarksโครงร่างเอกสาร/บุ๊กมาร์ก
?token=…&copy / &showlinks / &fileFormat / &metaคัดลอกข้อความ, ลิงก์, ข้อมูลรูปแบบ, เมทาดาต้าเทคนิคของ 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.

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

การปิดเอกสาร

csharp
viewer.CloseDocument(token);

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

สรุปประเด็นสำคัญ

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

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