Система Плагінів
Розширте переглядач за допомогою плагінів
Ядро Doconut залишається легким; додаткова функціональність постачається у вигляді plugins — окремих пакетів NuGet, які додають переглядачі або сервіси і активуються вашою ліцензією. Ця сторінка пояснює модель реєстрації, як працює обмеження ліцензії під час виконання, і як підключити власний переглядач.
Реєстрація плагіна
Кожен пакет плагіна надає один клас плагіна. Ви реєструєте його один раз під час запуску:
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() створює екземпляр плагіна і викликає його Register зворотний виклик у реєстрі плагінів, що зберігається на DoconutOptions. Все, що додає плагін, позначається необхідна можливість плагіна. AddDoconut() негайно перевіряє зареєстровані плагіни: відсутня ліцензія, застарілий файл TRIAL або платна ліцензія без цієї можливості призводять до помилки запуску з InvalidOperationException. Тимчасова/Демо реєстрація зберігається після закінчення терміну, але її можливості під час виконання відкликаються після дати закінчення.
Контракт
Плагін реалізує навмисно невеликий інтерфейс:
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 немає вбудованого переглядача): без можливості виклик відкриття завершується з помилкою:
LicenseException: This document type requires the 'Dicom' plugin license.Активна тимчасова ліцензія надає всі можливості (з чистим, без водяних знаків базовим переглядом). Це класичне джерело несподіванок під час запуску: реєстрація тих самих плагінів з придбаною ліцензією, яка пропускає одну з їх можливостей, змушує AddDoconut() зазнати невдачі під час запуску. Порівняйте IsCapabilityGranted(...) з вашим планом перед розгортанням. З іншого боку: при відсутності будь-якої ліцензії нічого не надається — відсутня ліцензія не є тимчасовою ліцензією.
Те саме обмеження проявляється на клієнті: Viewer.ReferenceScripts() і ReferenceCss() генерують пакети скриптів/стилів для функцій, обмежених ліцензією (пошук, анотація, …) лише коли ліцензія їх увімкне, тому інтерфейс віджету залишається узгодженим з тим, що сервер фактично робитиме.
Карта функцій та плагінів
Інтерфейс продукту використовує «плагін» як широку мітку функції, але реєстрація на сервері відрізняється:
| Функція | Як увімкнено | Можливість | Вносить |
|---|---|---|---|
| Анотація | Вбудовано в переглядач; включає ресурси анотації | Annotation | Створення в браузері, збереження сеансу та експорт з вбудованою анотацією |
| Пошук | Вбудовано в переглядачі форматів з підтримкою пошуку; включає ресурси пошуку та дозволяє витяг, коли потрібно | Search | Вбудований текстовий індекс, підсвічування та навігація результатами |
| Конвертер | Встановіть Doconut.NET6.Converter і зареєструйте ConverterPlugin | Converter | Сервіс конвертації C# та необов'язковий веб‑віджет |
| DICOM | Встановіть Doconut.NET6.Dicom і зареєструйте DicomPlugin | Dicom | Перегляд медичних зображень для .dcm та .ima |
| Підписувач | Встановіть Doconut.NET6.Signer і зареєструйте SignerPlugin | Signer | Видимі підписи та цифрові печатки для PDF та Word: сервіс підпису C# та необов'язковий веб‑віджет |
Анотація та звичайний Пошук не використовують AddPlugin<TPlugin>(); їхні пакети генеруються лише коли ліцензія надає відповідну можливість. Конвертер, DICOM та Підписувач — це реалізації IDoconutPlugin за запитом.
Випущені пакети плагінів
| Плагін | Пакет | Можливість | Вносить |
|---|---|---|---|
| Конвертер | Doconut.NET6.Converter | Converter | Можливість конвертації документів |
| DICOM | Doconut.NET6.Dicom | Dicom | Перегляд медичних зображень (.dcm та .ima — формати лише для плагіна) |
| Підписувач | Doconut.NET6.Signer | Signer | Підпис PDF та Word |
Кожен має окрему сторінку в розділі Plugins з його налаштуваннями та використанням.
Користувацькі переглядачі — ваш власний обробник форматів
Ви можете підключити переглядач до конвеєра без написання пакету плагіна, безпосередньо з Program.cs:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implements 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перед випуском.
Чи була ця сторінка корисною?