インストール

Doconut を .NET Standard 2.1 プロジェクトに追加する

.NET Standard 用の基本 Doconut ビューアは、任意の ASP.NET Core アプリケーションに組み込める 1 つの NuGet パッケージとして提供されます。オプションのプラグインは別々のパッケージを使用します。このページでは基本パッケージをインストールし、ホストがそれを利用できることを確認し、ミドルウェアを登録します — 最初のレンダーの前に必要な最小限です。

まずホストフレームワークを確認する

このライブラリは netstandard2.1 を対象としています。これは以前の netstandard2.0 ビルドよりも契約が狭く、最初に確認すべきことです:

ホストサポート
.NET Core 3.0 以降、.NET 5/6/7/8 を含むはい
.NET Framework(任意のバージョン)いいえ — netstandard2.1 は .NET Framework では使用できません

このパッケージは Windows のみ で動作します。Linux ホストの場合は Doconut.NET8 または Doconut.NET6 を使用してください。

.NET Framework 上でアプリケーションが実行される場合、これは適切なパッケージではありません。代わりに Doconut.NETFramework を使用してください;26.9.0 以降は .NET Framework 4.7.2 が必要です。

パッケージのインストール

bash
dotnet add package Doconut.NETStandard

バージョン指定なしのコマンドは最新の安定版リリースをインストールします。このドキュメントで説明しているリリースを固定するには、バージョンを別のオプションとして渡します:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard はパッケージ ID です。バージョンサフィックスはダウンロードされた Doconut.NETStandard.<version>.nupkg のファイル名に属し、ID の一部ではありません。

バージョン番号は世代を表す

ここではパッケージ名よりも重要です。.NET Standard ライブラリの両世代は同じパッケージ ID で公開されており、バージョンだけがそれらを区別します:

バージョンターゲットAPI
26.7.0 以下netstandard2.0以前の統合
26.8.0 以上netstandard2.1ここで文書化された統合

互換性シムもサイドバイサイドのパッケージもありません。バージョンを上げることがアップグレードであり、コンパイラは API の違いを即座に報告します。

パッケージ名だけでドキュメントを選択しないでください:

  • new Viewer(_cache, _accessor, …)、UnSafeMode、同期 OpenDocument(...)、viewer.InitCache()、UseDoconutWebFarm、および手動でコピーしたビューアスクリプトは、以前の統合 を識別します;
  • AddDoconut()、UseDoconutResources()、注入された Viewer、および OpenDocumentAsync(...) は、ここで文書化された現在の統合を識別します。

翻訳された以前のセットアップマニュアルは引き続き利用可能です。世代を変更するには移行ガイドを使用してください;パッケージの更新はスタートアップ、ビューアのライフタイム、またはブラウザリソースを自動的に変換しません。

Doconut の登録

AddDoconut() は唯一の登録エントリポイントです — オーバーロードは 1 つだけで、Viewer サービス、ライセンスサービス、レンダリングインフラストラクチャを DI コンテナに接続します。

2 つのミドルウェア呼び出しでセットアップが完了し、順序が重要です:UseDoconutResources() は UseDoconut() の前に実行する必要があります。 UseDoconut() はターミナルミドルウェアであるため、最初に呼び出すと /doconut-res アセットへのすべてのリクエストがリソースハンドラに到達せず 404 になります。UseDoconut() は到達したすべてのリクエストに応答するので、app.Map とともに独自のブランチにマウントしてください。セッションの配線も必要です — Doconut のデフォルトドキュメントセキュリティは、すべてのページリクエストを ASP.NET セッションステートに対して検証します。

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // セッションステートにはキャッシュが必要です (MVC/Razor Pages はすでに追加されています)
builder.Services.AddSession(); // Doconut ドキュメントのセキュリティは ASP.NET セッションステートに依存しています

app.UseSession();          // UseSession() を UseDoconut() の前に呼び出してください
app.UseDoconutResources(); // UseDoconut() の前に登録する必要があります
app.Map("/doconut", branch => branch.UseDoconut());

名前空間

設定タイプはもはや 4 つの名前空間に分散していません。このリリースでは、ほぼすべてがルート Doconut 名前空間に存在します:

csharp
using Doconut;                       // Viewer、DoconutOptions、DocOptions、すべてのフォーマット設定
using Doconut.Middleware;            // AddDoconut、UseDoconut、UseDoconutResources
using Doconut.Clouds;                // クラウドおよびファイル共有の設定
using Doconut.Configs.Conversion;    // ConversionTarget

型名自体は変更されていません — PdfConfig、WordConfig、ExcelConfig、CssConfig、ScriptConfig とその他はすべてまだ存在します。既存のアプリケーションを移行する場合、ほとんどのファイルは削除された using 行が 2 行だけ必要です;移行ガイド を参照してください。

すべてのオプション

DoconutOptions は以下の設定可能なプロパティを受け入れます。すべて任意です — プロパティが未設定の場合は以下のデフォルトが適用されます。

プロパティデフォルト説明
ShowDoconutInfofalsetrue の場合、token がないリクエストは 404 の代わりにバージョンバナーを返します。スモークチェックとして便利です;本番環境では無効にしてください。
UnsafeModefalsetrue の場合、ページリクエスト時の ASP.NET セッションセキュリティチェックをスキップします。本番環境では無効にしてください。綴りに注意 — 以前のライブラリではこれを UnSafeMode と呼んでいました。
MiddlewarePath"/doconut"ページ画像エンドポイントの調整値です。検証は行われますが、単独でブランチをマウントすることはありません;実際の UseDoconut() マッピングとクライアント BasePath に合わせて保持してください。
ResourcesPath"/doconut-res"埋め込み JS/CSS/画像リソースが提供される場所です。
LicensePath"" (empty string)ライセンスファイルへのパスです。空の場合は次のソースにフォールスルーし、その後自動検索されます。
LicenseContent"" (empty string)生のライセンスコンテンツ — 環境変数、シークレットマネージャ、またはデータベースから取得します。
LicenseStreamnullストリームとしてのライセンスで、起動時に一度読み取ります。
ResetLicensefalse予約された互換性フラグです。ライセンスは AddDoconut() 中に読み取られます;ライセンスを置き換えた後はアプリを再起動してください。
MaxConcurrentEditorSessions200ライブエディタセッションの最大数(DocOptions.EditMode で開かれたドキュメント)。これを超えると、最も使用されていないアイドルエディタセッションが閉じられます。通常のビューアセッションはカウントされません。0 または負の値は上限なしを意味します。
EditorSnapshotEveryOps50エディタ永続化が有効(AddDoconutEditorPersistence)な場合、N 回の記録変更ごとにライブドキュメントをスナップショットします。0 または負の値はセッション途中でスナップショットを取らないことを意味します。永続化が無効な場合は影響しません。

複数のソースが設定されている場合のライセンス優先順位:LicenseStream が LicenseContent を上回り、LicensePath が auto-search を上回ります — ライセンス設定 を参照してください。

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // アプリのマッピングとクライアントの BasePath を調整してください
    options.ResourcesPath   = "/doconut-res"; // viewer の JS/CSS/画像 が提供される場所
    options.UnsafeMode      = false;          // セッションのセキュリティを有効に保つ
    options.ShowDoconutInfo = false;
});

次のステップ

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