Eklenti Sistemi

İzleyiciyi eklentilerle genişlet

Doconut'un çekirdeği hafif kalır; isteğe bağlı işlevsellik eklenti — ayrı NuGet paketleri olarak gönderilir ve lisansınızla etkinleştirilir. Bu sayfa kayıt modelini, lisans kısıtlamasının çalışma zamanında nasıl davrandığını ve kendi izleyicinizi nasıl ekleyeceğinizi açıklar.

Bir eklentiyi kaydetme

Her eklenti paketi bir eklenti sınıfı ortaya çıkarır. Bunu yalnızca bir kez, başlangıçta kaydedersiniz:

csharp
builder.Services.AddDoconut(options =>
{
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

AddPlugin<TPlugin>() eklentiyi örnekler ve DoconutOptions üzerinde tutulan eklenti kayıt defterine karşı Register geri çağrısını yürütür. Bir eklentinin katkısı, eklentinin required capability (gerekli yetenek) etiketiyle işaretlenir. AddDoconut() kayıtlı eklentileri hemen doğrular: eksik bir lisans, eski TRIAL dosyası veya yetenek olmadan ücretli lisans, başlangıcı InvalidOperationException ile başarısız kılar. Bir Geçici/Demo kaydı süresi dolana kadar korunur, ancak çalışma zamanı yetenekleri son tarih geçtikten sonra iptal edilir.

Sözleşme

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

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // örn. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // lisans geçidi
    void Register(IDoconutPluginBuilder builder); // görüntüleyicileri/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 izleyici; 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.

Yetenekler ve kısıtlama

Yetenekler lisans birimleridir. Converter, Dicom ve Signer isteğe bağlı eklentiler olarak gelir; Search ve Annotation aynı şekilde kısıtlanan yerleşik özelliklerdir. Temel izleyici bir yetenek değildir — ön koşuldur ve lisans hizmetinde IsViewerLicensed olarak ortaya çıkar.

Başlangıç doğrulaması normalde lisanssız bir eklentinin istek boru hattına girmesini engeller. İzleyici fabrikası ayrıca iki savunma çalışma zamanı kuralı uygular; bunlar, haklar başlangıçtan sonra değişirse önemlidir:

  • Eklenti yerleşik bir izleyiciyi geçersiz kılar (bir eklenti, yerleşik kaydın da işlediği bir uzantıyı talep eder): yetenek lisanslıysa, eklenti izleyicisi kazanır; lisanssızsa, Doconut sessizce yerleşik izleyiciye geri döner. Kullanıcılar hâlâ belgelerini görür — sadece eklenti özelliğini almazlar.
  • Sadece eklenti formatı (.dcm ve .ima — DICOM'un yerleşik izleyicisi yok): yetenek olmadan açma çağrısı sert bir şekilde başarısız olur:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Aktif bir Geçici lisansı tüm yetenekleri verir (temiz, filigran içermeyen temel görüntüleme ile). Bu, yayına geçişte klasik bir sürpriz kaynağıdır: aynı eklentileri, bir yeteneği eksik bir satın alınmış lisansla kaydetmek, AddDoconut()'nin başlangıçta başarısız olmasına neden olur. Dağıtmadan önce planınıza karşı IsCapabilityGranted(...)'yi karşılaştırın. Diğer yandan: hiç lisans yoksa, hiçbir şey verilmez — eksik bir lisans Geçici lisans değildir.

Aynı kısıtlama istemci tarafında da görülür: Viewer.ReferenceScripts() ve ReferenceCss(), lisans kısıtlamalı özellikler (arama, açıklama, …) için script/stil paketlerini yalnızca lisans etkinleştirdiğinde üretir, böylece widget'ın UI'si sunucunun gerçekte yapacaklarıyla tutarlı kalır.

Özellik ve eklenti haritası

ÖzellikNasıl etkinleştirilirYetenekKatkı sağlar
Açıklamaİzleyiciye yerleşiktir; açıklama kaynaklarını içerirAnnotationTarayıcı oluşturma, oturum kalıcılığı ve gömülü dışa aktarmalar
AramaAranabilir format izleyicilerine yerleşiktir; arama kaynaklarını içerir ve gerektiğinde çıkarımı etkinleştirirSearchYerel metin indeksi, vurgulamalar ve sonuç navigasyonu
DönüştürücüDoconut.NET8.Converter kurun ve ConverterPlugin kaydedinConverterC# dönüşüm hizmeti ve isteğe bağlı web widget'ı
DICOMDoconut.NET8.Dicom kurun ve DicomPlugin kaydedinDicomTıbbi görüntü izleme için .dcm ve .ima
İmzalayıcıDoconut.NET8.Signer kurun ve SignerPlugin kaydedinSignerPDF ve Word için görülebilir imzalar ve dijital mühürler: C# imzalama hizmeti ve isteğe bağlı bir web widget'ı

Açıklama ve normal Arama AddPlugin<TPlugin>() kullanmaz; paketleri yalnızca lisans ilgili yeteneği verdiğinde üretilir. Dönüştürücü, DICOM ve İmzalayıcı isteğe bağlı IDoconutPlugin uygulamalardır.

Yayınlanan eklenti paketleri

EklentiPaketYetenekKatkı sağlar
DönüştürücüDoconut.NET8.ConverterConverterBelge dönüşüm yeteneği
DICOMDoconut.NET8.DicomDicomTıbbi görüntü izleme (.dcm ve .ima — sadece eklenti formatları)
İmzalayıcıDoconut.NET8.SignerSignerPDF ve Word imzalama

Her biri Eklentiler altında yapılandırma ve kullanım sayfasına sahiptir.

Özel izleyiciler — kendi format işleyiciniz

Bir eklenti paketi yazmadan, doğrudan Program.cs üzerinden izleyiciyi boru hattına ekleyebilirsiniz:

csharp
builder.Services.AddDoconut(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 render'ınızla 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 izleyiciler her şey üzerinde öncelik alır — yerleşikler ve eklentiler de dahil — ve lisans kısıtlamasına tabi değildir (kodunuzdur). Fabrika, varsayılan bir yapılandırma sağlamadığınızda bir ImageConfig'ye geri döner.

Çıkarımlar

  • Eklentiler açıkça kaydedilir ve LicenseCapability'leri AddDoconut() sırasında doğrulanır — eksik veya yetersiz geçici olmayan haklar hızlıca başarısız olur.
  • Geçersiz kılma tarzı eklentiler zarifçe geriler; sadece eklenti formatları bir LicenseException ile başarısız olur.
  • Aktif bir Geçici lisansı her şeyi açar; üretim ortamı satın aldıklarınızı açar. Göndermeden önce IDoconutLicenseService ile doğrulayın.

Bu sayfa yardımcı oldu mu?