Workflow Core项目Elasticsearch插件使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00255/article/details/148491026

Workflow Core项目Elasticsearch插件使用指南

workflow-core workflow-core: 一个轻量级的、可嵌入的工作流引擎，针对.NET Standard设计，适用于需要跟踪状态的长期运行过程。项目地址: https://gitcode.com/gh_mirrors/wo/workflow-core

概述

在分布式工作流引擎Workflow Core中，Elasticsearch插件为工作流提供了强大的搜索和索引功能。通过该插件，开发者可以轻松实现对工作流数据及其状态的索引建立和高效查询，这对于构建复杂的企业级工作流系统尤为重要。

安装说明

通过NuGet安装

Elasticsearch插件可以通过以下两种方式安装：

使用NuGet包管理器控制台：

Install-Package WorkflowCore.Providers.Elasticsearch

使用.NET CLI：

dotnet add package WorkflowCore.Providers.Elasticsearch

安装完成后，项目中将会添加必要的Elasticsearch客户端依赖。

配置详解

基本配置

在服务配置阶段，需要通过UseElasticsearch扩展方法进行插件配置：

using Nest;

services.AddWorkflow(cfg =>
{
    // 其他配置...
    cfg.UseElasticsearch(
        new ConnectionSettings(new Uri("http://localhost:9200")),
        "workflow_index"
    );
});

配置参数说明：

ConnectionSettings: 指定Elasticsearch服务器地址和连接参数
index_name: 自定义索引名称，建议使用有意义的命名

高级配置建议

对于生产环境，建议配置：

连接池设置
请求超时时间
重试策略
认证信息

核心功能使用

搜索基础

通过注入ISearchIndex服务，可以使用Search方法执行查询：

Search(string terms, int skip, int take, params SearchFilter[] filters)

搜索参数详解

terms参数：
- 支持空格分隔的多个搜索词
- 空字符串将匹配所有文档
- 默认搜索字段包括：
  - 工作流引用(Reference)
  - 描述(Description)
  - 状态(Status)
  - 工作流定义(Workflow Definition)
分页参数：
- skip: 跳过的结果数量，用于分页
- take: 返回的结果数量，控制页面大小

自定义数据搜索

要使自定义数据可搜索，可以实现ISearchable接口：

public class MyData : ISearchable
{
    public string ProductName { get; set; }
    public string Category { get; set; }

    public IEnumerable<string> GetSearchTokens()
    {
        return new List<string>
        {
            ProductName,
            Category
        };
    }
}

实现后，这些字段将被包含在全文搜索范围内。

高级搜索技巧

过滤器应用

Workflow Core提供了多种强大的过滤器类型：

标量过滤器(ScalarFilter):

// 精确匹配引用值
ScalarFilter.Equals(x => x.Reference, "ORDER-12345")

日期范围过滤器(DateRangeFilter):

// 查询特定时间段内创建的工作流
DateRangeFilter.Between(x => x.CreateTime, startDate, endDate)

数值范围过滤器(NumericRangeFilter):

// 查询数值字段大于特定值
NumericRangeFilter.GreaterThan<MyData>(x => x.Value, 100)

状态过滤器(StatusFilter):

// 查询已完成的工作流
StatusFilter.Equals(WorkflowStatus.Complete)

组合查询示例

// 查询过去30天内创建、包含"订单"且状态为运行中的工作流
var results = searchIndex.Search(
    "订单",
    0,
    10,
    DateRangeFilter.After(x => x.CreateTime, DateTime.Now.AddDays(-30)),
    StatusFilter.Equals(WorkflowStatus.Runnable)
);