88nn and 8n8n

n8n cho các nhà phát triển: mở rộng chức năng với các nút tùy chỉnh

n8n for Developers: Extending Functionality with Custom Nodes

Written by

admin

in

n8n cho các nhà phát triển: mở rộng chức năng với các nút tùy chỉnh

Hiểu kiến ​​trúc của N8N

N8N là một công cụ tự động hóa dòng công việc nguồn mở mạnh mẽ cho phép người dùng tích hợp liền mạch các dịch vụ khác nhau và tự động hóa các tác vụ mà không cần mã hóa rộng rãi. Kiến trúc mô -đun của nó cho phép các nhà phát triển mở rộng các tính năng hiện có thông qua các nút tùy chỉnh. Hiểu kiến ​​trúc cơ bản là điều cần thiết để tạo và triển khai các nút này một cách hiệu quả.

Tại cốt lõi của nó, N8N hoạt động trên một hệ thống dựa trên nút trong đó mỗi nút thực hiện một hành động cụ thể hoặc lấy dữ liệu từ một nguồn cụ thể. Các nút được nhóm thành quy trình công việc và luồng dữ liệu giữa chúng. Các nhà phát triển có thể tạo các nút tùy chỉnh để phục vụ các nhu cầu cụ thể hoặc tích hợp với API hiện không được N8N hỗ trợ.

Điều kiện tiên quyết để phát triển các nút tùy chỉnh

Trước khi lặn vào phát triển nút tùy chỉnh, điều quan trọng là phải nắm bắt các điều kiện tiên quyết sau:

  • Kiến thức JavaScript: Vì N8N được xây dựng trên Node.js, nên sự quen thuộc với JavaScript là rất cần thiết.
  • Cài đặt N8N: Đảm bảo bạn đã cài đặt đầy đủ N8N và chạy trên máy cục bộ của bạn. Bạn có thể theo dõi Hướng dẫn cài đặt chính thức để bắt đầu.
  • Hiểu API: Biết cách hoạt động của API, bao gồm REST và GraphQL, sẽ đơn giản hóa đáng kể quá trình tích hợp các dịch vụ thông qua các nút.

Thiết lập môi trường phát triển của bạn

Để bắt đầu phát triển các nút tùy chỉnh trong N8N, trước tiên hãy đảm bảo rằng bạn có:

  1. Node.js: Cài đặt phiên bản ổn định mới nhất của Node.js trên máy của bạn.

  2. Sao chép kho lưu trữ N8N: Sử dụng git để nhân bản kho lưu trữ N8N.

    git clone https://github.com/n8n-io/n8n.git

  3. Cài đặt phụ thuộc: Điều hướng đến thư mục và cài đặt các phụ thuộc cần thiết bằng cách sử dụng NPM hoặc sợi.

    cd n8n
npm install

  4. Chạy N8N tại địa phương: Khởi chạy N8N cục bộ để kiểm tra các nút của bạn:

    npm run dev

Tạo một nút tùy chỉnh trong N8N

Để tạo một nút tùy chỉnh, hãy làm theo các bước có cấu trúc sau:

  1. Cấu trúc tập tin: Điều hướng đến packages/nodes-base/nodes Thư mục. Mỗi nút tùy chỉnh nên nằm trong thư mục con của nó.

  2. Mẫu nút: Tạo một thư mục mới cho nút của bạn, ví dụ, MyCustomNodevà bên trong nó, tạo:

    • MyCustomNode.node.ts: Logic chính của nút của bạn.
    • MyCustomNode.descriptor.ts: Định nghĩa nút, bao gồm các tham số và cài đặt.

  3. Logic nút (mycustomnode.node.ts):

    import { IExecuteFunctions } from 'n8n-core';
import { NodeOperationError } from 'n8n-workflow';

export class MyCustomNode {
    async execute(this: IExecuteFunctions) {
        const responseData = await this.getDataFromApi();
        return this.prepareOutputData(responseData);
    }

    async getDataFromApi() {
        // Logic to connect to API and retrieve data
        return {}; // Replace with actual logic
    }
}

  4. Định nghĩa nút (mycustomnode.descriptor.ts):

    export const nodeDescriptor = {
    displayName: 'My Custom Node',
    name: 'myCustomNode',
    icon: 'file:myCustomNode.svg',
    group: ['transform'],
    version: 1,
    description: 'A custom node to integrate with XYZ service.',
    defaults: {
        name: 'My Custom Node',
        color: '#00cc88',
    },
    inputs: ['main'],
    outputs: ['main'],
    properties: [],
};

Kiểm tra nút tùy chỉnh của bạn

Để xác thực các nút của bạn:

  • Sử dụng UI N8N: Mở giao diện trình soạn thảo N8N. Tạo một quy trình công việc mới và tìm kiếm nút tùy chỉnh của bạn. Nếu mọi thứ được thiết lập chính xác, nó sẽ xuất hiện giữa các nút có sẵn.

  • Gỡ lỗi: Hãy chú ý đến nhật ký console và thông báo lỗi. Sử dụng console.log() Trong logic của nút của bạn để kiểm tra các giá trị và luồng.

