#Plugin

No NocoBase, um plugin de servidor oferece uma forma modular de estender e personalizar as funcionalidades do lado do servidor. Você, como desenvolvedor(a), pode estender a classe Plugin de @nocobase/server para registrar eventos, APIs, configurações de permissão e outras lógicas personalizadas em diferentes estágios do ciclo de vida.

#Classe do Plugin

A estrutura básica de uma classe de plugin é a seguinte:

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;

#Ciclo de Vida

Os métodos do ciclo de vida do plugin são executados na seguinte ordem. Cada método tem seu momento de execução e propósito específicos:

#Descrição da Ordem de Execução

O fluxo de execução típico dos métodos do ciclo de vida é:

1. Fase de Inicialização Estática: staticImport()
2. Fase de Inicialização da Aplicação: afterAdd() → beforeLoad() → load()
3. Fase de Primeira Ativação do Plugin: afterAdd() → beforeLoad() → load() → install()
4. Fase de Segunda Ativação do Plugin: afterAdd() → beforeLoad() → load()
5. Fase de Desativação do Plugin: afterDisable() é executado quando o plugin é desativado
6. Fase de Remoção do Plugin: remove() é executado quando o plugin é removido

#app e Membros Relacionados

No desenvolvimento de plugins, você pode acessar várias APIs fornecidas pela instância da aplicação através de this.app. Esta é a interface principal para estender a funcionalidade do plugin. O objeto app contém vários módulos funcionais do sistema. Você, como desenvolvedor(a), pode usar esses módulos nos métodos do ciclo de vida do plugin para implementar requisitos de negócios.

#Lista de Membros de app

Dica: Para o uso detalhado de cada módulo, consulte os capítulos de documentação correspondentes.