DoconutHost
Корневой элемент композиции для System.Web
DoconutHost (namespace Doconut) — это статический класс, который владеет сервисами Doconut для всего процесса рабочего потока. Приложения ASP.NET Core собирают эти сервисы в собственный контейнер фреймворка; классический ASP.NET не имеет контейнера, поэтому DoconutHost создает его и хранит. Обработчик DocImage.axd и модуль ресурсов получают всё необходимое из него, как и ваш код.
| Элемент | Назначение |
|---|---|
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null) | Создаёт сервисы — один раз |
static IServiceProvider Services { get; } | Сформированный контейнер |
static bool IsInitialized { get; } | true один раз после запуска Initialize |
static void Shutdown() | Останавливает фоновые задачи и освобождает контейнер |
Инициализация
Вызовите её из Application_Start в Global.asax.cs:
// Global.asax.cs, Application_Start — один раз на процесс‑рабочий. Второй вызов — без действия:
// опции первого вызова выигрывают.
Doconut.DoconutHost.Initialize(
options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
},
services =>
{
// Необязательно. Выполняется после собственных регистраций Doconut и до построения контейнера,
// чтобы можно было добавить сервисы или заменить один, зарегистрированный Doconut.
services.AddMemoryCache();
});configureполучает DoconutOptions: лицензия, переключатели безопасности, плагины, виджеты.configureServicesявляется необязательным. Он выполняется после того, как Doconut зарегистрировал свои сервисы и до создания контейнера, поэтому может добавить сервисы — обычный вариант для веб‑фермы —AddDoconutDistributed, или заменить регистрацию, сделанную Doconut.
Первый вызов выигрывает. Initialize идемпотентен: второй вызов возвращается сразу, и ни один из его делегатов не выполняется. Это делает дублированный Application_Start безвредным, но также означает, что конфигурацию нельзя изменить, вызвав Initialize снова — вместо этого перезапустите пул приложений.
Исключение, выброшенное здесь — плагин без лицензии, недопустимые параметры, неполная конфигурация фермы — происходит внутри Application_Start. Затем ASP.NET отвечает на каждый запрос пустым 500, а исключение записывается только в журнал событий Windows (журнал Приложений, источник ASP.NET).
Сервисы и IsInitialized
System.Web не поддерживает внедрение через конструктор для контроллеров, страниц или обработчиков, поэтому получайте сервисы Doconut там, где вы их используете:
// System.Web не поддерживает внедрение через конструктор: разрешайте сервисы Doconut там, где вы их используете.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
// Регистрируется только когда включён плагин Converter (см. страницу плагина).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();Services бросает InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.), если читается до Initialize. Код, который может выполниться раньше — модуль, статический конструктор — может сначала проверить IsInitialized.
Что обычно разрешает ваш код:
| Сервис | Время жизни | Роль |
|---|---|---|
Viewer | Временный | Открытие, закрытие, аннотации, вспомогательные ресурсы — см. Viewer |
DocumentConverter | Временный | Конверсия — всегда зарегистрирована; попытка разрешить её без плагина Converter бросает InvalidOperationException, указывающий, какой плагин добавить |
DocumentSigner | Временный | Подпись — требует плагин Signer (см. Signer Plugin) |
IDoconutLicenseService | Одиночный | Загруженная лицензия и её возможности — см. Licensing |
DoconutOptions | Одиночный | Параметры, переданные в Initialize |
HealthCheckService | Одиночный | Выполняет проверку состояния "doconut" (см. ниже) |
Разрешайте из DoconutHost.Services, никогда не из собственного контейнера. Регистрация Doconut в другом контейнере создаёт второй, отдельный набор сервисов, которые обработчик и модуль никогда не видят: документы, открытые через него, неизвестны DocImage.axd.
Остановка
// Global.asax.cs, Application_End — останавливает фоновые задачи и освобождает контейнер.
// Безопасно вызывать дважды и безопасно, если Initialize никогда не запускался.
Doconut.DoconutHost.Shutdown();Shutdown останавливает фоновые задачи Doconut (используемые в распределённом режиме) и освобождает контейнер. Безопасно вызывать дважды, и безопасно, если Initialize никогда не запускался — например, когда пул приложений перезапускается до первого запроса.
Проверка состояния
Doconut регистрирует проверку состояния с именем "doconut", которая сообщает о состоянии лицензии. Классический ASP.NET не имеет собственного конечного пункта проверки состояния, поэтому откройте её через контроллер:
// GET /Health — Doconut регистрирует проверку состояния "doconut", которая сообщает о состоянии лицензии:
// Здоров (действительно), Ухудшено (пробная версия или отсутствие файла лицензии), Нездоров (отклонено или истекло).
public async Task<ActionResult> Index()
{
var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
HealthReport report = await health.CheckHealthAsync();
Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
return Content(report.Status.ToString(), "text/plain");
}| Статус | Значение |
|---|---|
Healthy | Загружена действительная лицензия |
Degraded | Пробная версия или файл лицензии не найден |
Unhealthy | Лицензия была отклонена (например, изменённый файл) или истекла |
Методы расширения ASP.NET Core
Пакет также содержит UseDoconut() и UseDoconutResources(), расширения конвейера ASP.NET Core, поскольку он делит код с пакетами ASP.NET Core. В этом пакете оба помечены [Obsolete] и не используются: приложение System.Web не имеет конвейера запросов, к которому их можно добавить. Их заменой являются две регистрации Web.config из Installation:
| ASP.NET Core | .NET Framework 4.7.2 |
|---|---|
builder.Services.AddDoconut(...) | DoconutHost.Initialize(...) in Application_Start |
app.UseDoconut() | Doconut.DocImageHandler on DocImage.axd in Web.config |
app.UseDoconutResources() | Doconut.DoconutResourceModule in Web.config |
| Внедрение через конструктор | DoconutHost.Services.GetRequiredService<T>() |
| Остановка хоста | DoconutHost.Shutdown() in Application_End |
Была ли эта страница полезной?