DoconutOptions
Настройка сервисов Doconut
DoconutOptions (namespace Doconut) — единственный объект конфигурации для всего SDK. Вы настраиваете его один раз, внутри AddDoconut(), и он регистрируется как singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Свойства
| Тип | Свойство | По умолчанию | Описание |
|---|---|---|---|
bool | ShowDoconutInfo | false | Когда true, запрос middleware без токена возвращает баннер версии (Doconut <version> is running on <host>) вместо 404. Полезно как проверка работоспособности; оставьте false в продакшн. |
bool | UnsafeMode | false | Когда true, пропускает проверку безопасности ASP.NET‑session при запросах страниц. Оставьте false в продакшн (см. Основные концепции → Сессии и безопасность). |
string | MiddlewarePath | "/doconut" | Координационное значение для конечной точки page-image. Оно проверяется, но не монтирует ветку конвейера; держите его согласованным с фактическим сопоставлением UseDoconut() и клиентским BasePath. |
string | ResourcesPath | "/doconut-res" | Префикс URL‑пути для встроенных ресурсов JS/CSS/image/font. |
string | LicensePath | "" | Путь к файлу лицензии. Пусто → следующий источник лицензии, затем автообнаружение; если ничего не найдено → состояние оценки с водяным знаком без возможностей. |
string | LicenseContent | "" | Необработанное XML‑содержимое лицензии (база данных, переменная окружения, менеджер секретов). Имеет приоритет над LicensePath. |
Stream? | LicenseStream | null | Лицензия как поток, читается один раз при запуске. Имеет приоритет над обоими другими источниками. |
bool | ResetLicense | false | Зарезервированный флаг совместимости. Текущая реализация .NET 6 его не использует; перезапустите приложение после замены лицензии. |
DoconutPluginRegistry | PluginRegistry | — | Регистр только для чтения, собирающий вклады плагинов; используется фабрикой просмотрщиков. Заполняется через AddPlugin<T>(). |
Приоритет лицензий (применяется при регистрации сервисов): LicenseStream → LicenseContent → LicensePath → автоматическое обнаружение (см. Начало работы → Настройка лицензии).
Методы
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Используйте этот метод для выпущенных пакетов Converter, DICOM и Signer с опциональной лицензией. Аннотации и обычный поиск — встроенные лицензированные функции и не используют AddPlugin<TPlugin>().
Регистрирует плагин первого уровня (Converter, DICOM, Signer). Fluent — возвращает экземпляр options. AddDoconut() бросает InvalidOperationException при отсутствии лицензии, устаревшем файле TRIAL или платной лицензии, не предоставляющей возможности плагина. Временные/демо‑регистрации сохраняются после истечения срока и подпадают под runtime‑gate (см. Основные концепции → Система плагинов).
Виджет Converter с опциональной лицензией включается с помощью AddConverterWidget() и доступен через только‑для‑чтения свойство ConverterWidget; его параметры задокументированы на странице плагина Converter (Плагины → Плагин Конвертер). Виджет Signer с опциональной лицензией включается аналогично, с помощью AddSignerWidget(), и доступен через только‑для‑чтения свойство SignerWidget; см. Плагин Signer.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — начальная точка опциональна
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Регистрирует пользовательский просмотрщик для расширения файла. Пользовательские просмотрщики имеют приоритет над встроенными и просмотрщиками плагинов и не зависят от лицензии. Когда defaultConfig опущен и документ открывается без явной конфигурации, используется ImageConfig.
Бросает ArgumentException (Extension must be a non-empty file extension.) при пустом расширении и ArgumentNullException при null‑фабрике.
Проверка при запуске
AddDoconut() проверяет параметры fail-fast, поэтому ошибка конфигурации проявляется в виде явного исключения при запуске, а не в виде запутанных 404‑ов во время запросов:
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.Общие конфигурации
// Продакшн: явная лицензия, всё заблокировано (все настройки безопасности по умолчанию)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Пользовательские пути (например, чтобы избежать конфликта маршрута)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Когда вы меняете ResourcesPath, синхронно обновляйте ResPath клиентского виджета (см. ViewerConfig).
MiddlewarePath не является автоматическим маппером маршрутов ASP.NET Core. Если Doconut должен отвечать только под пользовательским префиксом, смонтируйте UseDoconut() на этой ветке (например с помощью app.Map("/docs-engine", branch => branch.UseDoconut())) и задайте клиенту BasePath этот префикс без ведущего / ('docs-engine').
Была ли эта страница полезной?