DoconutOptions

Настройка сервисов Doconut

DoconutOptions (namespace Doconut) — единственный объект конфигурации для всего SDK. Вы настраиваете его один раз, внутри AddDoconut(), и он регистрируется как singleton.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Свойства

ТипСвойствоПо умолчаниюОписание
boolShowDoconutInfofalseКогда true, запрос middleware без токена возвращает баннер версии (Doconut <version> is running on <host>) вместо 404. Полезно для быстрой проверки; оставьте false в продакшене.
boolUnsafeModefalseКогда true, пропускает проверку безопасности ASP.NET‑session при запросах страниц. Оставьте false в продакшене (см. Основные концепции → Сессии и безопасность).
stringMiddlewarePath"/doconut"Координационное значение для конечной точки page-image. Оно проверяется, но не монтирует ветку конвейера; держите его согласованным с реальным отображением UseDoconut() и клиентским BasePath.
stringResourcesPath"/doconut-res"Префикс URL‑пути для встроенных ресурсов JS/CSS/image/font.
stringLicensePath""Путь к файлу лицензии. Пусто → следующий источник лицензии, затем автообнаружение; если ничего не найдено → состояние оценки с водяным знаком без возможностей.
stringLicenseContent""Необработанное XML‑содержимое лицензии (база данных, переменная окружения, менеджер секретов). Имеет приоритет над LicensePath.
Stream?LicenseStreamnullЛицензия как поток, читается один раз при запуске. Имеет приоритет над обоими другими источниками.
boolResetLicensefalseЗарезервированный флаг совместимости. Текущая реализация .NET 8 его не использует; перезапустите приложение после замены лицензии.
DoconutPluginRegistryPluginRegistry—Регистр только для чтения, собирающий вклады плагинов; используется фабрикой просмотрщиков. Заполняется через AddPlugin<T>().

Приоритет лицензий (применяется при регистрации сервисов): LicenseStream → LicenseContent → LicensePath → автоматическое обнаружение (см. Начало работы → Настройка лицензий).

Методы

AddPlugin<TPlugin>()

text
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 (Плагины → Converter Plugin). Виджет Signer с включённой лицензией активируется аналогично, с помощью AddSignerWidget(), и доступен через только‑для‑чтения свойство SignerWidget; см. Плагин Signer.

RegisterViewer(extension, factory, defaultConfig?)

text
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‑ов во время запроса:

text
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.

Общие конфигурации

csharp
// Production: явная лицензия, всё заблокировано (все настройки безопасности по умолчанию)
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').

Была ли эта страница полезной?