#Плагин

В NocoBase серверный плагин предоставляет модульный способ расширения и настройки функциональности серверной части. Разработчики могут расширять класс Plugin из @nocobase/server, чтобы регистрировать события, 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 и связанные компоненты

При разработке плагина вы можете получать доступ к различным API экземпляра приложения через this.app. Это основной интерфейс для расширения функциональности плагина. Объект app содержит функциональные модули системы, которые можно использовать в методах жизненного цикла для реализации бизнес-требований.

#Список компонентов app

Подробную информацию об использовании каждого модуля см. в соответствующих главах документации.