Kurulum

Doconut'u .NET Standard 2.1 projenize ekleyin

.NET Standard için temel Doconut görüntüleyicisi, herhangi bir ASP.NET Core uygulamasına bağlanan tek bir NuGet paketi olarak gelir. İsteğe bağlı eklentiler ayrı paketler kullanır. Bu sayfa temel paketi kurar, ana bilgisayarınızın bunu tüketebileceğini doğrular ve ara katmanı (middleware) kaydeder — ilk render'ınızdan önce gereken minimum şey.

Öncelikle ana bilgisayar çerçevesini kontrol edin

Kütüphane netstandard2.1 hedefler. Bu, önceki netstandard2.0 derlemesinden daha dar bir sözleşmedir ve doğrulanması gereken ilk şeydir:

Ana BilgisayarDestekleniyor
.NET Core 3.0 veya daha yeni, .NET 5/6/7/8 dahilEvet
.NET Framework (herhangi bir sürüm)Hayır — netstandard2.1 .NET Framework tarafından tüketilemez

Paket yalnızca yalnızca Windows üzerinde çalışır. Linux ana bilgisayarı için Doconut.NET8 veya Doconut.NET6 kullanın.

Uygulama .NET Framework üzerinde çalışıyorsa, bu doğru paket değildir. Bunun yerine Doconut.NETFramework kullanın; 26.9.0 sürümünden itibaren .NET Framework 4.7.2 gerektirir.

Paketi kurun

bash
dotnet add package Doconut.NETStandard

Sürüm belirtilmemiş komut en son kararlı sürümü kurar. Bu belgede açıklanan sürümü sabitlemek için, sürümü ayrı bir seçenek olarak geçirin:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard paket kimliğidir. Sürüm soneki, indirilen Doconut.NETStandard.<version>.nupkg dosya adının bir parçasıdır ve kimliğin bir bölümü değildir.

Sürüm numarası nesildir

Bu, paket adından daha çok burada önemlidir. .NET Standard kütüphanesinin her iki nesli de aynı paket kimliği altında yayınlanır, ve yalnızca sürüm onları ayırır:

SürümHedefAPI
26.7.0 ve altınetstandard2.0önceki entegrasyon
26.8.0 ve üstünetstandard2.1burada belgelenen entegrasyon

Uyumluluk köprüsü ve yan yana paket yoktur. Sürümü yükseltmek güncelleme demektir ve derleyici API farklarını hemen raporlayacaktır.

Belgeleri yalnızca paket adından seçmeyin:

  • new Viewer(_cache, _accessor, …), UnSafeMode, senkron OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm ve manuel olarak kopyalanmış görüntüleyici betikleri, önceki entegrasyon olarak tanımlar;
  • AddDoconut(), UseDoconutResources(), enjekte edilmiş bir Viewer ve OpenDocumentAsync(...), burada belgelenen mevcut entegrasyonu tanımlar.

Çevrilen önceki kurulum kılavuzu hâlâ mevcuttur. Nesilleri değiştirmek için geçiş kılavuzu kullanın; bir paket güncellemesi başlangıç, görüntüleyici ömrü veya tarayıcı kaynaklarını otomatik olarak dönüştürmez.

Doconut'u kaydedin

AddDoconut() tek kayıt giriş noktasıdır — tek bir aşırı yükleme vardır ve Viewer hizmetini, lisans hizmetini ve render altyapısını DI konteynerine bağlar.

Kurulumu tamamlamak için iki ara katman çağrısı vardır ve sıraları önemlidir: UseDoconutResources(), UseDoconut()'den önce çalışmalıdır. UseDoconut() terminal bir ara katmandır, bu yüzden onu önce çağırmak, bir /doconut-res varlığına yapılan her isteğin kaynak işleyicisine ulaşamamasına ve 404 hatası almasına neden olur. UseDoconut() ona ulaşan her isteğe yanıt verir, bu yüzden onu kendi dalında app.Map ile monte edin. Oturum bağlaması da gereklidir — Doconut'un varsayılan belge güvenliği, her sayfa isteğini ASP.NET oturum durumuna karşı doğrular.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // oturum durumu bir önbelleğe ihtiyaç duyar (MVC/Razor Pages zaten bir tane ekler)
builder.Services.AddSession(); // Doconut belge güvenliği ASP.NET oturum durumuna dayanır

