Elasticsearch多字段与条件式排序：Painless脚本实现指南

本文深入探讨了elasticsearch中基于复杂业务逻辑进行多字段排序的实现方法。通过painless脚本，我们展示了如何根据文档中`tags`字段的存在与否，灵活地调整`createdat`字段的排序顺序，即有标签的按`createdat`升序排列，无标签的按`createdat`降序排列，从而满足高级定制化排序需求。

在Elasticsearch中，常规的字段排序通常是直接对一个或多个字段进行升序（asc）或降序（desc）排列。然而，当业务需求涉及更复杂的条件逻辑时，例如根据某个字段的存在与否来决定另一个字段的排序方向，标准排序机制便无法直接满足。此时，Elasticsearch的脚本排序（Script-based Sorting）功能便显得尤为强大和灵活。

场景描述

假设我们有如下文档结构，包含 createdAt 日期字段和 tags 关键词数组字段：

doc1:
{
    "createdAt": "2022-11-25T09:45:00.000Z",
    "tags": [
      "Response Needed"
    ]
}
doc2 :
{
    "createdAt": "2022-11-24T09:45:00.000Z",
    "tags": [
      "Customer care","Response Needed"
    ]
}
doc3 :
{
    "createdAt": "2022-11-24T09:45:00.000Z",
    "tags": [

    ]
}

我们的排序需求是：

1. 首先，根据 tags 字段的存在与否进行排序：有 tags 的文档排在前面，无 tags 的文档排在后面。
2. 其次，对于有 tags 的文档，按 createdAt 字段的升序排列。
3. 最后，对于无 tags 的文档，按 createdAt 字段的降序排列。

解决方案：Painless脚本排序

为了实现上述复杂的条件式排序，我们将利用Painless脚本在排序阶段动态计算排序值。

1. 索引映射与数据准备

首先，我们需要创建一个索引并定义好字段映射，特别是 createdAt 为 date 类型，tags 为 keyword 类型，以便脚本能够正确访问和处理。

PUT idx_conditional_sort
{
  "mappings": {
    "properties": {
      "createdAt": {
        "type": "date"
      },
      "tags": {
        "type": "keyword"
      }
    }
  }
}

接下来，我们插入一些示例文档以供测试：

POST idx_conditional_sort/_doc
{
    "createdAt": "2022-11-25T09:45:00.000Z",
    "tags": [
      "Response Needed"
    ]
}

POST idx_conditional_sort/_doc
{
    "createdAt": "2022-11-24T09:45:00.000Z",
    "tags": [
      "Response 02"
    ]
}

POST idx_conditional_sort/_doc
{
    "createdAt": "2022-11-24T09:45:00.000Z",
    "tags": [
      "Customer care","Response Needed"
    ]
}

POST idx_conditional_sort/_doc
{
    "createdAt": "2022-11-26T09:45:00.000Z",
    "tags": []
}

POST idx_conditional_sort/_doc
{
    "createdAt": "2022-11-23T09:45:00.000Z",
    "tags": []
}

2. 实现脚本排序

我们将使用两个脚本作为排序数组中的元素，以实现多阶段和条件式排序。

排序逻辑分解：

XPaper Ai

AI撰写论文、开题报告生成、AI论文生成器尽在XPaper Ai论文写作辅助指导平台

下载

• 第一级排序（脚本1）： 用于区分有 tags 和无 tags 的文档。

  • 如果 tags 数组非空，脚本返回一个较高的值（例如 1）。
  • 如果 tags 数组为空，脚本返回一个较低的值（例如 0）。
  • 对这个脚本的结果进行降序（desc）排列，确保有 tags 的文档优先。

• 第二级排序（脚本2）： 用于根据 tags 状态对 createdAt 进行条件式排序。

  • 如果 tags 数组非空：直接返回 createdAt 的毫秒时间戳，这样在整体升序排列时，会实现 createdAt 的升序。
  • 如果 tags 数组为空：返回 createdAt 毫秒时间戳的负值，这样在整体升序排列时，会实现 createdAt 的降序（因为负值越大，实际时间越早）。

完整的查询语句：

GET idx_conditional_sort/_search
{
  "sort": [
    {
      "_script": {
        "type": "number",
        "script": {
          "lang": "painless",
          "source": """
            // 脚本1：根据tags是否存在进行分组
            // 返回 1 表示有标签，返回 0 表示无标签
            return doc['tags.keyword'].size() > 0 ? 1 : 0;
          """
        },
        "order": "desc" // 降序排列，确保有标签的文档排在前面
      }
    },
    {
      "_script": {
        "type": "number",
        "script": {
          "lang": "painless",
          "source": """
            // 脚本2：根据tags状态对createdAt进行条件式排序
            long createdAtMillis = doc['createdAt'].value.toInstant().toEpochMilli();
            if (doc['tags.keyword'].size() > 0) {
              // 如果有标签，按createdAt升序排列，直接返回时间戳
              return createdAtMillis;
            } else {
              // 如果无标签，按createdAt降序排列，返回时间戳的负值
              // 这样在整体升序排序时，负值越大（绝对值越小），实际时间越晚，达到降序效果
              return -createdAtMillis;
            }
          """
        },
        "order": "asc" // 升序排列，配合脚本内部逻辑实现条件式排序
      }
    }
  ]
}

