n8n 中文文档

使用 JMESPath 查询 JSON

JMESPath{:target=_blank .external-link} 是一种用于 JSON 的查询语言,您可以使用它从 JSON 文档中提取和转换元素。有关如何使用 JMESPath 的完整详细信息,请参阅 JMESPath 文档{:target=_blank .external-link}。

jmespath() 方法

n8n 提供了一个自定义方法 jmespath()。使用此方法可以使用 JMESPath 查询语言对 JSON 对象执行搜索。

基本语法是:

$jmespath(object, searchString)

提示

仅支持 JavaScript

Python Code 节点不提供 $jmespath()。若要在 Python 中获得相同结果,请改用标准 Python。下面每个示例都包含 Python 版本。

为了帮助理解该方法的作用,这里是等效的较长 JavaScript:

var jmespath = require('jmespath');
jmespath.search(object, searchString);

提示

Expressions must be single-line 表达式必须是单行

较长的代码示例在表达式中不起作用,因为它们必须是单行。

object 是一个 JSON 对象,例如前一个节点的输出。searchString 是用 JMESPath 查询语言编写的表达式。JMESPath 规范{:target=_blank .external-link}提供了支持的表达式列表,而他们的教程和示例{:target=_blank .external-link}提供了交互式示例。

警告

Search parameter order 搜索参数顺序

JMESPath 规范 中的示例遵循模式 search(searchString, object)。 n8n 使用的 JMESPath JavaScript 库 支持 search(object, searchString)。这意味着当使用 JMESPath 文档中的示例时,您可能需要更改搜索函数参数的顺序。

常见任务

本节提供了一些常见操作的示例。更多示例和详细指导可在 JMESPath 自己的文档{:target=_blank .external-link}中找到。

在尝试这些示例时,您需要将代码节点模式设置为为每个项目运行一次。

将 JMESPath 表达式应用于具有投影 的元素集合

来自 JMESPath 投影文档{:target=_blank .external-link}:

投影是 JMESPath 的关键功能之一。使用它将表达式应用于元素集合。JMESPath 支持五种投影:

  • 列表投影
  • 切片投影
  • 对象投影
  • 展平投影
  • 过滤投影

以下示例显示了列表、切片和对象投影的基本用法。有关每种投影类型的详细说明和更多示例,请参阅 JMESPath 投影文档{:target=_blank .external-link}。

给定来自 webhook 节点的此 JSON:

[
  {
    "headers": {
      "host": "n8n.instance.address",
      ...
    },
    "params": {},
    "query": {},
    "body": {
      "people": [
        {
          "first": "James",
          "last": "Green"
        },
        {
          "first": "Jacob",
          "last": "Jones"
        },
        {
          "first": "Jayden",
          "last": "Smith"
        }
      ],
      "dogs": {
        "Fido": {
          "color": "brown",
          "age": 7
        },
        "Spot": {
          "color": "black and white",
          "age": 5
        }
      }
    }
  }
]

检索所有人的名字的列表{:target=_blank .external-link}:

Expressions (JavaScript)

{{$jmespath($json.body.people, "[*].first" )}}
// Returns ["James", "Jacob", "Jayden"]

Code node (JavaScript)

let firstNames = $jmespath($json.body.people, "[*].first" )
return {firstNames};
/* Returns:
[
    {
        "firstNames": [
            "James",
            "Jacob",
            "Jayden"
        ]
    }
]
*/

Code node (Python)

people = _item["json"]["body"]["people"]
first_names = [person["first"] for person in people]
return {"firstNames": first_names}
"""
Returns:
[
    {
        "firstNames": [
            "James",
            "Jacob",
            "Jayden"
        ]
    }
]
"""

获取名字的切片{:target=_blank .external-link}:

Expressions (JavaScript)

{{$jmespath($json.body.people, "[:2].first")}}
// Returns ["James", "Jacob"]

Code node (JavaScript)

