Система плагинов
Расширьте просмотрщик с помощью плагинов
Ядро Doconut остаётся лёгким; дополнительный функционал поставляется в виде плагинов — отдельных пакетов NuGet, которые предоставляют просмотрщики или сервисы и активируются вашей лицензией. На этой странице объясняется модель регистрации, как работает ограничение лицензии во время выполнения и как подключить свой собственный просмотрщик.
Регистрация плагина
Каждый пакет плагина предоставляет один класс плагина. Вы регистрируете его один раз, при запуске:
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 сохраняется после истечения срока, но её возможности во время выполнения отзываются после даты истечения.
Контракт
Плагин реализует преднамеренно небольшой интерфейс:
public interface IDoconutPlugin
{
string Name { get; } // e.g. "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // the license gate
void Register(IDoconutPluginBuilder builder); // contribute viewers/services
}Внутри Register билдер принимает два типа вкладов:
builder.RegisterViewer(".dcm", () => new DicomViewer())— просмотрщик для расширения файла,builder.RegisterService<TContract>(() => …)— типизированный сервис, который могут искать другие части конвейера.
Возможности и ограничения
Возможности — это единицы лицензии. Converter и Dicom поставляются как плагины по запросу; Search и Annotation являются встроенными функциями, ограниченными тем же способом. Базовый просмотрщик не является возможностью — он является предварительным условием, доступным как IsViewerLicensed в сервисе лицензий.
Проверка при запуске обычно не позволяет нелицензированному плагину попасть в конвейер запросов. Фабрика просмотрщика также применяет два защитных правила во время выполнения, которые важны, если права меняются после запуска:
- Плагин переопределяет встроенный просмотрщик (плагин заявляет расширение, которое также обрабатывается встроенным реестром): при наличии лицензии на возможность плагин‑просмотрщик выигрывает; без неё Doconut бесшумно возвращается к встроенному просмотрщику. Пользователи всё равно видят свой документ — просто они не получают функцию плагина.
- Формат только для плагина (например,
.dcm— у DICOM нет встроенного просмотрщика): без возможности вызов открытия завершается с ошибкой:
LicenseException: This document type requires the 'Dicom' plugin license.Активная временная (Temporary) лицензия предоставляет все возможности (с чистым, без водяных знаков базовым просмотром). Это классический источник неожиданностей при запуске: регистрация тех же плагинов с приобретённой лицензией, в которой отсутствует одна из их возможностей, приводит к сбою AddDoconut() во время старта. Сравните IsCapabilityGranted(...) с вашим планом перед развертыванием. Обратная сторона: при полном отсутствии лицензии ничего не предоставляется — отсутствие лицензии не является временной лицензией.
То же ограничение проявляется на клиенте: Viewer.ReferenceScripts() и ReferenceCss() генерируют пакеты скриптов/стилей для функций, ограниченных лицензией (поиск, аннотация, …) только когда лицензия их активирует, поэтому UI виджета остаётся согласованным с тем, что действительно делает сервер.
Карта функций и плагинов
В пользовательском интерфейсе продукта слово «плагин» используется как широкая метка функции, но регистрация на сервере отличается:
| Функция | Как включено | Возможность | Вклад |
|---|---|---|---|
| Annotation | Встроено в просмотрщик; включить ресурсы аннотации | Annotation | Создание в браузере, сохранение сессии и экспорт с встраиванием |
| Search | Встроено в просмотрщики форматов с поддержкой поиска; включить ресурсы поиска и разрешить извлечение при необходимости | Search | Нативный текстовый индекс, подсветка и навигация по результатам |
| Converter | Установить Doconut.NET8.Converter и зарегистрировать ConverterPlugin | Converter | Сервис конвертации на C# и необязательный веб‑виджет |
| DICOM | Установить Doconut.NET8.Dicom и зарегистрировать DicomPlugin | Dicom | Просмотр медицинских изображений (.dcm и .ima) |
Выпущенные пакеты плагинов
| Плагин | Пакет | Возможность | Вклад |
|---|---|---|---|
| Converter | Doconut.NET8.Converter | Converter | Возможность конвертации документов |
| DICOM | Doconut.NET8.Dicom | Dicom | Просмотр медицинских изображений (.dcm — формат только для плагина) |
У каждого есть отдельная страница в разделе Plugins с его конфигурацией и использованием.
Пользовательские просмотрщики — ваш собственный обработчик форматов
Вы можете подключить просмотрщик к конвейеру без создания пакета плагина, напрямую из Program.cs:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implements IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // optional default config
});Пользовательские просмотрщики имеют приоритет над всем — как над встроенными, так и над плагинами — и не ограничиваются лицензией (это ваш код). Фабрика возвращается к ImageConfig, если вы не предоставляете конфигурацию по умолчанию.
Ключевые выводы
- Плагины регистрируются явно, и их
LicenseCapabilityпроверяется во времяAddDoconut()— отсутствие или недостаточная не временная лицензия приводит к быстрому сбою. - Плагины в стиле переопределения деградируют плавно; форматы, поддерживаемые только плагинами, вызывают
LicenseException. - Активная временная (Temporary) лицензия открывает всё; в продакшене открывается то, что вы приобрели. Проверьте с помощью
IDoconutLicenseServiceперед выпуском.
Была ли эта страница полезной?