DoconutHost
System.Web のコンポジションルート
DoconutHost (namespace Doconut) は、ワーカープロセス全体の Doconut のサービスを所有する static クラスです。ASP.NET Core アプリケーションはそれらのサービスをフレームワーク独自のコンテナに組み込みますが、従来の ASP.NET にはコンテナがないため、DoconutHost がコンテナを作成し保持します。DocImage.axd ハンドラとリソースモジュールはそれから必要なものをすべて解決し、あなたのコードも同様です。
| メンバー | 目的 |
|---|---|
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null) | サービスを構築します — 一度だけ |
static IServiceProvider Services { get; } | 構築されたコンテナ |
static bool IsInitialized { get; } | true が Initialize の実行後に一度 |
static void Shutdown() | バックグラウンド作業を停止し、コンテナを破棄します |
初期化
Application_Start から Global.asax.cs 内で呼び出します:
// Global.asax.cs, Application_Start - ワーカープロセスごとに一度だけ。2回目の呼び出しは何もしません:
// 最初の呼び出しのオプションが勝ちます。
Doconut.DoconutHost.Initialize(
options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
},
services =>
{
// 任意。Doconut の独自登録の後、コンテナが構築される前に実行されます、
// そのため、サービスを追加したり、Doconut が登録したものを置き換えることができます。
services.AddMemoryCache();
});configureは DoconutOptions を受け取ります: ライセンス、セキュリティスイッチ、プラグイン、ウィジェット。configureServicesはオプションです。Doconut が独自のサービスを登録した後、コンテナが構築される前に実行されるため、サービスを追加できます — Web ファーム用のAddDoconutDistributedが一般的です — または Doconut が行った登録を置き換えることができます。
最初の呼び出しが有効です。 Initialize は冪等です: 2 回目の呼び出しはすぐに戻り、そのデリゲートは実行されません。これにより重複した Application_Start が無害になりますが、Initialize を再度呼び出して設定を変更することはできません — 代わりにアプリケーションプールをリサイクルしてください。
ここで例外がスローされます — ライセンスのないプラグイン、無効なオプション、不完全なファーム構成 — これらは Application_Start 内で発生します。ASP.NET はその後、空の 500 で全てのリクエストに応答し、例外は Windows イベントログ(アプリケーションログ、ソース ASP.NET)にのみ記録されます。
サービスと IsInitialized
System.Web にはコントローラ、ページ、ハンドラ向けのコンストラクタインジェクションがないため、使用する場所で Doconut のサービスを解決してください:
// System.Web にはコンストラクタインジェクションがありません: 使用する場所で Doconut のサービスを解決してください。
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
// Converter プラグインが有効な場合のみ登録されます(プラグインページを参照)。
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();Services は Initialize の前に読み取られた場合、InvalidOperationException(DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.)をスローします。より早く実行される可能性のあるコード — モジュールや static コンストラクタ — はまず IsInitialized をチェックできます。
コードで通常解決されるものは次のとおりです:
| サービス | ライフタイム | 役割 |
|---|---|---|
Viewer | 一時的 | オープン、クローズ、アノテーション、リソースヘルパー — Viewer を参照 |
DocumentConverter | 一時的 | 変換 — 常に登録されています; Converter プラグインなしで解決すると、追加すべきプラグイン名を示す InvalidOperationException がスローされます |
DocumentSigner | 一時的 | 署名 — Signer プラグインが必要です(Signer Plugin を参照) |
IDoconutLicenseService | シングルトン | ロードされたライセンスとその機能 — Licensing を参照 |
DoconutOptions | シングルトン | Initialize に渡されたオプション |
HealthCheckService | シングルトン | "doconut" ヘルスチェック(以下)を実行します |
DoconutHost.Services から解決し、独自のコンテナからは決して解決しないでください。Doconut を別のコンテナに登録すると、ハンドラやモジュールが参照しない第2の別個のサービスセットが構築されます: それを通じて開かれたドキュメントは DocImage.axd からは不明です。
シャットダウン
// Global.asax.cs, Application_End - バックグラウンド作業を停止し、コンテナを破棄します。
// 2回呼び出しても安全で、Initialize が実行されなかった場合でも安全です。
Doconut.DoconutHost.Shutdown();Shutdown は Doconut のバックグラウンド作業(分散モードで使用)を停止し、コンテナを破棄します。2 回呼び出しても安全で、Initialize が実行されていない場合も安全です — 例えば最初のリクエスト前にアプリケーションプールがリサイクルされた場合などです。
ヘルスチェック
Doconut はライセンス状態を報告する "doconut" という名前のヘルスチェックを登録します。従来の ASP.NET には独自のヘルスチェックエンドポイントがないため、コントローラから公開してください:
// GET /Health - Doconut は "doconut" ヘルスチェックを登録し、ライセンス状態を報告します:
// Healthy(有効)、Degraded(トライアルまたはライセンスファイルなし)、Unhealthy(拒否または期限切れ)。
public async Task<ActionResult> Index()
{
var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
HealthReport report = await health.CheckHealthAsync();
Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
return Content(report.Status.ToString(), "text/plain");
}| ステータス | 意味 |
|---|---|
Healthy | 有効なライセンスがロードされています |
Degraded | トライアル、またはライセンスファイルが見つかりません |
Unhealthy | ライセンスが拒否されました(例: 編集されたファイル)または期限切れです |
ASP.NET Core 拡張メソッド
このパッケージには UseDoconut() と UseDoconutResources() も含まれており、ASP.NET Core パイプライン拡張として、ASP.NET Core パッケージとコードを共有しています。このパッケージでは両方とも [Obsolete] とマークされており使用されていません: System.Web アプリケーションには追加できるリクエストパイプラインがありません。代替としては、Installation からの二つの Web.config 登録があります:
| ASP.NET Core | .NET Framework 4.7.2 |
|---|---|
builder.Services.AddDoconut(...) | DoconutHost.Initialize(...) in Application_Start |
app.UseDoconut() | Doconut.DocImageHandler on DocImage.axd in Web.config |
app.UseDoconutResources() | Doconut.DoconutResourceModule in Web.config |
| コンストラクタインジェクション | DoconutHost.Services.GetRequiredService<T>() |
| ホストシャットダウン | DoconutHost.Shutdown() in Application_End |
このページは役に立ちましたか?