Система Плагінів

Розширте переглядач за допомогою плагінів

Ядро Doconut залишається легким; додаткова функціональність постачається у вигляді плагінів — окремих пакетів NuGet, які додають переглядачі або сервіси і активуються вашою ліцензією. Ця сторінка пояснює модель реєстрації, як працює обмеження ліцензії під час виконання, і як підключити власний переглядач.

Ця модель нова у цьому випуску. Попередня бібліотека .NET Standard не мала реєстру плагінів: конверсія була вбудована безпосередньо у переглядач, а ліцензії на плагіни встановлювалися через статичні виклики Viewer.SetLicensePlugin(...). Жоден з цих підходів не є механізмом реєстрації тут.

Реєстрація плагіна

Кожен пакет плагіна надає один клас плагіна. Ви реєструєте його один раз під час запуску:

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

AddPlugin<TPlugin>() створює екземпляр плагіна та викликає його Register зворотний виклик у реєстрі плагінів, який зберігається на DoconutOptions. Все, що додає плагін, позначається необхідною можливістю плагіна. AddDoconut() негайно перевіряє зареєстровані плагіни: відсутня ліцензія, застарілий файл TRIAL або платна ліцензія без можливості призводять до помилки запуску з InvalidOperationException. Реєстрація Temporary/Demo зберігається після закінчення терміну, але її можливості під час виконання відкликаються після дати закінчення.

Контракт

Плагін реалізує навмисно невеликий інтерфейс:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // наприклад "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // ліцензійний шлюз
    void Register(IDoconutPluginBuilder builder); // внести переглядачі/служби
}

Всередині Register, будівник приймає два типи внесків:

  • builder.RegisterViewer(extension, factory) — переглядач для розширення файлу; фабрика повертає IFormatViewer (плагін DICOM реєструє .dcm та .ima таким чином),
  • builder.RegisterService<TContract>(() => …) — типізований сервіс, який інші частини конвеєра можуть знайти.

Можливості та обмеження

Можливості — це одиниці ліцензії. Converter, Dicom та Signer постачаються як опціональні плагіни; Search і Annotation є вбудованими функціями, обмеженими таким же способом. Базовий переглядач не є можливістю — це передумова, представлена як IsViewerLicensed у сервісі ліцензій.

Перевірка під час запуску зазвичай запобігає входженню неліцензованого плагіна у конвеєр запитів. Фабрика переглядачів також застосовує два захисних правила під час виконання, які важливі, якщо права змінюються після запуску:

  • Плагін замінює вбудований переглядач (плагін заявляє розширення, яке також обробляє вбудований реєстр): при наявності ліцензованої можливості переглядач плагіна переважає; без неї Doconut тихо повертається до вбудованого переглядача. Користувачі все ще бачать свій документ — просто не отримують функцію плагіна.
  • Формат лише для плагіна (.dcm та .ima — у DICOM немає вбудованого переглядача): без можливості виклик відкриття завершується з помилкою:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Активна тимчасова ліцензія надає всі можливості (з чистим, без водяних знаків базовим переглядом). Це класичне джерело несподіванок під час запуску: реєстрація тих самих плагінів з придбаною ліцензією, яка пропускає одну з їх можливостей, призводить до помилки AddDoconut() під час запуску. Порівняйте IsCapabilityGranted(...) зі своїм планом перед розгортанням. З іншого боку: з повністю відсутньою ліцензією нічого не надається — відсутня ліцензія не є тимчасовою ліцензією.

Те ж обмеження проявляється на боці клієнта: Viewer.ReferenceScripts() і ReferenceCss() генерують пакети скриптів/стилів для функцій, обмежених ліцензією (пошук, анотація, …) лише коли ліцензія їх увімкне, тому інтерфейс віджету залишається узгодженим з тим, що сервер фактично виконує.

Карта функцій та плагінів

Інтерфейс продукту використовує «плагін» як широку мітку функції, проте реєстрація на сервері відрізняється:

ФункціяЯк увімкненоМожливістьВносить
АнотаціяВбудовано у переглядач; включає ресурси анотаціїAnnotationСтворення в браузері, збереження сеансів та вбудовані експорти
ПошукВбудовано у переглядачі форматів з можливістю пошуку; включає ресурси пошуку та дозволяє витяг, коли це потрібноSearchВбудований текстовий індекс, підсвічування та навігація результатами
КонвертерВстановіть Doconut.NETStandard.Converter та зареєструйте ConverterPluginConverterC# сервіс конверсії та опціональний веб‑віджет
DICOMВстановіть Doconut.NETStandard.Dicom та зареєструйте DicomPluginDicomПерегляд медичних зображень для .dcm та .ima
ПідписувачВстановіть Doconut.NETStandard.Signer та зареєструйте SignerPluginSignerВидимі підписи та цифрові печатки для PDF та Word: C# сервіс підпису та опціональний веб‑віджет

Анотація та звичайний пошук не використовують AddPlugin<TPlugin>(); їхні пакети генеруються лише коли ліцензія надає відповідну можливість. Конвертер, DICOM та Підписувач є опціональними реалізаціями IDoconutPlugin.

Випущені пакети плагінів

ПлагінПакетМожливістьВносить
КонвертерDoconut.NETStandard.ConverterConverterМожливість конвертації документів
DICOMDoconut.NETStandard.DicomDicomПерегляд медичних зображень (.dcm та .ima — формати лише для плагіна)
ПідписувачDoconut.NETStandard.SignerSignerПідпис PDF та Word

Кожен має окрему сторінку в розділі Plugins з його налаштуваннями та використанням.

Користувацькі переглядачі — ваш власний обробник формату

Ви можете підключити переглядач до конвеєра без написання пакету плагіна, безпосередньо з Program.cs:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // реалізує IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // необов’язкова типова конфігурація
});

// Обробник формату, який створює фабрика. Замініть ці члени власною візуалізацією.
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() { }
}

Користувацькі переглядачі мають пріоритет над усім — як над вбудованими, так і над плагінами — і не підлягають обмеженню ліцензії (це ваш код). Фабрика повертається до ImageConfig, якщо ви не надаєте конфігурацію за замовчуванням.

Висновки

  • Плагіни реєструються явно, і їх LicenseCapability перевіряється під час AddDoconut() — відсутність або недостатність прав, не тимчасових, призводить до швидкої помилки.
  • Плагіни типу Override деградують плавно; формати лише для плагіна завершуються помилкою LicenseException.
  • Активна тимчасова ліцензія розблоковує все; продакшн розблоковує те, що ви придбали. Перевірте за допомогою IDoconutLicenseService перед випуском.

Чи була ця сторінка корисною?