Elsa Workflows 3.0 中如何监听活动状态变更事件

在Elsa Workflows 3.0工作流引擎中，开发者经常需要实时获取工作流和活动的执行状态，以便将这些状态同步到业务系统中。本文将详细介绍如何在Elsa 3.0中通过中间件和事件订阅两种方式来实现这一需求。

活动执行中间件监听方式

Elsa提供了IActivityExecutionMiddleware接口，允许开发者在活动执行前后插入自定义逻辑。这种方式适合需要精细控制每个活动执行过程的场景。

public class ActivityStatusTrackingMiddleware : IActivityExecutionMiddleware
{
    public async ValueTask InvokeAsync(ActivityExecutionContext context, Func<ValueTask> next)
    {
        // 活动执行前记录状态
        LogActivityStatus(context, "Starting");
        
        try
        {
            await next();
            
            // 活动成功执行后记录状态
            LogActivityStatus(context, "Completed");
        }
        catch (Exception ex)
        {
            // 活动执行失败记录状态
            LogActivityStatus(context, "Failed");
            throw;
        }
    }

    private void LogActivityStatus(ActivityExecutionContext context, string status)
    {
        Console.WriteLine($"Activity {context.ActivityId} ({context.Activity.Type}) changed to {status} at {DateTime.Now}");
        // 这里可以添加将状态发送到业务系统的逻辑
    }
}

注册中间件需要在服务配置中添加：

services.AddElsa(elsa => elsa
    .UseActivityExecutionMiddleware<ActivityStatusTrackingMiddleware>()
);

事件订阅方式

Elsa 3.0内部使用MediatR库发布各种事件，开发者可以订阅这些事件来获取状态变更通知。这种方式更适合解耦的场景，不需要修改工作流执行管道。

首先创建事件处理器：

public class ActivityStatusChangedHandler : 
    INotificationHandler<ActivityExecuting>,
    INotificationHandler<ActivityExecuted>,
    INotificationHandler<ActivityFailed>
{
    public Task Handle(ActivityExecuting notification, CancellationToken cancellationToken)
    {
        TrackStatus(notification.ActivityExecutionContext, "Executing");
        return Task.CompletedTask;
    }

    public Task Handle(ActivityExecuted notification, CancellationToken cancellationToken)
    {
        TrackStatus(notification.ActivityExecutionContext, "Completed");
        return Task.CompletedTask;
    }

    public Task Handle(ActivityFailed notification, CancellationToken cancellationToken)
    {
        TrackStatus(notification.ActivityExecutionContext, "Failed");
        return Task.CompletedTask;
    }

    private void TrackStatus(ActivityExecutionContext context, string status)
    {
        Console.WriteLine($"Activity {context.ActivityId} status changed to {status}");
        // 发送状态到业务系统
    }
}

然后注册事件处理器：

services.AddNotificationHandlersFrom<ActivityStatusChangedHandler>();

两种方式的对比

1. 中间件方式：

   • 优点：执行顺序可控，可以修改执行上下文
   • 缺点：需要处理异常情况，代码相对复杂

2. 事件订阅方式：

   • 优点：解耦，只需关注感兴趣的事件
   • 缺点：无法修改执行上下文，对执行流程无控制权

实际应用建议

对于大多数业务系统集成场景，推荐使用事件订阅方式，因为它更简单且不会影响工作流的正常执行。只有当需要在活动执行过程中干预或修改上下文时，才考虑使用中间件方式。

无论采用哪种方式，都应该注意：

1. 状态跟踪逻辑应该尽量轻量，避免影响工作流性能
2. 考虑添加重试机制，确保状态同步的可靠性
3. 对于高并发场景，建议使用队列异步处理状态同步

通过合理利用Elsa提供的这些扩展点，开发者可以轻松实现工作流状态与业务系统的实时同步，构建更加健壮的业务流程管理系统。