Xuất bản các nút tùy chỉnh

Khi nút của bạn được phát triển và thử nghiệm, hãy xem xét xuất bản nó được sử dụng bởi những người khác. Tạo một gói mới cho nút của bạn và đưa nó vào kho lưu trữ GitHub. Bạn có thể xuất bản gói của mình lên NPM như một phần của cộng đồng N8N, nhưng đảm bảo nó đáp ứng các tiêu chuẩn chất lượng của cộng đồng.

Tạo một readme.md cho nút của bạn bao gồm:

  • Hướng dẫn cài đặt.
  • Ví dụ sử dụng.
  • Chi tiết về chức năng.
  • Tài liệu API, nếu có.

Thực tiễn tốt nhất để phát triển các nút tùy chỉnh

  • Độ phức tạp tối thiểu: Giữ chức năng nút đơn giản và cụ thể. Tránh tích hợp nhiều dịch vụ trong một nút duy nhất.
  • Theo quy ước đặt tên: Sử dụng tên mô tả cho cả tệp và biến để duy trì khả năng đọc.
  • Xử lý lỗi: Thực hiện các cơ chế xử lý lỗi mạnh mẽ. Sử dụng NodeOperationError Đối với các lỗi ném giúp gỡ lỗi.
  • Tài liệu: Ghi lại mã của bạn một cách kỹ lưỡng. Bao gồm các ý kiến ​​giải thích chức năng, đặc biệt đối với logic không rõ ràng.

Tích hợp với API hiện có

Khi thiết kế nút tùy chỉnh của bạn, hãy tận dụng các API hiện có để cung cấp chức năng động. Sử dụng các thư viện như axios Đối với các yêu cầu HTTP. Thực hiện phân trang nếu API của bạn có giới hạn về kết quả cho mỗi yêu cầu.

Dưới đây là một ví dụ về tích hợp API đơn giản trong một nút tùy chỉnh:

import axios from 'axios';

async getDataFromApi() {
    const response = await axios.get('https://api.example.com/data');
    if (response.status !== 200) {
        throw new NodeOperationError(this.getNode(), 'API request failed');
    }
    return response.data;
}

Tăng cường hiệu suất

Tối ưu hóa các nút của bạn cho hiệu suất liên quan đến:

  • Dữ liệu bộ nhớ đệm: Nếu nút của bạn tìm nạp dữ liệu thường xuyên, hãy xem xét các tùy chọn bộ đệm để giảm các cuộc gọi API.
  • Hợp lý hóa logic: Tránh các tính toán không cần thiết; Chỉ xử lý những gì cần thiết cho trường hợp sử dụng cụ thể của bạn.
  • Hoạt động không đồng bộ: Sử dụng Async/chờ quản lý các cuộc gọi không đồng bộ một cách hiệu quả, ngăn chặn việc chặn thực hiện quy trình công việc.

Tùy chỉnh giao diện người dùng

Các nút tùy chỉnh cũng có thể được hưởng lợi từ các yếu tố giao diện thân thiện với người dùng. Bạn có thể xác định các tham số tùy chỉnh trong MyCustomNode.descriptor.tscải thiện khả năng sử dụng. Các tham số có thể bao gồm từ các trường đầu vào đơn giản đến các bộ chọn thả xuống hoặc các cấu trúc phức tạp.

Ví dụ Định nghĩa tham số:

properties: [
    {
        displayName: 'API Key',
        name: 'apiKey',
        type: 'string',
        default: '',
        required: true,
        placeholder: 'Enter your API key',
        description: 'The API key to access the service.',
    },
],

Thiết lập này nhắc nhở người dùng cung cấp khóa API khi định cấu hình nút, nâng cao bảo mật và trải nghiệm người dùng.

Kết luận: Làm phong phú quy trình công việc với các nút tùy chỉnh

Bằng cách mở rộng chức năng của N8N thông qua các nút tùy chỉnh, các nhà phát triển trao quyền cho người dùng với khả năng tích hợp các dịch vụ khác nhau phù hợp với các yêu cầu cụ thể. Cho dù đó là cho các dự án cá nhân hoặc các tác vụ tự động hóa chuyên nghiệp, khả năng tùy chỉnh các nút đảm bảo tính linh hoạt và khả năng thích ứng trong bối cảnh tự động hóa quy trình công việc.

Tham gia với cộng đồng trên GitHub và các diễn đàn để liên tục cải thiện các kỹ năng của bạn, chia sẻ kiến ​​thức và giới thiệu các nút tùy chỉnh của bạn, mở đường cho một tương lai được kết nối hơn trong tích hợp phần mềm và tự động hóa.