DoconutOptions

Doconut hizmetlerini yapılandırın

DoconutOptions (namespace Doconut) bütün SDK için tek yapılandırma nesnesidir. Bunu bir kez, AddDoconut() içinde yapılandırırsınız ve tek bir örnek olarak kaydedilir.

Bu, şekil kadar konum değişikliğidir. Önceki .NET Standard kitaplığında bir DoconutOptions örneği pipeline zamanında oluşturulur ve UseDoconut(new DoconutOptions { … })'a teslim edilirdi. Burada ara katman hiçbir seçenek almaz — her şey hizmet kaydı sırasında ayarlanır.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Özellikler

TürÖzellikVarsayılanAçıklama
boolShowDoconutInfofalsetrue olduğunda, token içermeyen bir ara katman isteği 404 yerine bir sürüm banner'ı (Doconut <version> is running on <host>) döndürür. Bir duman kontrolü olarak kullanışlıdır; üretimde false bırakın.
boolUnsafeModefalsetrue olduğunda, sayfa isteklerinde ASP.NET oturum güvenlik kontrolünü atlar. Tek bir düğümde üretimde false bırakın (bkz. Core Concepts → Sessions & Security). Önceden UnSafeMode olarak yazılmıştı.
stringMiddlewarePath"/doconut"Sayfa-görsel uç noktası için koordinasyon değeri. Doğrulanır, ancak bir pipeline dalı oluşturmaz; gerçek UseDoconut() eşlemesi ve istemci BasePath ile uyumlu tutun.
stringResourcesPath"/doconut-res"Gömülü JS/CSS/görsel/font kaynakları için URL yol ön eki.
stringLicensePath""Lisans dosyasının yolu. Boş → sonraki lisans kaynağı, ardından otomatik keşif; hiçbir şey bulunamazsa → özellikleri olmayan su damgası ekli değerlendirme durumu.
stringLicenseContent""Ham XML lisans içeriği (veritabanı, ortam değişkeni, gizli yönetici). LicensePath'a göre önceliklidir.
Stream?LicenseStreamnullLisans bir akış olarak, başlangıçta bir kez okunur. Diğer iki kaynağa göre önceliklidir.
boolResetLicensefalseAyrılmış uyumluluk bayrağı. Mevcut uygulama bunu kullanmaz; bir lisansı değiştirdikten sonra uygulamayı yeniden başlatın.
DoconutPluginRegistryPluginRegistry—Eklenti katkılarını toplayan yalnızca okunabilir kayıt defteri; görüntüleyici fabrikası tarafından tüketilir. AddPlugin<T>() aracılığıyla doldurun.

Lisans önceliği (servis kaydı sırasında uygulanır): LicenseStream → LicenseContent → LicensePath → otomatik keşif (bkz. Getting Started → License Setup).

Yöntemler

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Bu yöntemi yayınlanan isteğe bağlı Converter, DICOM ve Signer paketleri için kullanın. Açıklama ve normal Arama, yerleşik lisanslı özelliklerdir ve AddPlugin<TPlugin>() kullanmaz.

Bir birinci taraf eklentiyi (Converter, DICOM, Signer) kaydeder. Akıcı — seçenekler örneğini döndürür. AddDoconut(), eksik lisans, eski TRIAL dosyası veya eklentinin yeteneğini vermeyen ücretli lisans için InvalidOperationException fırlatır. Geçici/Demo kayıtları süresi dolana kadar tutulur ve çalışma zamanı kapısına (bkz. Core Concepts → Plugin System) tabi olur.

İsteğe bağlı Converter widget'ı AddConverterWidget() ile etkinleştirilir ve yalnızca okunabilir ConverterWidget özelliği üzerinden sunulur; seçenekleri Converter Plugin sayfasında belgelenmiştir (Plugins → Converter Plugin). İsteğe bağlı Signer widget'ı aynı şekilde, AddSignerWidget() ile etkinleştirilir ve yalnızca okunabilir SignerWidget özelliği üzerinden sunulur; bkz. Signer Plugin.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — başlangıçtaki nokta isteğe bağlı
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Bir dosya uzantısı için özel görüntüleyici kaydeder. Özel görüntüleyiciler yerleşik ve eklenti görüntüleyicilere göre önceliklidir ve lisans kısıtlamasına tabi değildir. defaultConfig atlandığında ve bir belge açıkça bir yapılandırma olmadan açıldığında, bir ImageConfig kullanılır.

Boş bir uzantı için ArgumentException (Extension must be a non-empty file extension.) ve null fabrika için ArgumentNullException fırlatır.

Başlangıç doğrulaması

AddDoconut() seçenekleri hızlı başarır şekilde doğrular, böylece bir yapılandırma hatası istek zamanındaki kafa karıştırıcı 404'ler yerine başlangıçta net bir istisna olarak ortaya çıkar:

text
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.

Ortak yapılandırmalar

csharp
// Production: açık lisans, her şey kilitlendi (tüm güvenlik varsayılanları)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// Özel yollar (e.g. bir rota çakışmasını önlemek için)
builder.Services.AddDoconut(options =>
{
    options.MiddlewarePath = "/docs-engine";
    options.ResourcesPath  = "/docs-assets";
});

ResourcesPath'ı değiştirdiğinizde, istemci widget'ının ResPath'ını senkronize tutun (bkz. ViewerConfig). Bu, hata mesajı olmadan başarısız olan iki istemci tarafı ayardan biridir.

MiddlewarePath otomatik bir ASP.NET Core rota eşleyicisi değildir. Doconut yalnızca özel bir ön ek altında yanıt vermeli ise, UseDoconut()'ı o dalda (örneğin app.Map("/docs-engine", branch => branch.UseDoconut()) ile) monte edin ve istemci BasePath'ı öndeki / olmadan o ön eke ayarlayın ('docs-engine'). Yaygın bir alternatif, tarihi DocImage.axd istek şeklini MapWhen dalında BasePath: '/' ile korur.

Bu sayfa yardımcı oldu mu?