Как работает Viewer
Жизненный цикл запросов документа
Doconut рендерит документы как пагинированные изображения, обслуживаемые HTTP‑обработчиком, который регистрирует ваш Web.config. Понимание жизненного цикла — открытие, токен, запросы страниц, закрытие — объясняет почти всё поведение, которое вы наблюдаете, включая сообщения об ошибках.
Движущие части
Viewer— публичный сервис, который вы получаете изDoconutHost.Services. Он открывает документы и возвращает токены сеанса.- Сеанс документа — объект на стороне сервера, хранящий загруженный документ в памяти под его токеном.
DocImage.axd—Doconut.DocImageHandler, объявленный вWeb.config. Он отвечает на каждый запрос, который делает виджет браузера (страницы, миниатюры, поиск, аннотации, …), всегда идентифицируемый токеном./doconut-res/*—Doconut.DoconutResourceModule, который обслуживает собственные скрипты, стили и иконки виджета.
Viewer без состояния — по задумке
Viewer не хранит состояние документа per‑request и не реализует IDisposable. Сеансы живут независимо от него и очищаются по истечении срока или явным CloseDocument(token). В System.Web нет внедрения через конструктор, поэтому получайте его там, где нужен — обычно в действии контроллера:
// POST /ViewerApi/Open?fileName=Sample.pdf
[HttpPost]
public async Task<ActionResult> Open(string fileName)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
var path = Server.MapPath("~/files/" + Path.GetFileName(fileName));
var token = await viewer.OpenDocumentAsync(path);
return Content(token, "text/plain");
}Что происходит внутри OpenDocumentAsync
- Лицензионный шлюз. Отклонённая лицензия (поддельная, в чёрном списке или сборка вне окна обновления лицензии) сразу бросает
LicenseException, причину указывая в сообщении. Открытие никогда не ухудшается молча для недействительной лицензии; отсутствующая лицензия лишь добавляет водяной знак. - Создание сеанса. Фабрика просмотрщика выбирает просмотрщик формата по расширению файла и загружает документ (см. Rendering Pipeline). Сеанс хранится в памяти под новым случайным токеном со скользящим истечением через
DocOptions.TimeOutминут (по умолчанию 60). Каждый запрос страницы сбрасывает таймер. - Предоставление доступа. При использовании
UnsafeMode = false(по умолчанию) токен привязывается к ASP.NET‑сеансу запроса, который его открыл: в этот сеанс записывается записьsecure-{token}. Поэтому открытие должно выполняться в запросе с состоянием сеанса — см. Sessions & Security. - Токен возвращается. Это единственный идентификатор, который нужен браузеру для всего последующего.
Асинхронные перегрузки принимают путь к файлу, путь к файлу плюс конфигурацию для конкретного формата (PdfConfig, WordConfig, …) или Stream плюс FileInfo, расширение которого определяет формат. Для кода‑behind Web Forms, который не использует асинхронные страницы, OpenDocument предлагает те же три входа синхронно (путь, поток с именем файла или массив байтов с именем файла).
Как виджет получает страницы
Виджет вызывает DocImage.axd с токеном в строке запроса. Что делает обработчик, зависит от типа запроса:
| Запрос | Назначение |
|---|---|
?token=…&page=N | Сгенерированное изображение страницы (PNG) |
?token=…&page=N&thumb=1 | Миниатюра |
?token=…&zoom=… | Увеличенный рендер страницы |
?token=…&search=term | Полнотекстовый поиск (по лицензии) |
?token=…&bookmarks | Структура документа и закладки |
?token=…© / &showlinks / &fileFormat | Копирование текста, гиперссылки и информация о формате |
?token=…&meta | Технические метаданные DICOM — недоступны в этом пакете (отвечает 404) |
?token=…&action=rotate/flip/close | Действия со страницами и явное закрытие (POST) |
?token=…&AnnSave=… / &AnnLoad | Сохранение и загрузка аннотаций |
Каждый запрос проверяется в первую очередь:
- Отсутствует токен →
404, либо баннер версии, когдаShowDoconutInfo = true. - Токен не выдан этому ASP.NET‑сеансу → изображение ошибки с надписью
You Are Not Authorized To View This Page.. - Неизвестный или просроченный токен → изображение ошибки с надписью
Document session not found. Please re-open document..
Изображения ошибок — обычные PNG, отправляемые со статусом 200, чтобы виджет мог отобразить их вместо страницы. Мониторинг, проверяющий только код статуса, будет считать их обслуженными страницами; реальная страница весит от десятков до сотен килобайт, а изображение ошибки — около 2 KB.
Закрытие документа
viewer.CloseDocument(token);CloseDocument удаляет сеанс (сразу освобождая движок документа и его память), удаляет запись secure-{token} из текущего ASP.NET‑сеанса запроса и аннулирует токен. Это необязательно — скользящее истечение делает то же самое — но для больших документов память освобождается сразу после завершения работы пользователя. Из браузера objViewer.Close(true) отправляет эквивалентный запрос закрытия к DocImage.axd.
Ключевые выводы
- Одно открытое документ = один сеанс = один токен, выданный ASP.NET‑сеансу, который его открыл.
- Токен истекает по скользящему окну; просмотрщик, оставшийся бездействующим дольше
DocOptions.TimeOut, требует повторного открытия. Viewerможно получить и свободно использовать; сеансы несут всё состояние.
Была ли эта страница полезной?