n8n 中文文档

节点版本控制

n8n 支持节点版本控制。您可以通过引入新版本对现有节点进行更改,而不会破坏现有行为。

请注意 n8n 如何决定加载哪个节点版本:

  • 如果用户使用版本 1 构建并保存工作流,n8n 将继续在该工作流中使用版本 1,即使您创建并发布节点的版本 2。
  • 当用户创建新工作流并浏览节点时,n8n 始终加载节点的最新版本。

提示

Versioning type restricted by node style 受节点样式限制的版本控制类型

如果使用声明式样式构建节点,则无法使用完整版本控制。

轻型版本控制

这适用于所有节点类型。

一个节点可以包含多个版本,允许小的版本增量而无需代码重复。要使用此功能:

  1. 将主 version 参数更改为数组,并添加您的版本号,包括现有版本。
  2. 然后,您可以在任何对象的 displayOptions 中使用 @version 访问版本参数(以控制 n8n 显示对象的版本)。您还可以使用 const nodeVersion = this.getNode().typeVersion; 从函数查询版本。

举个例子,假设您想从声明性节点教程向 NasaPics 节点添加版本控制,然后配置一个资源,以便 n8n 仅在节点的版本 2 中显示它。在您的基本 NasaPics.node.ts 文件中:

{
    displayName: 'NASA Pics',
    name: 'NasaPics',
    icon: 'file:nasapics.svg',
    // 列出可用版本
    version: [1,2,3],
    // 这里有更多基本参数
    properties: [
        // 添加仅在版本2中显示的资源
        {
            displayName: 'Resource name',
            // 更多资源参数
            displayOptions: {
                show: {
                    '@version': 2,
                },
            },
        },
    ],
}

基于功能的版本控制

功能标志可让您根据与节点版本关联的命名功能来控制参数可见性和执行逻辑。

定义特征

将 features 对象添加到节点类型描述中。每个功能都使用 @version 条件来指定启用它的版本:

{
    version: [2, 2.1, 2.2, 2.3, 2.4],
    features: {
        useNewApi: { '@version': [{ _cnd: { gte: 2.2 } }] },
        useLegacyAuth: { '@version': [{ _cnd: { lte: 2.1 } }] },
        useSpecialMode: { '@version': [2] },
    },
    // More basic parameters here
}

可用条件:gte、lte、gt、lt。传递一个简单的版本号来匹配特定版本。

在 displayOptions 中使用 @feature

在 displayOptions 中使用 @feature 来根据功能标志控制参数可见性:

{
    displayName: 'New API Field',
    name: 'newApiField',
    type: 'string',
    displayOptions: {
        show: {
            '@feature': ['useNewApi'],
        },
    },
}

要在启用 not 不 功能时显示参数,请使用条件语法:

displayOptions: {
    show: {
        '@feature': [{ _cnd: { not: 'useNewApi' } }],
    },
}

您可以将 @feature 与其他显示条件结合使用:

displayOptions: {
    show: {
        resource: ['myResource'],
        '@feature': [{ _cnd: { eq: 'useNewApi' } }],
    },
}

检查代码 中的功能

在执行上下文中使用 this.isNodeFeatureEnabled()(例如 IExecuteFunctions 或 IWebhookFunctions):

if (this.isNodeFeatureEnabled('useNewApi')) {
    // Process with new API
} else {
    // Process with legacy API
}

完整版本

这不适用于声明式节点。

例如,请参阅 Mattermost 节点{:target=_blank .external-link}。

完整版本控制摘要:

  • 基础节点文件应该扩展 NodeVersionedType 而不是 INodeType。
  • 基础节点文件应该包含描述,包括 defaultVersion(通常是最新版本)、其他基本节点元数据(如名称)和版本列表。它不应该包含任何节点功能。
  • n8n 建议使用 v1、v2 等作为版本文件夹名称。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。