Міграція

Оновлення Doconut до .NET 8

На цій сторінці розглядаються два типи міграції: оновлення версії пакету у .NET 8 та перенесення інтеграції зі старішого фреймворку Doconut (.NET 6, .NET Standard 2.0, .NET Framework 4.7) на API .NET 8.

Оновлення версії пакету

  1. Оновіть пакет (і всі пакети плагінів — зберігайте узгоджені версії):
bash
dotnet add package Doconut.NET8
dotnet add package Doconut.NET8.Dicom
  1. Перевірте вікно ліцензії. Ліцензія охоплює діапазон версій. Якщо нова версія виходить за його межі, відкриття блокуєтьсяOpenDocumentAsync викидає LicenseException (швидке завершення); не переходить до водяного знака, і IsVersionValid повертає false. Оновіть, замініть файл .lic і перезапустіть застосунок, щоб AddDoconut() завантажив нову ліцензію.
  2. Перебудуйте та дозвольте NuGet відновити зазначені версії залежностей — не закріпляйте знову System.Text.Json або System.Drawing.Common (див. розділ Усунення проблем для точних помилок, які виникають при пониженні версії).
  3. Проведіть швидке тестування (smoke-test) одного документа для кожної сімейства форматів, які ви використовуєте.

Міграція з .NET 6 / .NET Standard 2.0

API .NET 8 — це перепроектування навколо DI та асинхронності. Відповідність:

Питання.NET 6 / Standard 2.0.NET 8
НалаштуванняСтворити Viewer(cache, httpContextAccessor, licensePath)builder.Services.AddDoconut(options => …) + inject Viewer
ЛіцензіяСтатичний Viewer.DoconutLicense(path) + SetLicensePlugin(...) для кожного плагінаoptions.LicensePath / LicenseContent / LicenseStream — одна ліцензія, автоматичне виявлення файлів плагінів
Відкритиviewer.OpenDocument(...) (синхронний)await viewer.OpenDocumentAsync(...)
Закритиviewer.CloseDocument() або viewer.Dispose()viewer.CloseDocument(token)Viewer не є IDisposable
ТривалістьViewer реалізує IDisposable, тримає відкритий документViewer без стану; сесії зберігаються в кеші під токенами
Конвертервластивість viewer.ConverterПлагін Converter (AddPlugin<ConverterPlugin>()) + сервіс DocumentConverter
Класи конфігураціїпростори імен Doconut.Configs.View.*Все в просторі імен Doconut
ПосередникРучне підключення обробниківapp.UseDoconutResources() + app.UseDoconut()

Типовий приклад до/після:

text
// .NET 6 (old API, shown for contrast — not valid on .NET 8)
using var viewer = new Viewer(cache, httpContextAccessor, "wwwroot/Doconut.Viewer.lic");
var token = viewer.OpenDocument(path, new PdfConfig { AllowSearch = true }, new DocOptions());
csharp
// .NET 8 — Viewer injected, license configured once in AddDoconut()
var token = await viewer.OpenDocumentAsync(path, new PdfConfig { AllowSearch = true });

Міграція з .NET Framework 4.7 (Web Forms)

Viewer у 4.7 є WebControl; .NET 8 замінює модель контролю на посередник + DI‑службу:

  • Елемент <doconut:DocViewer runat=server> зникає — сторінка розміщує пару div‑віджетів, а ваш кінцевий пункт повертає токен (швидкий старт показує шаблон).
  • Статичні методи ліцензії → джерела ліцензії DoconutOptions.
  • Синхронний OpenDocumentawait OpenDocumentAsync.
  • Viewer.ReferenceScripts() / ReferenceCss() існують в обох світах — версії .NET 8 приймають об’єкти ScriptConfig/CssConfig і підлягають ліцензійному контролю.
  • Властивості контролю (ShowThumbs, PageZoom, FixedZoom, …) → ті ж назви в ViewerConfig / параметрах JS docViewer.
  • Методи експорту, що повертають byte[] → асинхронні API експорту анотацій у Viewer.

Заплануйте це як переписування шару хостингу навколо незмінної концепції: відкриття → токен → віджет.

Примітка щодо іменування

У всіх фреймворках клас — Viewer — якщо ви знайдете DocumentViewer у старих фрагментах коду або сторонніх статтях, такого типу ніколи не існувало в SDK.

Контрольний список міграції

  1. Замініть пакети; узгодьте версії пакетів плагінів.
  2. Перенесіть налаштування ліцензії у AddDoconut(); видаліть статичні виклики ліцензії.
  3. Зробіть виклики відкриття асинхронними; замініть Dispose/CloseDocument без параметрів на CloseDocument(token).
  4. Замініть використання viewer.Converter на реєстрацію плагіна Converter + DocumentConverter.
  5. Повторно протестуйте шлях безпеки: AddSession()/UseSession() тепер обов’язкові за замовчуванням.

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