レンダリング パイプライン

ドキュメントからページ画像へ

Between OpenDocumentAsync とブラウザに届く PNG の間には、2つの明確な段階があります:viewer resolution(どのエンジンがドキュメントを読み込むか、オープンごとに一度決定)と page processing(各リクエストで各ページ画像に何が起こるか)。両方を理解すれば、フォーマットがそのようにレンダリングされる理由と、DefaultRender が実際に切り替えるものが分かります。

ステージ 1 — フォーマットビューアの解決

ファクトリーは、フォーマットカタログを通じてファイル拡張子をビューアにマッピングし、3つの優先順位レベルで決定します:

  1. カスタムビューアが最優先。 DoconutOptions.RegisterViewer(extension, factory, defaultConfig?) で登録したものは、すべての組み込みビューアより優先されます。
  2. 組み込みファミリービューア。 カタログは、表示可能な各拡張子をビューアファミリー(Word、Excel、PowerPoint、Pdf、Cad、Dgn、Image、Tiff、Psd、Email、Visio、Project、Xps、Epub、Txt、Html、Mht、Dcn)にマッピングし、各ファミリーは独自のエンジンアダプタを持ちます。 同じ拡張子に対してライセンス済みプラグインがビューアを提供した場合、プラグインビューアが組み込みビューアを置き換えます。 AddDoconut() は起動時に登録されたプラグインの権利を検証し、ファクトリーが組み込みビューアにフォールバックするのは防御的なランタイムルールです。
  3. プラグイン専用フォーマット。 一部の拡張子には組み込みビューアがまったくありません — DICOM(.dcm)は DICOM プラグインを通じてのみ存在します。 必要な機能がない状態で開くと、次の例外がスローされます:
text
LicenseException: This document type requires the 'Dicom' plugin license.

ビューアが存在しない拡張子は次のエラーを発生させます:

text
FormatNotSupportedException: Document format '<extension>' is not supported.

解決後、設定は確定します:渡した場合は明示的な設定オブジェクト、そうでなければカタログからのフォーマットのデフォルト設定です。DocOptions.Password は保護されたドキュメント用に設定にコピーされます。

ステージ 1b — リダイレクトモード (DefaultRender = false)

ほとんどのフォーマット別設定は DefaultRender フラグを公開しています。これにより、根本的に異なる2つのパスのどちらかが選択されます:

  • DefaultRender = true — ドキュメントはネイティブにレンダリングされ、直接ページ画像になります。
  • DefaultRender = false — ドキュメントはまず メモリ内で PDF に変換 され、ソースエンジンは解放され、PDF ビューアが引き継ぎます。生成された PDF は実際のテキストを埋め込むため、全文検索はピクセル単位で正確なハイライトが可能です。変換がユーザーに見えないため、パイプラインはリダイレクトされた PDF に対して AllowSearch と AllowCopy を有効にします。

XPS とカタログのデフォルトである MHT はリダイレクトパスを使用します。PDF 投影は HTML や Microsoft Project などのフォーマットに対してネイティブ検索を提供できます。生成された PDF にテキストレイヤーのない画像が含まれる場合、標準ビューアはそれらのピクセルを検索できません。

ドキュメントを開く際に事前変換が必要になる代償はありますが、テキストを含む PDF 投影が必要な場合はリダイレクトモードを使用してください。

ステージ 2 — ページ画像パイプライン

レンダリングされたページは、リクエストごとに固定されたシーケンスで処理されます:

text
raw page PNG → watermark → rotate/flip → scale → annotation burn → PNG to the response
  • Watermark — ライセンス状態(ライセンス未取得、期限切れの一時またはサブスクリプション、無効なドメイン、バージョン不一致)と DocOptions.Watermark からのカスタムテキストに基づいて適用されます。適切にライセンスされたアプリ(または有効な一時ライセンス)でカスタム透かしが設定されていない場合、このステップはスキップされます。
  • Rotate/flip — ユーザーがウィジェットで設定するページごとの状態(90°/180°/270°、水平/垂直フリップ)はセッションに保存され、以降のそのページのレンダリング時に適用されます。
  • Scale — サムネイルとズームレベルは、レンダリングされたページを要求されたターゲットサイズにスケーリングして生成されます;0 は元のサイズで提供することを意味します。
  • Annotation burn — 保存された注釈はビットマップ上に描画され、エクスポートやページ画像に表示されます。
  • Encoding — 結果はプールされたメモリストリームを使用して PNG にエンコードされ、直接 HTTP 応答に書き込まれます。

ミドルウェア内部のエラーは、HTTP エラーページではなく PNG エラー画像(白地に赤文字)として返されるため、ウィジェットはページ領域にそれらを表示できます。

ページキャッシュ

BaseConfig.CachePages(デフォルトは true)は、ドキュメントセッションの存続期間中、レンダリングされたページ画像をメモリに保持するため、ページを再訪問しても再レンダリングされません。BaseConfig.ImageResolution(25〜300 DPI、0 = フォーマットのデフォルト)は主な品質/メモリ調整です;各フォーマットのデフォルトはその設定ページに記載されています。

単一ノードと複数ノードでのレンダリング

上記はすべて、ドキュメントを開いたセッションに対してオンデマンドで単一ノードがレンダリングすることを説明しています。1つのノードが全アーティファクトセットをレンダリングして公開し、他のノードが共有ストレージからそれらのページを提供するデプロイメントは、別の読み取りパスを使用します — 詳細は 分散デプロイメント を参照してください。

Linux のフォント

ページはサーバーにインストールされたフォントで描画されます。Linux では、最初のドキュメントを開く前にフォント設定ライブラリをインストールしてください(RHEL と Fedora では fontconfig)。

bash
apt-get update && apt-get install -y libfontconfig1

これがないと、ドキュメントを開く際に The system library libfontconfig1 is missing. Install it (Debian/Ubuntu: apt-get install -y libfontconfig1) and see the Linux section of the Doconut documentation. が発生します。これは Doconut が必要とする唯一のシステムパッケージです;libgdiplus は不要です。

その依存関係により基本的なフォントセット(DejaVu)が導入されるため、ドキュメントはすぐにレンダリングできます。サーバーに存在しないフォント(典型的な Linux イメージでの Calibri、Arial、Times New Roman など)を要求するドキュメントは、代わりに最も近いインストール済みフォントが使用されるため、テキストの幅や改行が Windows と異なる場合があります。Windows に近い出力を得るには、メトリック互換の代替フォント fonts-liberation、fonts-crosextra-carlito、fonts-crosextra-caladea をインストールしてください;他のスクリプト用に fonts-noto-core または fonts-noto-cjk を追加するか、独自の .ttf/.otf ファイルを /usr/share/fonts/ にコピーして fc-cache -f を実行します。

Alpine およびその他の musl ベースのディストリビューションはサポートされていません。

何をどこで調整するか

目的調整項目
ページをより鮮明にImageResolution on the format config
HTML/EPUB/メール/MHT/MPP の正確なテキスト検索DefaultRender = false on the format config
大容量ドキュメントでのメモリ削減CachePages = false, close sessions explicitly
各ページへの独自スタンプDocOptions.Watermark

このページは役に立ちましたか?