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

วงจรชีวิตของการร้องขอเอกสาร

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

ส่วนประกอบที่เคลื่อนที่

  • Viewer — บริการสาธารณะที่คุณดึงจาก DoconutHost.Services. มันเปิดเอกสารและคืนค่าโทเค็นเซสชัน.
  • เซสชันเอกสาร — วัตถุฝั่งเซิร์ฟเวอร์ที่เก็บเอกสารที่โหลดแล้ว, ถูกเก็บในหน่วยความจำภายใต้โทเค็นของมัน.
  • DocImage.axd — Doconut.DocImageHandler ที่ประกาศใน Web.config. มันตอบทุกคำขอที่วิดเจ็ตเบราว์เซอร์ทำ (หน้า, รูปย่อ, การค้นหา, คำอธิบาย, …) โดยจะระบุด้วยโทเค็นเสมอ.
  • /doconut-res/* — Doconut.DoconutResourceModule ที่ให้บริการสคริปต์, สไตล์, และไอคอนของวิดเจ็ตเอง.

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

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

csharp
// 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

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

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

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

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

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

ทุกคำขอจะถูกตรวจสอบเป็นอันดับแรก:

  • ไม่มีโทเค็น → 404, หรือแบนเนอร์เวอร์ชันเมื่อ ShowDoconutInfo = true.
  • โทเค็นไม่ได้รับการมอบให้กับ ASP.NET session นี้ → ภาพข้อผิดพลาดที่อ่านว่า You Are Not Authorized To View This Page.
  • โทเค็นที่ไม่รู้จักหรือหมดอายุ → ภาพข้อผิดพลาดที่อ่านว่า Document session not found. Please re-open document.

ภาพข้อผิดพลาดเป็น PNG ธรรมดาที่ส่งพร้อมสถานะ 200, ดังนั้นวิดเจ็ตจึงสามารถแสดงภาพเหล่านั้นในตำแหน่งที่หน้าจะอยู่. การตรวจสอบโดยมอนิเตอร์ที่ดูเฉพาะรหัสสถานะจะรายงานว่ามันเป็นหน้าที่ให้บริการ; หน้าจริงมีขนาดหลายสิบถึงหลายร้อยกิโลไบต์, ส่วนภาพข้อผิดพลาดประมาณ 2 KB.

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

csharp
viewer.CloseDocument(token);

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

ข้อสรุป

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

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