#Плагин

В 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

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