#プラグイン

NocoBaseでは、サーバーサイドのプラグイン（Server Plugin）は、サーバーサイドの機能を拡張・カスタマイズするためのモジュール化された方法を提供します。開発者は@nocobase/serverのPluginクラスを継承することで、様々なライフサイクルステージで、イベント、API、権限設定などのカスタムロジックを登録できます。

#プラグインクラス

基本的なプラグインクラスの構造は以下の通りです。

import { Plugin } from '@nocobase/server';

export class PluginHelloServer extends Plugin {
  async afterAdd() {}

  async beforeLoad() {}

  async load() {}

  async install() {}

  async afterEnable() {}

  async afterDisable() {}

  async remove() {}

  async handleSyncMessage(message: Record<string, any>) {}

  static async staticImport() {}
}

export default PluginHelloServer;

#ライフサイクル

プラグインのライフサイクルメソッドは以下の順序で実行され、それぞれのメソッドには特定の実行タイミングと用途があります。

#実行順序の説明

ライフサイクルメソッドの典型的な実行フローは以下の通りです。

1. 静的初期化フェーズ：staticImport()
2. アプリケーション起動フェーズ：afterAdd() → beforeLoad() → load()
3. プラグイン初回有効化フェーズ：afterAdd() → beforeLoad() → load() → install()
4. プラグイン再有効化フェーズ：afterAdd() → beforeLoad() → load()
5. プラグイン無効化フェーズ：プラグインが無効化されるとafterDisable()が実行されます。
6. プラグイン削除フェーズ：プラグインが削除されるとremove()が実行されます。

#app と関連メンバー

プラグイン開発では、this.app を通じてアプリケーションインスタンスが提供する様々なAPIにアクセスできます。これはプラグインの機能拡張におけるコアインターフェースです。app オブジェクトにはシステムの様々な機能モジュールが含まれており、開発者はプラグインのライフサイクルメソッド内でこれらのモジュールを使用してビジネス要件を実現できます。

#app メンバーリスト

ヒント：各モジュールの詳細な使用方法については、対応するドキュメントの章を参照してください。