#Плагін

У NocoBase серверний плагін (Server Plugin) надає модульний спосіб розширення та налаштування функціональності серверної частини. Розробники можуть, успадкувавши клас 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

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