#Plugin

Trong NocoBase, plugin phía máy chủ cung cấp một phương thức module hóa để mở rộng và tùy chỉnh chức năng phía máy chủ. Các nhà phát triển có thể kế thừa lớp Plugin từ @nocobase/server để đăng ký các sự kiện, API, cấu hình quyền và các logic tùy chỉnh khác tại các giai đoạn vòng đời khác nhau.

#Lớp Plugin

Cấu trúc lớp plugin cơ bản như sau:

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;

#Vòng đời

Các phương thức vòng đời của plugin được thực thi theo thứ tự sau. Mỗi phương thức có thời điểm và mục đích thực thi cụ thể:

#Mô tả thứ tự thực thi

Luồng thực thi điển hình của các phương thức vòng đời:

1. Giai đoạn khởi tạo tĩnh: staticImport()
2. Giai đoạn khởi động ứng dụng: afterAdd() → beforeLoad() → load()
3. Giai đoạn kích hoạt plugin lần đầu: afterAdd() → beforeLoad() → load() → install()
4. Giai đoạn kích hoạt plugin lần hai: afterAdd() → beforeLoad() → load()
5. Giai đoạn vô hiệu hóa plugin: afterDisable() được thực thi khi plugin bị vô hiệu hóa
6. Giai đoạn xóa plugin: remove() được thực thi khi plugin bị xóa

#app và các thành viên liên quan

Trong quá trình phát triển plugin, bạn có thể truy cập các API khác nhau do thể hiện ứng dụng cung cấp thông qua this.app. Đây là giao diện cốt lõi để mở rộng chức năng plugin. Đối tượng app chứa các module chức năng khác nhau của hệ thống. Các nhà phát triển có thể sử dụng các module này trong các phương thức vòng đời của plugin để triển khai các yêu cầu nghiệp vụ.

#Danh sách thành viên app

Lưu ý: Để biết chi tiết cách sử dụng từng module, vui lòng tham khảo các chương tài liệu tương ứng.