app.UseSession();          // UseDoconut()'dan önce UseSession() çağırın
app.UseDoconutResources(); // UseDoconut()'dan önce kaydedilmelidir
app.Map("/doconut", branch => branch.UseDoconut());

Ad Alanları

Bu sürümde yapılandırma türleri artık dört ad alanına dağılmış değildir. Neredeyse her şey kök Doconut ad alanında bulunur:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, tüm format yapılandırmaları
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // bulut ve dosya paylaşım yapılandırmaları
using Doconut.Configs.Conversion;    // ConversionTarget

Tür adları kendileri değişmedi — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig ve diğerleri hâlâ mevcut. Mevcut bir uygulamayı taşıyorsanız, çoğu dosyada sadece iki silinmiş using satırı gerekir; geçiş kılavuzu'na bakın.

Tüm seçenekler

DoconutOptions aşağıdaki ayarlanabilir özellikleri kabul eder. Hepsi isteğe bağlıdır — bir özellik ayarlanmamış bırakıldığında aşağıdaki varsayılanlar uygulanır.

ÖzellikVarsayılanAçıklama
ShowDoconutInfofalsetrue olduğunda, token içermeyen bir istek 404 yerine bir sürüm banner'ı döndürür. Duman kontrolü olarak faydalıdır; üretimde kapatın.
UnsafeModefalsetrue olduğunda, sayfa isteklerinde ASP.NET-oturum güvenlik kontrolünü atlar. Üretimde kapatın. Yazımına dikkat — önceki kütüphane buna UnSafeMode derdi.
MiddlewarePath"/doconut"Sayfa-görsel uç noktası için koordinasyon değeri. Doğrulanır, ancak tek başına bir dal monte etmez; gerçek UseDoconut() eşlemesi ve istemci BasePath ile uyumlu tutun.
ResourcesPath"/doconut-res"Gömülü JS/CSS/görsel kaynakların nereden sunulduğu.
LicensePath"" (empty string)Lisans dosyasının yolu. Boş ise bir sonraki kaynağa geçilir, ardından otomatik arama yapılır.
LicenseContent"" (empty string)Ham lisans içeriği — bir ortam değişkeni, gizli yönetici veya veritabanından.
LicenseStreamnullLisans bir akış olarak, başlangıçta bir kez okunur.
ResetLicensefalseAyrılmış uyumluluk bayrağı. Lisans AddDoconut() sırasında okunur; lisans değiştirildikten sonra uygulamayı yeniden başlatın.
MaxConcurrentEditorSessions200Canlı editör oturumlarının (DocOptions.EditMode ile açılan belgeler) maksimum sayısı. Bu sayı aşıldığında, en az kullanılan boşta editör oturumu kapatılır. Normal görüntüleyici oturumları sayılmaz. 0 veya negatif bir değer sınırsız anlamına gelir.
EditorSnapshotEveryOps50Editör kalıcılığı etkinleştirildiğinde (AddDoconutEditorPersistence), canlı belgeyi her N kaydedilen değişiklikte bir anlık görüntü alır. 0 veya negatif bir değer oturum ortasında anlık görüntü almaz. Kalıcılık devre dışı bırakıldığında etkisi yoktur.

Birden fazla kaynak ayarlandığında lisans önceliği: LicenseStream, LicenseContent, LicensePath ve otomatik aramayı geçer — Lisans Kurulumu'na bakın.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // uygulama haritalaması ve istemci BasePath'iyle koordine edin
    options.ResourcesPath   = "/doconut-res"; // viewer'ın JS/CSS/görsellerinin hizmet verildiği yer
    options.UnsafeMode      = false;          // oturum güvenliğini açık tutun
    options.ShowDoconutInfo = false;
});

Sonraki adımlar

Bu sayfa yardımcı oldu mu?