Görüntüleyicinin Nasıl Çalıştığı

Belge isteği yaşam döngüsü

Doconut, belgeleri ASP.NET Core ara katmanı aracılığıyla sunulan sayfalı görüntüler olarak işler. Yaşam döngüsünü — açma, belirteç, sayfa istekleri, kapatma — anlamak, gözlemleyeceğiniz neredeyse tüm davranışları, hata mesajları dahil, açıklar.

Üç Hareketli Parça

  • Viewer — enjekte ettiğiniz genel hizmet. Belgeleri açar ve oturum belirteçleri döndürür.
  • Belge oturumu — yüklü belgeyi tutan, IMemoryCache içinde bir belirteçle anahtarlanan sunucu tarafı nesne.
  • UseDoconut() tarafından eklenir; tarayıcı widget'ının yaptığı her isteğe (pages, thumbnails, search, annotations, …) yanıt verir, her zaman belirteç ile kimlik doğrulanır.

Viewer durumsuzdur — tasarım gereği

Viewer mühürlenmiştir, istek başına belge durumu tutmaz ve kasıtlı olarak IDisposable'ı uygulamaz. Oturumlar, oturum yöneticisinde bağımsız olarak yaşar ve önbellek süresi dolması ya da açık bir CloseDocument(token) ile temizlenir.

Artık onu oluşturmazsınız. AddDoconut(), onu geçici bir hizmet olarak kaydeder; ihtiyacınız olduğu her yerde enjekte edin:

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

Bir MVC uygulamasında, bunu bir yapıcı parametresi olarak alın; bir Razor görünümünde, @inject Doconut.Viewer Viewer kullanın. Viewer örneklerinin uygulama sahipliğindeki önbellekleri artık gerekmez — ve artık doğru değildir, çünkü önbelleğe değer bir şey tutmazlar.

OpenDocumentAsync içinde neler olur

  1. Lisans kapısı. Reddedilen ya da sürüm süresi dolmuş bir lisans (kara listeye alınmış, değiştirilmiş veya lisansın güncelleme penceresinin dışındaki bir derleme) hemen bir LicenseException fırlatır, reddetme nedeni mesaj olarak verilir — açma, geçersiz (eksik olmayan) bir lisans için asla sessizce bozulmaz. Takvim süresi dolmuş Geçici ya da abonelik lisansı bir istisnadır: fırlatmaz — bir filigrana düşer.
  2. Oturum oluşturma. Görüntüleyici fabrikası dosya uzantısı için doğru format görüntüleyiciyi seçer ve belgeyi yükler (Rendering Pipeline'a bakın). Oturum, yeni bir GUID belirteciyle IMemoryCache içinde kaydırmalı süresi dolma ile saklanır — DocOptions.TimeOut dakika, varsayılan 60. Her sayfa isteği saati sıfırlar.
  3. Güvenlik kaydı. UnsafeMode = false (varsayılan) ile belirteç, çağıranın ASP.NET oturumuna bağlanır: oturuma bir secure-{token} işareti yazılır, böylece belgeyi açan tarayıcı oturumu yalnızca sayfalarını isteyebilir.
  4. Belirteç döndürülür. Sonraki tüm işlemler için tek kimlik bilgisi budur.

Ayrı bir ısınma adımı yoktur. Önceki kütüphane bu amaçla InitCache()'ı ortaya koymuştu; artık mevcut değil ve yerini hiçbir şey almıyor.

Üç aşırı yükleme yalnızca girişte farklıdır: bir dosya yolu, bir dosya yolu artı format başına yapılandırma (PdfConfig, WordConfig, …) veya bir Stream artı uzantısı format algılamasını yönlendiren bir FileInfo.

Widget'ın Sayfaları Nasıl Aldığı

İstemci widget'ı, sorgu dizesinde belirteçle Doconut ara katmanını çağırır. Ara katmanın yaptığı, isteğe bağlıdır:

SorguAmaç
?token=…&page=NOluşturulan sayfa görüntüsü (PNG)
?token=…&page=N&thumb=1Küçük resim
?token=…&zoom=…Yakınlaştırılmış sayfa render'ı
?token=…&search=termTam metin arama (lisans kontrollü)
?token=…&bookmarksBelge taslağı/yer imleri
?token=…&copy / &showlinks / &fileFormatMetin kopyalama, hiperlinkler ve format bilgisi
?token=…&metaDICOM teknik meta verileri; bu paket üzerindeki bir DICOM oturumu için 501 döndürür
?token=…&action=rotate/flip/closeSayfa eylemleri ve açık kapatma
?token=…&AnnSave=… / &AnnLoadEk açıklamaları kaydet/yükle

Bu yolların her biri önce doğrulanır:

  • Belirteç yok → ara katman 404 döndürür (veya ShowDoconutInfo = true olduğunda bir sürüm banner'ı).
  • Bilinmeyen veya süresi dolmuş belirteç → Document session not found. Please re-open document. içeren bir hata görüntüsü
  • Oturum ara katmanı eksik (UnsafeMode = false ile) → Session middleware not configured. Call UseSession() before UseDoconut(). içeren HTTP 500
  • Belirteç farklı bir tarayıcı oturumu tarafından açıldı → You Are Not Authorized To View This Page. içeren bir hata görüntüsü

Ara katmanın Nerede Bağlandığı

UseDoconut(), bir belirteç taşıyan istekleri yanıtlar, nerede bağlarsanız bağlayın. Yaygın bir kurulum, tarihsel DocImage.axd istek şekline bir MapWhen dalında devam eder, böylece mevcut istemci her zaman yaptığı URL'yi çağırmaya devam eder. Ne seçerseniz seçin, istemcinin BasePath'ı bununla aynı olmalıdır — bakınız GörüntüleyiciYapılandırması.

Sayfaları açma düğümü yerine paylaşımlı depolamadan sunmak tamamen farklı bir düzenlemedir; bakınız Dağıtık Dağıtımlar.

Bir Belgeyi Kapatma

csharp
viewer.CloseDocument(token);

CloseDocument, oturumu önbellekten kaldırır (bu, temel belge motorunu yok eder ve belleğini hemen serbest bırakır), secure-{token} işaretini siler ve erişim iznini iptal eder. Çağırmak isteğe bağlıdır — kaydırmalı süresi dolma aynı temizlik işlemini otomatik yapar — ancak büyük belgeler için, kullanıcı işini bitirdiği anda belleği serbest bırakmanın nazik yoludur.

Bu, enjekte edilen Viewer üzerinde çağrılır. Önceki desen — bir belirteci kapatmak için sadece bir using bloğunda kısa ömürlü bir Viewer oluşturmak — eşdeğeri yoktur ve gerekmez.

Çıkarımlar

  • Bir açık belge = bir oturum = bir belirteç. Belirteçler tarayıcı oturumu başına, küresel URL'ler değil.
  • Belirteç, kaydırmalı bir pencere içinde süresi dolar; DocOptions.TimeOut sonrası boşta kalan bir görüntüleyici yeniden açılmaya ihtiyaç duyar.
  • Viewer enjekte edilebilir ve serbestçe paylaşılabilir; oturumlar tüm durumu taşır.

Bu sayfa yardımcı oldu mu?