プラグインシステム
プラグインでビューアを拡張する
Doconut のコアはスリムなままです;オプション機能は プラグイン として提供されます — ビューアやサービスを提供する個別の NuGet パッケージで、ライセンスによって有効化されます。このページでは、登録モデル、ランタイム時のライセンスゲーティングの動作、そして独自のビューアをプラグインする方法を説明します。
プラグインの登録
各プラグインパッケージは 1 つのプラグインクラスを公開します。起動時に一度だけ登録します。
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() はプラグインのインスタンスを生成し、DoconutOptions に保持されているプラグインレジストリに対してその Register コールバックを呼び出します。プラグインが提供するすべてはプラグインの 必須機能 としてタグ付けされます。AddDoconut() は登録されたプラグインを即座に検証します:ライセンスが欠如している、レガシー TRIAL ファイル、または機能がない有料ライセンスの場合、InvalidOperationException で起動が失敗します。Temporary/Demo の登録は有効期限を超えて保持されますが、実行時の機能は有効期限日以降に取り消されます。
契約
プラグインは意図的に小さなインターフェースを実装します。
public interface IDoconutPlugin
{
string Name { get; } // 例: "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // ライセンスゲート
void Register(IDoconutPluginBuilder builder); // ビューア/サービスに貢献する
}Register の内部で、ビルダーは 2 種類の貢献を受け入れます:
builder.RegisterViewer(extension, factory)— ファイル拡張子用のビューア;ファクトリはIFormatViewerを返します(この方法で DICOM プラグインは.dcmと.imaを登録します)、builder.RegisterService<TContract>(() => …)— パイプラインの他の部分が参照できる型付きサービスです。
機能とゲーティング
機能はライセンス単位です。Converter、Dicom、Signer はオプトインプラグインとして提供されます;Search と Annotation は同様にゲートされる組み込み機能です。ベースビューアは 機能ではありません — 前提条件であり、ライセンスサービス上で IsViewerLicensed として公開されます。
起動時の検証は通常、ライセンスがないプラグインがリクエストパイプラインに入るのを防ぎます。ビューアファクトリはまた、起動後に権利が変更された場合に重要になる 2 つの防御的実行時ルールを適用します:
- プラグインが組み込みビューアを上書きする(プラグインが組み込みレジストリでも処理される拡張子を主張する場合):機能がライセンスされていれば、プラグインビューアが優先されます;ライセンスがない場合、Doconut は静かに組み込みビューアにフォールバックします。ユーザーは依然としてドキュメントを見ることができますが、プラグイン機能は利用できません。
- プラグイン専用フォーマット(
.dcmと.ima— DICOM には組み込みビューアがありません):機能がない場合、オープン呼び出しはハードに失敗します:
LicenseException: This document type requires the 'Dicom' plugin license.アクティブな Temporary ライセンスはすべての機能を付与します(クリーンで透かしのないベースビューイングと共に)。これは本番開始時の典型的な驚きの原因です:機能の一つが欠けた購入済みライセンスで同じプラグインを登録すると、AddDoconut() が起動時に失敗します。デプロイ前に IsCapabilityGranted(...) をプランと比較してください。逆に、ライセンスが全くない場合、何も付与されません — ライセンスが欠如していることは Temporary ライセンスではありません。
同じゲーティングはクライアント側でも現れます:Viewer.ReferenceScripts() と ReferenceCss() はライセンスでゲートされた機能(検索、注釈、…)のスクリプト/スタイルバンドルを、ライセンスが有効な 場合にのみ 発行し、ウィジェットの UI がサーバーが実際に行うことと一貫性を保ちます。
機能とプラグインのマップ
製品 UI は「プラグイン」を広い機能ラベルとして使用しますが、サーバー側の登録は異なります:
| 機能 | 有効化方法 | 機能 | 貢献内容 |
|---|---|---|---|
| Annotation | ビューアに組み込まれています;注釈リソースを含みます | Annotation | ブラウザでの作成、セッション永続化、そして焼き込みエクスポート |
| Search | 検索可能フォーマットビューアに組み込まれています;検索リソースを含み、必要に応じて抽出を有効にします | Search | ネイティブテキストインデックス、ハイライト、結果ナビゲーション |
| Converter | Doconut.NET8.Converter をインストールし、ConverterPlugin を登録します | Converter | C# 変換サービスとオプションのウェブウィジェット |
| DICOM | Doconut.NET8.Dicom をインストールし、DicomPlugin を登録します | Dicom | .dcm と .ima 用の医療画像ビューイング |
| Signer | Doconut.NET8.Signer をインストールし、SignerPlugin を登録します | Signer | PDF と Word 用の可視署名とデジタルシール:C# 署名サービスとオプションのウェブウィジェット |
Annotation と通常の Search は AddPlugin<TPlugin>() を使用しません;それらのバンドルはライセンスが該当する機能を付与したときにのみ出力されます。Converter、DICOM、Signer はオプトインの IDoconutPlugin 実装です。
リリースされたプラグインパッケージ
| Plugin | Package | Capability | Contributes |
|---|---|---|---|
| Converter | Doconut.NET8.Converter | Converter | ドキュメント変換機能 |
| DICOM | Doconut.NET8.Dicom | Dicom | 医療画像ビューイング(.dcm と .ima — プラグイン専用フォーマット) |
| Signer | Doconut.NET8.Signer | Signer | PDF と Word の署名 |
それぞれは Plugins の下に専用ページがあり、構成と使用方法が記載されています。
カスタムビューア — 独自のフォーマットハンドラ
プラグインパッケージを書かずに、Program.cs から直接ビューアをパイプラインにプラグインできます:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // IFormatViewer を実装する
() => new ImageConfig { ImageResolution = 150 }); // オプションのデフォルト設定
});
// ファクトリが作成するフォーマットハンドラ。これらのメンバーを独自のレンダリングに置き換えてください。
public sealed class MyCustomViewer : Doconut.Core.Interfaces.IFormatViewer
{
public ViewerType ViewerType => ViewerType.None;
public int TotalPages => 0;
public int DefaultWidth => 0;
public int DefaultHeight => 0;
public bool PreferOcr => false;
public Task LoadAsync(Stream documentStream, BaseConfig config, CancellationToken ct = default)
=> Task.CompletedTask;
public Task<byte[]> GetPageImageAsync(int pageNumber, CancellationToken ct = default)
=> Task.FromResult(Array.Empty<byte>());
public void Dispose() { }
}カスタムビューアは すべて(組み込みとプラグインの両方)より優先され、ライセンスでゲートされません(自分のコードです)。デフォルト設定を提供しない場合、ファクトリは ImageConfig にフォールバックします。
まとめ
- プラグインは明示的に登録され、
LicenseCapabilityはAddDoconut()中に検証されます — 欠如または一時的でない権利が不十分な場合は速やかに失敗します。 - 上書きスタイルのプラグインは優雅に劣化します;プラグイン専用フォーマットは
LicenseExceptionで失敗します。 - アクティブな Temporary ライセンスはすべてをアンロックします;本番環境は購入したものだけをアンロックします。出荷前に
IDoconutLicenseServiceで確認してください。
このページは役に立ちましたか?