Cara Kerja Viewer
Siklus Hidup Permintaan Dokumen
Doconut merender dokumen sebagai gambar berhalaman, disajikan oleh penangkap HTTP yang didaftarkan oleh Web.config Anda. Memahami siklus hidup — buka, token, permintaan halaman, tutup — menjelaskan hampir semua perilaku yang akan Anda amati, termasuk pesan kesalahan.
Bagian-bagian yang bergerak
Viewer— layanan publik yang Anda dapatkan dariDoconutHost.Services. Ia membuka dokumen dan mengembalikan token sesi.- Sesi dokumen — objek sisi server yang menyimpan dokumen yang dimuat, disimpan dalam memori di bawah tokennya.
DocImage.axd—Doconut.DocImageHandleryang dideklarasikan dalamWeb.config. Ia menjawab setiap permintaan yang dibuat widget browser (halaman, miniatur, pencarian, anotasi, …), selalu diidentifikasi oleh token./doconut-res/*—Doconut.DoconutResourceModule, yang menyajikan skrip, gaya, dan ikon milik widget.
Viewer tidak memiliki status — secara desain
Viewer tidak menyimpan status dokumen per-permintaan dan tidak mengimplementasikan IDisposable. Sesi hidup secara independen darinya dan dibersihkan oleh kedaluwarsa atau CloseDocument(token) yang eksplisit. System.Web tidak memiliki injeksi konstruktor, jadi dapatkan di tempat Anda membutuhkannya — biasanya dalam aksi kontroler:
// 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");
}Apa yang terjadi di dalam OpenDocumentAsync
- Gerbang lisensi. Sebuah lisensi yang ditolak (dimodifikasi, masuk daftar hitam, atau build di luar jendela pembaruan lisensi) melempar
LicenseExceptionsecara langsung, dengan alasan sebagai pesan. Membuka tidak pernah secara diam-diam menurun untuk lisensi tidak valid; lisensi hilang hanya menambahkan watermark. - Pembuatan sesi. Pabrik viewer memilih viewer format untuk ekstensi file dan memuat dokumen (lihat Rendering Pipeline). Sesi disimpan dalam memori di bawah token acak baru dengan kedaluwarsa bergulir selama
DocOptions.TimeOutmenit (default 60). Setiap permintaan halaman mengatur ulang penghitung waktu. - Pemberian akses. Dengan
UnsafeMode = false(default), token diikat ke sesi ASP.NET dari permintaan yang membukanya: entrisecure-{token}ditulis ke dalam sesi tersebut. Oleh karena itu, pembukaan harus dijalankan dalam permintaan dengan status sesi — lihat Sessions & Security. - Token dikembalikan. Itu adalah satu-satunya pengenal yang dibutuhkan browser untuk semua hal selanjutnya.
Overload asynchronous menerima jalur file, jalur file ditambah konfigurasi per-format (PdfConfig, WordConfig, …), atau Stream ditambah FileInfo yang ekstensi pilihannya menentukan format. Untuk kode-behind Web Forms yang tidak menggunakan halaman asynchronous, OpenDocument menawarkan tiga masukan yang sama secara sinkron (jalur, aliran dengan nama file, atau array byte dengan nama file).
Bagaimana widget mendapatkan halaman
Widget memanggil DocImage.axd dengan token di string kueri. Apa yang dilakukan penangkap tergantung pada permintaan:
| Kueri | Tujuan |
|---|---|
?token=…&page=N | Gambar halaman yang dirender (PNG) |
?token=…&page=N&thumb=1 | Miniatur |
?token=…&zoom=… | Perenderan halaman ter-zoom |
?token=…&search=term | Pencarian teks penuh (dibatasi lisensi) |
?token=…&bookmarks | Garis besar dokumen dan penanda |
?token=…© / &showlinks / &fileFormat | Penyalinan teks, tautan, dan informasi format |
?token=…&meta | metadata teknis DICOM — tidak tersedia pada paket ini (menjawab 404) |
?token=…&action=rotate/flip/close | Aksi halaman dan penutupan eksplisit (POST) |
?token=…&AnnSave=… / &AnnLoad | Simpan dan muat anotasi |
Setiap permintaan diperiksa terlebih dahulu:
- Tidak ada token →
404, atau banner versi ketikaShowDoconutInfo = true. - Token tidak diberikan ke sesi ASP.NET ini → gambar kesalahan dengan teks
You Are Not Authorized To View This Page. - Token tidak dikenal atau kedaluwarsa → gambar kesalahan dengan teks
Document session not found. Please re-open document.
Gambar kesalahan adalah PNG biasa yang dikirim dengan status 200, sehingga widget dapat menampilkannya di tempat halaman seharusnya. Pemeriksaan pemantauan yang hanya melihat kode status akan melaporkan mereka sebagai halaman yang disajikan; halaman nyata berukuran puluhan hingga ratusan kilobyte, gambar kesalahan sekitar 2 KB.
Menutup dokumen
viewer.CloseDocument(token);CloseDocument menghapus sesi (melepaskan mesin dokumen dan memorinya segera), menghapus entri secure-{token} dari sesi ASP.NET permintaan saat ini, dan mencabut token. Ini opsional — kedaluwarsa bergulir melakukan pembersihan yang sama — tetapi untuk dokumen besar itu melepaskan memori begitu pengguna selesai. Dari browser, objViewer.Close(true) mengirim permintaan tutup yang setara ke DocImage.axd.
Poin-poin penting
- Satu dokumen terbuka = satu sesi = satu token, diberikan ke sesi ASP.NET yang membukanya.
- Token kedaluwarsa pada jendela bergulir; viewer yang dibiarkan menganggur melewati
DocOptions.TimeOutmembutuhkan pembukaan ulang. Viewerdapat diresolusikan dan dibagikan secara bebas; sesi-sesi membawa semua status.
Apakah halaman ini membantu?