#플러그인

NocoBase에서 서버 플러그인(Server Plugin)은 서버 기능을 확장하고 사용자 정의할 수 있는 모듈화된 방법을 제공합니다. 개발자는 @nocobase/server의 Plugin 클래스를 상속하여 다양한 생명 주기 단계에서 이벤트, 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 및 관련 멤버

플러그인 개발 시 this.app을 통해 애플리케이션 인스턴스가 제공하는 다양한 API에 접근할 수 있으며, 이는 플러그인 기능 확장의 핵심 인터페이스입니다. app 객체는 시스템의 다양한 기능 모듈을 포함하고 있으며, 개발자는 플러그인의 생명 주기 메서드에서 이러한 모듈을 사용하여 비즈니스 요구 사항을 구현할 수 있습니다.

#app 멤버 목록

참고: 각 모듈의 자세한 사용 방법은 해당 문서 장을 참조하십시오.