Sistem Plugin

Perluas penampil dengan plugin

Inti Doconut tetap ringan; fungsionalitas opsional dikirim sebagai plugin — paket NuGet terpisah yang menyumbangkan penampil atau layanan dan diaktifkan oleh lisensi Anda. Halaman ini menjelaskan model pendaftaran, bagaimana pengaturan lisensi berperilaku pada waktu berjalan, dan cara menambahkan penampil Anda sendiri.

Model ini baru dalam rilis ini. Perpustakaan .NET Standard sebelumnya tidak memiliki registri plugin: konversi berada pada penampil itu sendiri dan lisensi plugin diinstal melalui panggilan statis Viewer.SetLicensePlugin(...). Tidak ada yang merupakan mekanisme pendaftaran di sini.

Mendaftarkan plugin

Setiap paket plugin mengekspos satu kelas plugin. Anda mendaftarkannya sekali, saat startup:

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

AddPlugin<TPlugin>() menginstansiasi plugin dan memanggil callback Register terhadap registri plugin yang disimpan pada DoconutOptions. Semua yang disumbangkan plugin ditandai dengan kapabilitas yang diperlukan plugin. AddDoconut() memvalidasi plugin yang terdaftar secara langsung: lisensi yang hilang, file legacy TRIAL, atau lisensi berbayar tanpa kapabilitas menyebabkan startup gagal dengan InvalidOperationException. Registrasi Temporary/Demo dipertahankan melewati kedaluwarsa, tetapi kapabilitas runtime‑nya dicabut setelah tanggal kedaluwarsa.

Kontrak

Sebuah plugin mengimplementasikan antarmuka yang sengaja kecil:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // mis. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // gerbang lisensi
    void Register(IDoconutPluginBuilder builder); // kontribusi penampil/layanan
}

Di dalam Register, pembangun menerima dua jenis kontribusi:

  • builder.RegisterViewer(extension, factory) — sebuah penampil untuk ekstensi file; pabrik mengembalikan sebuah IFormatViewer (plugin DICOM mendaftarkan .dcm dan .ima dengan cara ini),
  • builder.RegisterService<TContract>(() => …) — layanan bertipe yang dapat dicari oleh bagian lain dari pipeline.

Kapabilitas dan pengaturan

Kapabilitas adalah unit lisensi. Converter, Dicom, dan Signer dikirim sebagai plugin pilihan; Search dan Annotation adalah fitur bawaan yang diatur dengan cara yang sama. Penampil dasar bukan kapabilitas — ia adalah prasyarat, diekspose sebagai IsViewerLicensed pada layanan lisensi.

Validasi startup biasanya mencegah plugin tanpa lisensi masuk ke pipeline permintaan. Pabrik penampil juga menerapkan dua aturan runtime defensif, yang penting jika hak berubah setelah startup:

  • Plugin menggantikan penampil bawaan (sebuah plugin mengklaim ekstensi yang juga ditangani oleh registri bawaan): dengan kapabilitas berlisensi, penampil plugin menang; tanpa itu, Doconut diam‑diam kembali ke penampil bawaan. Pengguna tetap melihat dokumen mereka — mereka hanya tidak mendapatkan fitur plugin.
  • Format hanya plugin (.dcm dan .ima — DICOM tidak memiliki penampil bawaan): tanpa kapabilitas panggilan buka gagal keras:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Lisensi Temporary yang aktif memberikan semua kapabilitas (dengan tampilan dasar bersih, tanpa watermark). Ini adalah sumber kejutan klasik saat peluncuran: mendaftarkan plugin yang sama dengan lisensi yang dibeli tetapi tidak menyertakan salah satu kapabilitasnya membuat AddDoconut() gagal saat startup. Bandingkan IsCapabilityGranted(...) dengan rencana Anda sebelum menerapkan. Sebaliknya: dengan tidak ada lisensi sama sekali, tidak ada yang diberikan — lisensi yang hilang bukan lisensi Temporary.

Pengaturan yang sama muncul di sisi klien: Viewer.ReferenceScripts() dan ReferenceCss() menghasilkan bundel skrip/gaya untuk fitur yang diatur lisensi (pencarian, anotasi, …) hanya ketika lisensi mengaktifkannya, sehingga UI widget tetap konsisten dengan apa yang sebenarnya dilakukan server.

Peta Fitur dan Plugin

UI produk menggunakan "plugin" sebagai label fitur yang luas, tetapi pendaftaran server berbeda:

FiturCara diaktifkanKapabilitasKontribusi
AnnotationTerintegrasi dalam penampil; termasuk sumber daya anotasiAnnotationPembuatan di peramban, persistensi sesi, dan ekspor yang dibakar
SearchTerintegrasi dalam penampil format yang dapat dicari; termasuk sumber daya pencarian dan mengaktifkan ekstraksi bila diperlukanSearchIndeks teks asli, sorotan, dan navigasi hasil
ConverterPasang Doconut.NETStandard.Converter dan daftarkan ConverterPluginConverterLayanan konversi C# dan widget web opsional
DICOMPasang Doconut.NETStandard.Dicom dan daftarkan DicomPluginDicomPenampilan gambar medis untuk .dcm dan .ima
SignerPasang Doconut.NETStandard.Signer dan daftarkan SignerPluginSignerTanda tangan yang terlihat dan segel digital untuk PDF dan Word: layanan penandatanganan C# dan widget web opsional

Annotation dan Search normal tidak menggunakan AddPlugin<TPlugin>(); bundel mereka hanya dihasilkan ketika lisensi memberikan kapabilitas yang bersangkutan. Converter, DICOM, dan Signer adalah implementasi pilihan IDoconutPlugin.

Paket plugin yang dirilis

PluginPaketKapabilitasKontribusi
ConverterDoconut.NETStandard.ConverterConverterKapabilitas konversi dokumen
DICOMDoconut.NETStandard.DicomDicomPenampilan gambar medis (.dcm dan .ima — format hanya plugin)
SignerDoconut.NETStandard.SignerSignerPenandatanganan PDF dan Word

Setiap memiliki halaman khusus di bawah Plugin dengan konfigurasi dan penggunaannya.

Penampil khusus — penangan format Anda sendiri

Anda dapat menambahkan penampil ke pipeline tanpa menulis paket plugin, langsung dari Program.cs:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // mengimplementasikan IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // konfigurasi default opsional
});

// Penangani format yang dibuat oleh pabrik. Ganti anggota-anggota ini dengan rendering Anda sendiri.
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() { }
}

Penampil khusus memiliki prioritas di atas semua — baik bawaan maupun plugin — dan tidak diatur lisensi (mereka adalah kode Anda). Pabrik kembali ke sebuah ImageConfig ketika Anda tidak menyediakan konfigurasi default.

Kesimpulan

  • Plugin didaftarkan secara eksplisit dan LicenseCapability mereka divalidasi selama AddDoconut() — hak non‑temporary yang hilang atau tidak cukup gagal dengan cepat.
  • Plugin gaya override menurun secara elegan; format hanya plugin gagal dengan sebuah LicenseException.
  • Lisensi Temporary yang aktif membuka semua; produksi membuka apa yang Anda beli. Verifikasi dengan IDoconutLicenseService sebelum mengirim.

Apakah halaman ini membantu?