Eklenti Sistemi

Görünümleyiciyi eklentilerle genişletin

Doconut'un çekirdeği ince kalır; isteğe bağlı işlevsellik eklentiler — görüntüleyiciler veya hizmetler sağlayan ayrı NuGet paketleri olarak gelir ve lisansınız tarafından etkinleştirilir. Bu sayfa kayıt modelini, lisans kısıtlamasının çalışma zamanında nasıl davrandığını ve kendi görüntüleyicinizi nasıl ekleyeceğinizi açıklar.

Eklentiyi Kaydetmek

Her eklenti paketi bir eklenti sınıfı ortaya çıkarır. Bunu 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 gerekli yeteneği ile etiketlenir. 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. 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; }                          // örnek olarak "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // lisans geçidi
    void Register(IDoconutPluginBuilder builder); // görünüm/servisler 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ıtlamalar

Yetkinlikler 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 görüntüleyici bir yetkinlik değildir — lisans hizmetinde IsViewerLicensed olarak sunulan ön koşuldur.

Başlangıç doğrulaması normalde lisanssız bir eklentinin istek boru hattına girmesini engeller. Görüntüleyici fabrikası ayrıca iki savunma çalışma zamanı kuralı uygular; bunlar, hakların başlangıçtan sonra değişmesi durumunda önemlidir:

  • Eklenti yerleşik bir görüntüleyiciyi geçersiz kılar (bir eklenti, yerleşik kayıt defterinin de işlediği bir uzantıyı talep eder): yetenek lisanslıysa, eklenti görüntüleyici kazanır; lisanssızsa, Doconut sessizce yerleşik görüntüleyiciye 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 bir görüntüleyicisi yoktur): 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 yetkinlikleri verir (temiz, su işareti olmayan temel görüntüleme ile). Bu, yayına geçişte klasik bir sürpriz kaynağıdır: aynı eklentileri, yetkinliklerinden birini dışarıda bırakan satın alınmış bir lisansla kaydetmek, AddDoconut()'in başlangıçta başarısız olmasına neden olur. Dağıtmadan önce IsCapabilityGranted(...)'i planınızla karşılaştırın. Diğer yandan: hiç lisans yoksa, hiçbir şey verilmez — eksik bir lisans bir 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 yayar, böylece widget'ın UI'si sunucunun gerçekte yapacaklarıyla tutarlı kalır.

Özellik ve eklenti haritası

Ürün UI'si “eklenti”yi geniş bir özellik etiketi olarak kullanır, ancak sunucu kaydı farklıdır:

ÖzellikNasıl etkinleştirildiYetkinlikKatkı
AçıklamaGörüntüleyiciye yerleşiktir; açıklama kaynaklarını içerirAnnotationTarayıcı oluşturma, oturum kalıcılığı ve yanmış dışa aktarmalar
AramaAranabilir format görüntüleyicilerine yerleşiktir; arama kaynaklarını içerir ve gerektiğinde çıkarımı etkinleştirirSearchYerel metin indeksi, vurgulamalar ve sonuç gezinmesi
DönüştürücüDoconut.NET6.Converter kurun ve ConverterPlugin kaydedinConverterC# dönüşüm hizmeti ve isteğe bağlı web widget'ı
DICOMDoconut.NET6.Dicom kurun ve DicomPlugin kaydedinDicom.dcm ve .ima için tıbbi görüntüleme
İmzalayıcıDoconut.NET6.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 normal Arama, AddPlugin<TPlugin>() kullanmaz; paketleri yalnızca lisans ilgili yetkinliği verdiğinde yayılır. Dönüştürücü, DICOM ve İmzalayıcı, isteğe bağlı IDoconutPlugin uygulamalarıdır.

Yayınlanmış eklenti paketleri

EklentiPaketYetkinlikKatkı
DönüştürücüDoconut.NET6.ConverterConverterBelge dönüştürme yetkinliği
DICOMDoconut.NET6.DicomDicomTıbbi görüntüleme (.dcm ve .ima — sadece eklenti formatları)
İmzalayıcıDoconut.NET6.SignerSignerPDF ve Word imzalama

Her biri, Eklentiler altında yapılandırması ve kullanımıyla ayrı bir sayfaya sahiptir.

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

Bir eklenti paketi yazmadan, doğrudan Program.cs üzerinden bir görüntüleyiciyi 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 görüntüleyiciler her şeyin — yerleşiklerin ve eklentilerin — önüne geçer ve lisans kısıtlamasına tabi değildir (kodunuzdur). Fabrika, varsayılan bir yapılandırma sağlamadığınızda bir ImageConfig'a 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 bozulur; sadece eklenti formatları bir LicenseException ile başarısız olur.
  • Aktif bir Geçici lisans her şeyi açar; üretim, satın aldıklarınızı açar. Göndermeden önce IDoconutLicenseService ile doğrulayın.

Bu sayfa yardımcı oldu mu?