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:

csharp
// Global.asax.cs, Application_Start — один раз на процес робітника. Другий виклик — нічого не робить:
// опції першого виклику переважають.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // Необов’язково. Виконується після реєстрацій Doconut's і перед створенням контейнера,
        // тому може додати сервіси або замінити один, зареєстрований Doconut.
        services.AddMemoryCache();
    });
  • configure отримує DoconutOptions: ліцензію, перемикачі безпеки, плагіни, віджети.
  • configureServices є необов'язковим. Він виконується після того, як Doconut зареєстрував свої сервіси і перед створенням контейнера, тому може додати сервіси — AddDoconutDistributed для веб‑ферми є звичним — або замінити реєстрацію, яку зробив Doconut.

Перший виклик переможе. Initialize є ідемпотентним: другий виклик повертає одразу, і жоден з його делегатів не виконується. Це робить дубльований Application_Start безпечним, але також означає, що конфігурацію не можна змінити, викликавши Initialize ще раз — замість цього перезапустіть пул додатків.

Виняток, який викидається тут — плагін без ліцензії, недійсні параметри, неповна конфігурація ферми — виникає всередині Application_Start. ASP.NET тоді відповідає на кожен запит порожнім 500, а виняток записується лише в журнал подій Windows (журнал Application, джерело ASP.NET).

Сервіси та IsInitialized

System.Web не підтримує ін’єкцію через конструктор для контролерів, сторінок або обробників, тому отримуйте сервіси Doconut там, де їх використовуєте:

csharp
// 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.

Завершення роботи

csharp
// Global.asax.cs, Application_End — зупиняє фонову роботу та звільняє контейнер.
// Безпечно викликати двічі, і безпечно, коли Initialize ніколи не запускалось.
Doconut.DoconutHost.Shutdown();

Shutdown зупиняє фонову роботу Doconut (використовується в розподіленому режимі) і звільняє контейнер. Безпечно викликати двічі, і безпечно, коли Initialize ніколи не запускалось — наприклад, коли пул додатків перезапускається до першого запиту.

Перевірка здоров'я

Doconut реєструє перевірку здоров'я з назвою "doconut", яка повідомляє стан ліцензії. Класичний ASP.NET не має власної точки доступу для перевірки здоров'я, тому відкрийте її через контролер:

csharp
// 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(...) у Application_Start
app.UseDoconut()Doconut.DocImageHandler на DocImage.axd у Web.config
app.UseDoconutResources()Doconut.DoconutResourceModule у Web.config
Ін’єкція через конструкторDoconutHost.Services.GetRequiredService<T>()
Завершення роботи хостаDoconutHost.Shutdown() у Application_End

Чи була ця сторінка корисною?