Eklenti Sistemi

Görüntüleyiciyi eklentilerle genişletin

Doconut'un çekirdeği ince kalır; isteğe bağlı işlevsellik eklentiler — ayrı NuGet paketleri olarak gönderilir ve lisansınız tarafından etkinleştirilir. Bu sayfa kayıt modelini, bir lisans bir eklentiyi kapsamadığında başlangıçta ne olduğunu ve kendi görüntüleyicinizi nasıl ekleyeceğinizi açıklar.

Bir eklentiyi kaydetme

Her eklenti paketi bir eklenti sınıfı ortaya çıkarır. Bunu bir kez, Application_Start içinde kaydedin:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});
// Lisansı eksik olan kayıtlı bir eklenti burada, Application_Start içinde fırlatılır ve
// site daha sonra her isteğe boş bir 500 yanıtı verir. Sebep Windows olay günlüğünde.

AddPlugin<TPlugin>() eklentiyi oluşturur ve katkılarını DoconutOptions ile kaydetmesine izin verir. Bir eklentinin katkısı, eklentinin gerekli yetenek ile etiketlenir ve DoconutHost.Initialize, sitenin ilk isteğini hizmet vermeden önce her kaydedilmiş eklentiyi lisansa karşı kontrol eder.

Eksik bir eklenti lisansı siteyi durdurur

Aktif bir lisans bir kaydedilmiş eklentinin yeteneğini vermediğinde — hiç lisans yoksa, eski bir TRIAL dosyasıysa veya o yeteneği içermeyen bir ücretli lisanssa — DoconutHost.Initialize, Application_Start üzerinden InvalidOperationException fırlatır:

text
The Converter plugin is registered via AddPlugin but no active license grants Converter.
Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Converter.

System.Web içinde, Application_Start içindeki bir istisna bir hata sayfası üretmez. Her istek boş bir 500 yanıt verir, IIS günlüğü yararlı bir şey göstermez ve mesaj yalnızca Windows olay günlüğünde (Uygulama günlüğü, kaynak ASP.NET) görünür. Bir site, bir AddPlugin satırı eklendikten hemen sonra yanıt vermeyi durdurursa, önce wwwroot içindeki lisans dosyalarını kontrol edin — Lisans Kurulumu bölümüne bakın.

Sözleşme

Bir eklenti kasıtlı olarak küçük bir arabirimi uygular:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // örnek olarak "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // lisans geçidi
    void Register(IDoconutPluginBuilder builder); // görünümleyicileri/hizmetleri katkıda bulunun
}

Register içinde, oluşturucu iki tür katkıyı kabul eder:

  • builder.RegisterViewer(extension, factory) — bir dosya uzantısı için görüntüleyici; fabrika bir IFormatViewer döndürür (DICOM eklentisi bu şekilde .dcm ve .ima kaydeder),
  • builder.RegisterService<TContract>(() => …) — boru hattının diğer bölümlerinin arayabileceği tiplenmiş bir hizmet.

Yetkinlikler ve kısıtlama

Yetkinlikler lisans birimleridir. Converter, Dicom ve Signer isteğe bağlı eklentiler olarak gönderilir; Search ve Annotation aynı şekilde kısıtlanan yerleşik özelliklerdir. Temel görüntüleyici bir yetkinlik değildir — lisans hizmetinde IsViewerLicensed olarak ortaya çıkan önkoşuldur.

