Hỗ trợ Intellisense kiểu TypeScript cho Node Code bằng JSDoc - Quy trình làm việc n8n

Người dùng n8n Nâng cao: Các lập trình viên thường xuyên sử dụng Code node của n8n để viết logic tùy chỉnh.
Chuyên gia tự động hóa: Những người xây dựng hệ thống workflow n8n phức tạp đòi hỏi các công cụ gỡ lỗi mạnh mẽ.
Người sáng tạo nội dung kỹ thuật: Các cá nhân soạn tài liệu hoặc chia sẻ các phương pháp hay nhất để phát triển n8n hiệu quả.
Bất kỳ ai: Muốn cải thiện chất lượng mã và giảm thiểu lỗi trong các mẫu (template) n8n của mình.

Khi làm việc với Code node JavaScript trong n8n, việc gỡ lỗi và truy cập các đối tượng đầu vào phức tạp (như những đối tượng trả về từ node n8n khác hoặc các thao tác API) có thể rất khó khăn nếu không có tính năng tự động hoàn thành phù hợp. Workflow n8n cụ thể này giải quyết vấn đề bằng cách tận dụng các chú thích JSDoc, một phương pháp được sử dụng rộng rãi trong hệ sinh thái JavaScript.

Bằng cách xác định cấu trúc mong đợi của các đối tượng—chẳng hạn như đối tượng Workflow được truy xuất qua node API của n8n—bạn có thể cung cấp cho chức năng mã tích hợp sẵn của trình soạn thảo n8n các gợi ý kiểu dữ liệu (type hints) chặt chẽ. Điều này mang lại Intellisense ở cấp độ TypeScript, giúp việc viết, bảo trì và gỡ lỗi các đoạn script tùy chỉnh phức tạp trong workflow n8n của bạn trở nên hiệu quả và đáng tin cậy hơn nhiều. Kỹ thuật này vô giá để cải thiện tốc độ phát triển cho bất kỳ mẫu n8n mạnh mẽ nào.

Workflow n8n minh họa này sử dụng bốn bước chính để làm rõ kỹ thuật Intellisense:

1. Kích hoạt (Khi gửi biểu mẫu): Quá trình bắt đầu bằng việc sử dụng trigger Form n8n cơ bản, cho phép khởi chạy workflow n8n thủ công để kiểm thử.


2. Lấy dữ liệu Workflow (Get This Workflow): Node n8n của n8n được cấu hình để sử dụng thao tác get nhằm truy xuất toàn bộ cấu trúc siêu dữ liệu (metadata) của workflow n8n đang chạy. Đối tượng JSON phức tạp này được chuyển đến node n8n tiếp theo.


3. Áp dụng Intellisense (Code With Intellisense): Code node n8n này là phần trình diễn cốt lõi. Nó định nghĩa hai kiểu JSDoc (@typedef {Object} Node và / @typedef {Object} Workflow /). Sau đó, JSON đầu vào được ép kiểu bằng một chú thích JSDoc nội tuyến (/ @type {Workflow} /) lên biến wf. Hành động này cung cấp Intellisense hoàn hảo để truy cập các thuộc tính như wf.id, wf.name và lặp qua wf.nodes ngay trong Code node của n8n.


4. Hiển thị Kết quả (Display Results): Một Form n8n node cuối cùng hiển thị đầu ra đã được phân tích (trích xuất bằng Intellisense vừa được kích hoạt) ở định dạng HTML có tổ chức, chứng minh chức năng của node n8n trước đó.

Để cài đặt và sử dụng kỹ thuật phát triển mạnh mẽ này trong các mẫu n8n của riêng bạn:

1. Nhập: Sao chép JSON workflow n8n được cung cấp và dán nó vào phiên bản n8n của bạn thông qua tùy chọn 'Import from JSON'.


2. Thông tin xác thực API n8n: Node 'Get This Workflow' yêu cầu thông tin xác thực API n8n hợp lệ được cấu hình dưới tên n8n unio API v1. Đảm bảo bạn đã thiết lập khóa API đang hoạt động trong n8n.


3. Chạy: Thực thi trigger 'On form submission' của n8n hoặc kiểm tra workflow n8n theo cách thủ công. Hãy quan sát node 'Code With Intellisense' trong khi chỉnh sửa: di chuột qua hoặc nhập các thuộc tính đối tượng (như wf.) giờ đây sẽ hiển thị các gợi ý mã hữu ích.

On form submission (trigger n8n): Đóng vai trò là điểm bắt đầu để kiểm thử workflow n8n này. Đây là cơ chế trigger HTTP tiêu chuẩn của n8n.
Get This Workflow (node n8n): Sử dụng API nội bộ của n8n để truy xuất biểu diễn JSON hoàn chỉnh của workflow n8n đang thực thi. Nó cung cấp cấu trúc đối tượng phức tạp cần thiết cho ví dụ JSDoc.
Code With Intellisense (Code node n8n): Thành phần trung tâm. Nó định nghĩa các kiểu phức tạp bằng JSDoc, cụ thể là các kiểu Workflow và Node. Cấu hình chính bao gồm việc ép kiểu nội tuyến: const wf = / @type {Workflow} / ($input.first().json);, điều này rất cần thiết để kích hoạt tính năng Intellisense mạnh mẽ khi lập trình bên trong các mẫu n8n.

• Display Results (Form node n8n): Xuất kết quả thực thi của Code node n8n ra một trang HTML được định dạng đẹp mắt, cung cấp phản hồi trực quan ngay lập tức về sự thành công của logic workflow n8n.