3. 结果解读

执行上述查询后，Elasticsearch将返回如下结果（部分）：

{
  "took": ...,
  "timed_out": false,
  "_shards": ...,
  "hits": {
    "total": { "value": 5, "relation": "eq" },
    "max_score": null,
    "hits": [
      {
        "_index": "idx_conditional_sort",
        "_id": "t42r-oQBEoAIompjS0Xh",
        "_score": null,
        "_source": {
          "createdAt": "2022-11-24T09:45:00.000Z",
          "tags": [ "Response 02" ]
        },
        "sort": [ 1, 1669283100000 ] // 标签存在，createdAt 升序
      },
      {
        "_index": "idx_conditional_sort",
        "_id": "uI2r-oQBEoAIompjS0Xj",
        "_score": null,
        "_source": {
          "createdAt": "2022-11-24T09:45:00.000Z",
          "tags": [ "Customer care", "Response Needed" ]
        },
        "sort": [ 1, 1669283100000 ] // 标签存在，createdAt 升序
      },
      {
        "_index": "idx_conditional_sort",
        "_id": "sY2r-oQBEoAIompjS0Xg",
        "_score": null,
        "_source": {
          "createdAt": "2022-11-25T09:45:00.000Z",
          "tags": [ "Response Needed" ]
        },
        "sort": [ 1, 1669369500000 ] // 标签存在，createdAt 升序
      },
      {
        "_index": "idx_conditional_sort",
        "_id": "uY2r-oQBEoAIompjS0Xk",
        "_score": null,
        "_source": {
          "createdAt": "2022-11-26T09:45:00.000Z",
          "tags": []
        },
        "sort": [ 0, -1669455900000 ] // 标签不存在，createdAt 降序（负值升序）
      },
      {
        "_index": "idx_conditional_sort",
        "_id": "uo2r-oQBEoAIompjS0Xl",
        "_score": null,
        "_source": {
          "createdAt": "2022-11-23T09:45:00.000Z",
          "tags": []
        },
        "sort": [ 0, -1669196700000 ] // 标签不存在，createdAt 降序（负值升序）
      }
    ]
  }
}

从 hits 数组中可以看到，文档首先根据 tags 字段的存在性被分组（sort 数组的第一个元素 1 表示有标签，0 表示无标签）。

• 有标签的文档（sort 数组第一个元素为 1）被排在前面，并且它们内部按照 createdAt 的时间戳升序排列（1669283100000 在 1669369500000 之前）。
• 无标签的文档（sort 数组第一个元素为 0）被排在后面，并且它们内部按照 createdAt 的时间戳降序排列（-1669455900000 对应 2022-11-26，-1669196700000 对应 2022-11-23。由于是负值升序，-1669455900000 比 -1669196700000 小，所以 2022-11-26 的文档排在 2022-11-23 的文档之前，实现了降序）。

注意事项与最佳实践

1. 性能考量： 脚本排序通常比字段排序开销更大，因为它需要在每个文档上执行脚本。对于大规模数据集，这可能导致性能下降。如果可能，应尽量通过索引设计或使用运行时字段（runtime fields）来避免复杂的脚本排序。
2. 脚本缓存： Elasticsearch 会缓存编译后的脚本，以减少重复执行的开销。因此，相同的脚本多次执行时，性能会更好。
3. 字段类型： 确保在脚本中访问的字段具有正确的类型。例如，doc['tags.keyword'] 访问的是 keyword 类型的 tags 字段。对于日期字段，doc['createdAt'].value.toInstant().toEpochMilli() 是获取其毫秒时间戳的常用方式。
4. Painless语法： Painless是Elasticsearch专用的安全高效的脚本语言。熟悉其语法和API是编写有效脚本的关键。
5. 替代方案： 在某些简单场景下，可以考虑使用 missing 参数或 nested 字段来处理缺失值或数组字段的排序，但对于本例中这种复杂的条件式逻辑，脚本排序是目前最直接和强大的方法。

总结

通过Painless脚本排序，Elasticsearch提供了极高的灵活性来处理复杂的、基于条件判断的排序需求。尽管脚本排序会带来一定的性能开销，但在业务逻辑无法通过标准字段排序实现的场景下，它是一个不可或缺的强大工具。理解其工作原理和最佳实践，能够帮助开发者构建出满足多样化需求的搜索功能。