Başlangıç doğrulaması normalde lisanssız bir eklentiyi istek boru hattından dışarı tutar. Görüntüleyici fabrikası ayrıca iki savunma kuralı uygular; bu kurallar, hakların site çalışırken değişmesi durumunda önem kazanır:

  • Yerleşik bir görüntüleyiciyi geçersiz kılan bir eklenti (bir uzantıyı yerleşik bir görüntüleyicinin de işlediğini iddia eder): yetenek lisanslıysa, eklentinin görüntüleyicisi kazanır; lisanssızsa, Doconut yerleşik görüntüleyiciye geri döner. Kullanıcılar hâlâ belgelerini görür; sadece eklentinin davranışını almazlar.
  • Yalnızca eklenti formatı (.dcm ve .ima — DICOM'un yerleşik bir görüntüleyicisi yoktur): yetenek olmadan, açma başarısız olur:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Etkin bir Geçici lisans her yeteneği verir. Bu klasik bir yayına geçiş sürprizidir: aynı AddPlugin satırları, değerlendirme sırasında çalışan, satın alınan lisans bu yeteneklerden birini dışarı bıraktığında siteyi durdurur. Dağıtımdan önce satın aldıklarınızla IsCapabilityGranted(...) karşılaştırın. Hiç lisans yoksa, hiçbir şey verilmez — eksik bir lisans Geçici lisans değildir.

Aynı kısıtlama tarayıcıya da ulaşır: Viewer.ReferenceScripts() ve ReferenceCss(), lisans‑kısıtlı özellikler (Arama, Açıklama) için dosyaları yalnızca lisans verdiğinde yayar, böylece sayfa sunucunun reddedeceği bir özelliği asla sunmaz.

Özellik ve eklenti haritası

ÖzellikNasıl etkinleştirilirYetkinlikKatkılar
AçıklamaGörüntüleyiciye yerleşiktir; açıklama kaynaklarını dahil edinAnnotationTarayıcı oluşturma, oturum kalıcılığı, gömülü dışa aktarımlar
AramaAranabilir format görüntüleyicilerine yerleşiktir; arama kaynaklarını dahil edinSearchYerel metin indeksi, vurgulamalar, sonuç gezinmesi
DönüştürücüDoconut.NETFramework.Converter kurun ve ConverterPlugin kaydedinConverterC# dönüşüm hizmeti ve isteğe bağlı bir web widget'ı
DICOMDoconut.NETFramework.Dicom kurun ve DicomPlugin kaydedinDicom.dcm ve .ima için tıbbi görüntü izleme
İmzalayıcıDoconut.NETFramework.Signer kurun ve SignerPlugin kaydedinSignerPDF ve Word için görünür imzalar ve dijital mühürler: C# imzalama hizmeti ve isteğe bağlı bir web widget'ı

Açıklama ve Arama AddPlugin<TPlugin>() kullanmaz. Dönüştürücü, DICOM ve İmzalayıcı her biri Eklentiler altında kendi yapılandırma ve kullanım sayfasına sahiptir. Bu pakette, DICOM sayfaları, çerçeveleri ve animasyonları işler, ancak teknik meta verileri okumaz — DICOM Eklentisi bölümüne bakın.

Özel görüntüleyiciler — kendi format işleyiciniz

Bir eklenti paketi yazmadan, doğrudan Application_Start içinde bir görüntüleyiciyi boru hattına ekleyebilirsiniz:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),                        // IFormatViewer'ı uygular
        () => new ImageConfig { ImageResolution = 150 });  // isteğe bağlı varsayılan yapılandırma
});

// Fabrika tarafından oluşturulan format işleyicisi. Bu üyeleri kendi görselleştirmenizle değiştirin.
public sealed class MyCustomViewer : Doconut.Core.Interfaces.IFormatViewer
{
    public ViewerType ViewerType => ViewerType.None;
    public int TotalPages => 0;
    public int DefaultWidth => 0;
    public int DefaultHeight => 0;
    public bool PreferOcr => false;

    public Task LoadAsync(Stream documentStream, BaseConfig config, CancellationToken ct = default)
        => Task.CompletedTask;

    public Task<byte[]> GetPageImageAsync(int pageNumber, CancellationToken ct = default)
        => Task.FromResult(Array.Empty<byte>());

    public void Dispose() { }
}

Özel görüntüleyiciler her şeyin — yerleşiklerin ve eklentilerin — önceliğini alır ve lisans‑kısıtlamalı değildir: bunlar sizin kodunuzdur. Varsayılan bir yapılandırma sağlamazsanız, fabrika bir ImageConfig kullanır.

Çıkarımlar

  • Eklentiler DoconutHost.Initialize içinde açıkça kaydedilir ve yetkinlikleri orada doğrulanır; eksik bir hak, siteyi boş bir 500 ile durdurur ve nedeni Windows olay günlüğündedir.
  • Geçersiz kılma tarzı eklentiler zarifçe gerileşir; yalnızca eklenti formatları bir LicenseException ile başarısız olur.
  • Etkin bir Geçici lisans her şeyi açar; üretim ortamı satın aldıklarınızı açar. Göndermeden önce IDoconutLicenseService ile kontrol edin.

Bu sayfa yardımcı oldu mu?