DoconutExtensions

Реєстрація сервісів та middleware

DoconutExtensions (namespace Doconut.Middleware) — це статичний клас з трьома викликами, які виконує кожний хост Doconut: одна реєстрація сервісу та дві реєстрації middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // викликайте UseSession() перед UseDoconut()
app.UseDoconutResources(); // має бути зареєстровано перед UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() відповідає на кожен запит, що до нього надходить, тому підключіть його у власній гілці разом з app.Map.

AddDoconut

text
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)

Створює DoconutOptions, швидко перевіряє їх (див. DoconutOptions → перевірка під час запуску) і реєструє повний граф сервісів:

СервісТривалістьРоль
DoconutOptionsSingletonОб’єкт конфігурації
Сервіс кешу сесіїSingletonТокен → кеш сесії (IMemoryCache також зареєстровано)
IDoconutLicenseServiceSingletonЛіцензія завантажується один раз під час запуску (пріоритет: LicenseStream → LicenseContent → LicensePath → автоматичний пошук)
Конвеєр обробки зображень сторінокSingletonВиконує обробку зображень сторінок (водяний знак, обертання, масштабування, анотації)
Безпека документу (сховище доступу)SingletonНадає дозволи для прив’язки токен‑до‑сесії
ViewerTransientПублічний фасад відкриття/закриття
DocumentConverterTransientФасад конвертації — потребує плагін Converter
DocumentSignerTransientФасад підпису — потребує плагін Signer (див. Плагін підпису)
DistributedDocumentPublisherTransientПублікує артефакти документу у спільне сховище (див. Розподілені розгортання)
Перевірка стану "doconut"—Повідомляє стан ліцензії/закінчення терміну через health checks ASP.NET

Дві важливі поведінки:

  • Converter потребує свій плагін. Спроба отримати DocumentConverter без options.AddPlugin<ConverterPlugin>() викликає виключення:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner дотримується того ж правила: без options.AddPlugin<SignerPlugin>() він викликає No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Права плагіна перевіряються під час запуску. Відсутня ліцензія, застарілий файл TRIAL або платна ліцензія без зареєстрованих можливостей плагіна призводять до помилки під час AddDoconut(). Тимчасові/демо‑реєстрації залишаються активними після закінчення терміну, тоді як під час виконання ворота відкликають прострочені можливості.

Перевірка стану інтегрується зі стандартним механізмом ASP.NET Core — додайте її, якщо хочете бачити стан ліцензії у вашій health‑точці:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Додає middleware Doconut для обробки зображень сторінок. Він обслуговує кожен запит з параметром запиту ?token= — сторінки, мініатюри, пошук, анотації, дії над сторінками (повна таблиця запитів знаходиться у Основні концепції → Як працює переглядач) — і відповідає на будь‑який інший запит самостійно за допомогою 404 (або банера ShowDoconutInfo): він ніколи не передає запит далі по конвеєру. Підключіть його у власній гілці, як у прикладах на цій сторінці. Коли UnsafeMode є false, шар безпеки документу автоматично підключається перед ним.

Звичний альтернативний варіант зберігає історичну форму запиту DocImage.axd за допомогою гілки MapWhen (клієнт тоді використовує BasePath: '/'):

csharp
app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconutResources

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

Обслуговує вбудовані JS, CSS, зображення та шрифти за адресою DoconutOptions.ResourcesPath (за замовчуванням /doconut-res). Це файли, для яких Viewer.ReferenceCss() / ReferenceScripts() генерують теги.

Завжди викликайте його перед UseDoconut(). Якщо область переглядача порожня, а консоль браузера показує 404 для /doconut-res/..., цей виклик відсутній або розташований неправильно.

Обслуговування зі спільного сховища

Існує ще два реєстрації для розгортань, де вузол, що рендерить документ, не обов’язково є вузлом, що обслуговує його сторінки. Обидва випадки повністю описані у Розподілені розгортання; сигнатури такі:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // включена фонова черга публікації
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // спільне сховище підтримки для widget uploads

Сторона читання — це окремий middleware з збірки Doconut.Clouds, яка постачається в тому ж пакеті:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

Підсумок порядку

csharp
app.UseRouting();
app.UseSession();          // викликайте UseSession() перед UseDoconut()
app.UseDoconutResources(); // має бути зареєстровано перед UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // або гілка MapWhen

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