DoconutExtensions
サービスとミドルウェアの登録
DoconutExtensions (namespace Doconut.Middleware) は、すべての Doconut ホストが行う 3 つの呼び出しを持つ静的クラスです:1 つのサービス登録と 2 つのミドルウェア登録。
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession(); // UseDoconut() の前に UseSession() を呼び出してください
app.UseDoconutResources(); // UseDoconut() の前に登録する必要があります
app.Map("/doconut", branch => branch.UseDoconut());UseDoconut() は到達したすべてのリクエストに応答するので、app.Map とともに独自のブランチにマウントしてください。
AddDoconut
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)DoconutOptions を構築し、失敗時にすぐに検証します(DoconutOptions → Startup validation を参照)、そして完全なサービスグラフを登録します:
| サービス | ライフタイム | 役割 |
|---|---|---|
DoconutOptions | Singleton | 構成オブジェクト |
| セッションキャッシュサービス | Singleton | トークン → セッションキャッシュ(IMemoryCache も登録されます) |
IDoconutLicenseService | Singleton | 起動時に一度だけロードされるライセンス(優先順位: LicenseStream → LicenseContent → LicensePath → 自動検索) |
| ページ画像パイプライン | Singleton | ページの画像処理を実行します(透かし、回転、スケーリング、注釈) |
| ドキュメントセキュリティ(アクセスストア) | Singleton | トークンとセッションのバインディングのための権限付与 |
Viewer | Transient | 公開のオープン/クローズファサード |
DocumentConverter | Transient | 変換ファサード — Converter プラグインが必要です |
DocumentSigner | Transient | 署名ファサード — Signer プラグインが必要です(Signer プラグイン を参照) |
DistributedDocumentPublisher | Transient | ドキュメントのアーティファクトを共有ストレージに公開します(分散デプロイメント を参照) |
ヘルスチェック "doconut" | — | ASP.NET ヘルスチェックを通じてライセンス/有効期限の状態を報告します |
知っておくべき 2 つの動作:
- Converter はプラグインが必要です。
DocumentConverterをoptions.AddPlugin<ConverterPlugin>()なしで解決すると例外がスローされます:
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()時に失敗します。 一時的/デモの登録は有効期限を過ぎても存続しますが、実行時のゲートは期限切れの機能を取り消します。
ヘルスチェックは標準の ASP.NET Core メカニズムと統合されます — ライセンス状態をヘルスエンドポイントで取得したい場合はマッピングしてください:
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)Doconut ページ画像ミドルウェアを追加します。?token= クエリパラメータを含むすべてのリクエスト(ページ、サムネイル、検索、注釈、ページアクション(完全なリクエストテーブルは Core Concepts → How the Viewer Works にあります))に応答し、その他のリクエストには 404(または ShowDoconutInfo バナー)で直接応答します:パイプラインの残りにリクエストを渡すことはありません。このページのサンプルのように、独自のブランチにマウントしてください。UnsafeMode が false の場合、ドキュメントセキュリティ層が自動的にその前に接続されます。
一般的な代替案として、DocImage.axd の歴史的なリクエスト形状を MapWhen ブランチで保持します(クライアントはその後 BasePath: '/' を使用します):
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)DoconutOptions.ResourcesPath(デフォルトは /doconut-res)で埋め込みの JS、CSS、画像、フォントを提供します。これらは Viewer.ReferenceCss() / ReferenceScripts() がタグを生成するファイルです。
UseDoconut() の前に必ず呼び出してください。 ビューア領域が空のままで、ブラウザコンソールに /doconut-res/... の 404 が表示される場合、この呼び出しが欠如または誤配置です。
Serving from shared storage
ドキュメントをレンダリングするノードが必ずしもページを提供するノードでないデプロイメント向けに、さらに 2 つの登録があります。これらはすべて 分散デプロイメント でエンドツーエンドにカバーされています;シグネチャは次のとおりです:
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // バックグラウンド公開キューをオプトイン
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // ウィジェットのアップロード用共有バックエンドストア読み取り側は同じパッケージに含まれる Doconut.Clouds アセンブリからの別個のミドルウェアです:
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerOrdering recap
app.UseRouting();
app.UseSession(); // UseDoconut() の前に UseSession() を呼び出してください
app.UseDoconutResources(); // UseDoconut() の前に登録する必要があります
app.Map("/doconut", branch => branch.UseDoconut()); // または MapWhen ブランチこのページは役に立ちましたか?