使用代码节点
使用代码节点编写自定义 JavaScript 或 Python 并将其作为工作流程中的步骤运行。
提示
编码为 n8n
此页面提供有关代码节点的使用信息。有关 n8n 中编码的更多指南,请参阅 代码 部分。它包括:
提示
示例和模板
有关帮助您入门的使用示例和模板,请参阅 n8n 的 代码集成 页面。
提示
功能和功能项节点
代码节点替换了 n8n 0.198.0 中的功能和功能项节点。如果您使用的是旧版本的 n8n,您仍然可以查看 功能节点文档 和 功能项节点文档。
用途
如何使用代码节点。
选择模式
有两种模式:
- 对所有项目运行一次:这是默认设置。当工作流运行时,无论有多少输入项,代码节点中的代码都会执行一次。
- 为每个项目运行一次:如果您希望代码为每个输入项目运行,请选择此选项。
JavaScript
Code 节点支持 Node.js。
支持的 JavaScript 功能
代码节点支持:
- 承诺。您可以返回一个相应解决的承诺,而不是直接返回项目。
- 使用
console.log写入浏览器控制台。这对于调试工作流程和排除故障非常有用。
外部库
如果您自行托管 n8n,则可以在代码节点中导入和使用内置和外部 npm 模块。要了解如何启用外部模块,请参阅 在代码节点中启用模块 指南。
如果您使用n8n Cloud,则无法导入外部npm模块。 n8n 为您提供两个模块:
内置方法和变量
n8n 提供用于处理数据和访问 n8n 数据的内置方法和变量。请参阅 内置方法和变量 了解更多信息。
使用内置方法和变量的语法是 $variableName 或 $methodName()。在代码节点或表达式编辑器中键入 $ 以查看建议的方法和变量的列表。
键盘快捷键
代码节点编辑环境支持节省时间且有用的键盘快捷键,用于从自动完成到代码折叠和使用多光标的一系列操作。查看 键盘快捷键 的完整列表。
Python(Pyodide - 遗留)
警告
Feature availability 功能可用性
n8n 2.0 已移除 Pyodide。n8n 不再支持此功能。
n8n 在 n8n 1.0 中添加了 Python 支持。它不包含 Python 可执行文件。相反,n8n 使用 Pyodide 提供 Python 支持;Pyodide 是 CPython 到 WebAssembly 的移植版本。这将可用的 Python 包限制为 Pyodide 包含的软件包。n8n 首次使用时会自动下载软件包。
提示
比 JavaScript 慢
与 JavaScript 相比,代码节点处理 Python 所需的时间更长。这是由于额外的编译步骤造成的。
内置方法和变量
n8n 提供用于处理数据和访问 n8n 数据的内置方法和变量。请参阅 内置方法和变量 了解更多信息。
使用内置方法和变量的语法是 _variableName 或 _methodName()。在代码节点中键入 _ 以查看建议的方法和变量的列表。
键盘快捷键
代码节点编辑环境支持节省时间且有用的键盘快捷键,用于从自动完成到代码折叠和使用多光标的一系列操作。查看 键盘快捷键 的完整列表。
文件系统和 HTTP 请求
您无法访问文件系统或发出 HTTP 请求。请改用以下节点:
Python(本机)
提示
Feature availability 功能可用性
从 n8n 1.111.0 开始,可通过任务运行器使用原生 Python。该功能自 n8n 2 起稳定。
与 Pyodide 的主要区别:
- 本机 Python 在所有项目模式下仅支持
_items,在每项目模式下仅支持_item。它不支持其他 n8n 内置方法和变量。 - 在自托管上,本机 Python 支持从标准库和第三方导入本机 Python 模块(如果
n8nio/runners映像包含这些模块并明确将它们列入白名单)。有关详细信息,请参阅 为任务运行程序添加额外的依赖项。 - 默认情况下,原生 Python 拒绝不安全的内置函数。有关详细信息,请参阅 任务运行器环境变量。
- 与接受点访问表示法(例如
item.json.myNewField)的 Pyodide 不同,本机 Python 只接受括号访问表示法(例如item["json"]["my_new_field"])。可能存在其他细微的语法差异,其中 Pyodide 接受在本机 Python 中不合法的构造。 - 在 n8n 云上,代码节点的 Python 选项不允许用户导入任何 Python 库 - 无论是来自标准库还是第三方包。自托管用户可以找到包含外部库 为任务运行器添加额外依赖项 的设置说明。从长远来看,n8n 团队致力于允许用户使用任务运行程序通过任何第一方和第三方库安全地执行任意 Python 代码。
升级到本机 Python 是一项重大更改,因此您可能需要调整 Python 脚本以使用本机 Python 运行程序。
编码为 n8n
在 n8n 中有两个地方可以使用代码:代码节点和表达式编辑器。使用任一区域时,您需要了解一些关键概念,以及一些有助于完成常见任务的内置方法和变量。
关键概念
使用代码节点时,您需要了解以下概念:
内置方法和变量
n8n 包括内置方法和变量。这些为以下方面提供支持:
- 访问特定项目数据
- 访问有关工作流程、执行和 n8n 环境的数据
- 方便的变量来帮助处理数据和时间
请参阅 内置方法和变量 了解更多信息。