let firstTwoNames = $jmespath($json.body.people, "[:2].first");
return {firstTwoNames};
/* Returns:
[
    {
        "firstNames": [
            "James",
            "Jacob",
            "Jayden"
        ]
    }
]
*/

Code node (Python)

people = _item["json"]["body"]["people"]
first_two_names = [person["first"] for person in people[:2]]
return {"firstTwoNames": first_two_names}
"""
Returns:
[
    {
        "firstTwoNames": [
        "James",
        "Jacob"
        ]
    }
]
"""

使用对象投影{:target=_blank .external-link}获取狗的年龄列表:

Expressions (JavaScript)

{{$jmespath($json.body.dogs, "*.age")}}
// Returns [7,5]

Code node (JavaScript)

let dogsAges = $jmespath($json.body.dogs, "*.age");
return {dogsAges};
/* Returns:
[
    {
        "dogsAges": [
            7,
            5
        ]
    }
]
*/

Code node (Python)

dogs = _item["json"]["body"]["dogs"]
dogs_ages = [dog["age"] for dog in dogs.values()]
return {"dogsAges": dogs_ages}
"""
Returns:
[
    {
        "dogsAges": [
            7,
            5
        ]
    }
]
"""

选择多个元素并创建新列表或对象

使用 Multiselect{:target=_blank .external-link} 从 JSON 对象中选择元素并将它们组合到新的列表或对象中。

给定来自 webhook 节点的 JSON:

[
  {
    "headers": {
      "host": "n8n.instance.address",
      ...
    },
    "params": {},
    "query": {},
    "body": {
      "people": [
        {
          "first": "James",
          "last": "Green"
        },
        {
          "first": "Jacob",
          "last": "Jones"
        },
        {
          "first": "Jayden",
          "last": "Smith"
        }
      ],
      "dogs": {
        "Fido": {
          "color": "brown",
          "age": 7
        },
        "Spot": {
          "color": "black and white",
          "age": 5
        }
      }
    }
  }
]

使用多选列表获取名字和姓氏并创建包含这两个名字的新列表:

Expressions (JavaScript)

{{$jmespath($json.body.people, "[].[first, last]")}}
// Returns [["James","Green"],["Jacob","Jones"],["Jayden","Smith"]]

Code node (JavaScript)

let newList = $jmespath($json.body.people, "[].[first, last]");
return {newList};
/* Returns:
[
    {
        "newList": [
            [
                "James",
                "Green"
            ],
            [
                "Jacob",
                "Jones"
            ],
            [
                "Jayden",
                "Smith"
            ]
        ]
    }
]
*/

Code node (Python)

people = _item["json"]["body"]["people"]
new_list = [[person["first"], person["last"]] for person in people]
return {"newList": new_list}
"""
Returns:
[
    {
        "newList": [
            [
                "James",
                "Green"
            ],
            [
                "Jacob",
                "Jones"
            ],
            [
                "Jayden",
                "Smith"
            ]
        ]
    }
]
"""

表达式中箭头函数的替代方案

例如,通过从 Code 节点返回以下代码来生成一些输入数据:

return[
  {
    "json": {
      "num_categories": "0",
      "num_products": "45",
      "category_id": 5529735,
      "parent_id": 1407340,
      "pos_enabled": 1,
      "pos_favorite": 0,
      "name": "HP",
      "description": "",
      "image": ""
    }
  },
  {
    "json": {
      "num_categories": "0",
      "num_products": "86",
      "category_id": 5529740,
      "parent_id": 1407340,
      "pos_enabled": 1,
      "pos_favorite": 0,
      "name": "Lenovo",
      "description": "",
      "image": ""
    }
  }
]

您可以执行“查找名为 Lenovo 的项目并告诉我其类别 ID”之类的搜索。

{{ $jmespath($("Code").all(), "[?json.name=='Lenovo'].json.category_id") }}

相关资源

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