#Plugin

Dans NocoBase, un plugin offre une approche modulaire pour étendre et personnaliser les fonctionnalités côté serveur. Les développeurs peuvent étendre la classe Plugin de @nocobase/server pour enregistrer des événements, des interfaces, des configurations de permissions et d'autres logiques personnalisées à différentes étapes de leur cycle de vie.

#Classe de plugin

Voici la structure d'une classe de plugin de base :

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;

#Cycle de vie

Les méthodes du cycle de vie d'un plugin s'exécutent dans l'ordre suivant. Chaque méthode a un moment d'exécution et un objectif spécifiques :

#Ordre d'exécution

Voici le déroulement typique de l'exécution des méthodes de cycle de vie :

1. Phase d'initialisation statique : staticImport()
2. Phase de démarrage de l'application : afterAdd() → beforeLoad() → load()
3. Phase de première activation du plugin : afterAdd() → beforeLoad() → load() → install()
4. Phase de réactivation du plugin : afterAdd() → beforeLoad() → load()
5. Phase de désactivation du plugin : afterDisable() est exécuté lorsqu'un plugin est désactivé.
6. Phase de suppression du plugin : remove() est exécuté lorsqu'un plugin est supprimé.

#L'objet app et ses membres

Lors du développement de plugins, vous pouvez accéder à diverses API fournies par l'instance de l'application via this.app. C'est l'interface principale pour étendre les fonctionnalités des plugins. L'objet app contient les différents modules fonctionnels du système. Les développeurs peuvent utiliser ces modules dans les méthodes de cycle de vie des plugins pour implémenter leurs besoins métier.

#Liste des membres de l'objet app

Astuce : Pour une utilisation détaillée de chaque module, veuillez vous référer aux chapitres de documentation correspondants.