DoconutExtensions

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

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

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

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

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

  • Converter はプラグインが必要です。 DocumentConverter を options.AddPlugin<ConverterPlugin>() なしで解決すると例外がスローされます:
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 の場合、ドキュメントセキュリティ層が自動的にその前に接続されます。

一般的な代替手段として、DocImage.axd の従来のリクエスト形状を MapWhen ブランチで保持します(クライアントはその後 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 つの登録があります。これらは両方とも 分散デプロイ でエンドツーエンドにカバーされており、シグネチャは次のとおりです:

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

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

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

Ordering recap

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

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