DoconutExtensions

サービスとミドルウェアの登録

DoconutExtensions (namespace Doconut.Middleware) は、すべての Doconut ホストが行う 3 つの呼び出しを持つ静的クラスです:1 つのサービス登録と 2 つのミドルウェア登録です。

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // UseDoconut() の前に UseSession() を呼び出してください
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 → Startup validation を参照)、完全なサービスグラフを登録します:

サービスライフタイム役割
DoconutOptionsSingleton設定オブジェクト
セッションキャッシュサービスSingletonToken → セッションキャッシュ(IMemoryCache も登録されます)
IDoconutLicenseServiceSingleton起動時に一度だけロードされるライセンス(優先順位: LicenseStream → LicenseContent → LicensePath → 自動検索)
ページ画像パイプラインSingletonページの画像処理を実行します(透かし、回転、スケール、注釈)
ドキュメントセキュリティ(アクセスストア)Singletonトークンとセッションのバインディングの権限付与
ViewerTransient公開のオープン/クローズファサード
DocumentConverterTransient変換ファサード — Converter プラグインが必要です
DocumentSignerTransient署名ファサード — Signer プラグインが必要です(Signer Plugin を参照)
DistributedDocumentPublisherTransientドキュメントのアーティファクトを共有ストレージに公開します
ヘルスチェック "doconut"—ASP.NET ヘルスチェックを通じてライセンス/有効期限の状態を報告します

以前の .NET Standard ライブラリには同等の呼び出しはありませんでした。リクエストごとに new Viewer(cache, accessor) を構築し、オプションをミドルウェアに渡していましたが、これらはすべてこの単一の登録に置き換えられます。

知っておくべき 2 つの動作:

  • Converter はプラグインが必要です。 options.AddPlugin<ConverterPlugin>() がない状態で DocumentConverter を解決すると例外がスローされます:
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() 時に失敗します。Temporary/Demo 登録は有効期限を過ぎても存続しますが、ランタイムゲートは期限切れの機能を取り消します。

ヘルスチェックは標準の ASP.NET Core メカニズムと統合されます — ライセンス状態をヘルスエンドポイントで取得したい場合はマッピングしてください:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Doconut のページ画像ミドルウェアを追加します。?token= クエリパラメータを含むすべてのリクエスト(ページ、サムネイル、検索、注釈、ページアクション(完全なリクエストテーブルは Core Concepts → How the Viewer Works にあります))に応答し、その他のリクエストには 404(または ShowDoconutInfo バナー)で直接応答します:パイプラインの残りにリクエストを渡すことはありません。このページのサンプルのように独自のブランチにマウントしてください。UnsafeMode が false の場合、ドキュメントセキュリティ層が自動的にその前に接続されます。

引数は不要です。 ここで DoconutOptions インスタンスを渡すのは以前のライブラリの形態であり、もはやコンパイルできません。

一般的なセットアップでは、MapWhen ブランチで従来の DocImage.axd リクエスト形状を保持します(クライアントはその後 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)

DoconutOptions.ResourcesPath(デフォルトは /doconut-res)で埋め込みの JS、CSS、画像、フォントを提供します。これらは Viewer.ReferenceCss() / ReferenceScripts() がタグを出力するファイルです。

UseDoconut() の前に必ず呼び出してください。 ビューア領域が空のままで、ブラウザコンソールに /doconut-res/... の 404 が表示される場合、この呼び出しが欠落または誤った位置にあります。

これは、埋め込みリソースハンドリングミドルウェアを手動で配線するためのサポートされた代替手段です。

Serving from shared storage

ドキュメントをレンダリングするノードが必ずしもページを提供するノードでないデプロイメント向けに、さらに 2 つの登録があります。これらはすべて Distributed Deployments でエンドツーエンドにカバーされており、シグネチャは次のとおりです:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // オプトインのバックグラウンド公開キュー
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // widget のアップロード用共有バックエンドストア

読み取り側は同じパッケージに含まれる Doconut.Clouds アセンブリからの別個のミドルウェアです:

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

UseDoconutWebFarm(...) と WebFarmOptions はこのリリースには存在しません。設定ごとのマッピングについては migration guide を参照してください。

Ordering recap

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

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