HsxWorkFlow 内置 Redis 操作封装，提供缓存、队列、计数等功能。

概览

RedisHandler

RedisHandler 是 Redis 操作的封装类。

获取 Redis 处理器

from hsxworkflow.Utils.redis_handler import get_redis_handler

rdb = get_redis_handler()

HsxWorkFlow 提供了基于 FastAPI + Socket.IO 的 Web 管理界面，支持 RESTful API 和 WebSocket 实时通信。本文档详细介绍 Web 管理界面的使用方法。

概览

启动 Web 服务

基本启动

from hsxworkflow import WorkflowManager, WorkRegisterHandler

wf = WorkRegisterHandler(step_key="demo")

@wf.register_class()
class DemoWorkFlow(StepActionHandler):
    @wf.step(sort=1)
    def hello(self):
        return self.set_success()

manager = WorkflowManager()
manager.register_object(wf)
manager.run_app()  # 访问 http://localhost:5050

HsxWorkFlow 基于 APScheduler 提供强大的定时调度功能，支持 Cron 表达式、间隔执行和一次性任务。

概览

WorkflowScheduler

WorkflowScheduler 是工作流调度器的核心类，封装了 APScheduler 的功能。

创建调度器

from hsxworkflow import WorkflowManager
from hsxworkflow.scheduler import WorkflowScheduler

manager = WorkflowManager()
manager.register_object(wf)

scheduler = WorkflowScheduler(manager)

本文档将带你快速上手 HsxWorkFlow 框架，从环境准备到第一个工作流的运行。

环境准备

系统要求

• Python: >= 3.10
• 操作系统: Windows / Linux / macOS
• 包管理器: uv（推荐）或 pip

HsxWorkFlow 支持五种执行模式，满足不同场景的需求。本文档详细介绍每种执行模式的使用方法和适用场景。

模式概览

本文档详细介绍 HsxWorkFlow 的系统整体架构设计、分层架构和模块关系。

架构概览

HsxWorkFlow 采用分层架构设计，从上到下分为客户端层、Web 服务层、管理层、执行引擎层、注册层、集成层和工具层。

分层架构详解

1. 客户端层

职责: 提供用户交互界面和客户端工具。

组件:

• Web 管理界面: 基于 HTML/JavaScript 的 Web UI，提供可视化的工作流管理界面
• REST API 客户端: 支持 cURL、Postman 等工具调用 RESTful API
• WebSocket 客户端: 支持 Socket.IO 协议的客户端，用于实时通信

本文档总结了 HsxWorkFlow 的开发建议和常见问题的解决方案。

开发建议

1. 合理使用重试机制

# ✅ 合理使用重试（外部 API 调用）
@wf.step(sort=1, retry=3, retry_interval=2)
def call_external_api(self):
    result = requests.get("https://api.example.com")
    if result.ok:
        return self.set_success(data=result.json())
    return self.set_failure(message="API 调用失败")

# ❌ 不合理使用重试（逻辑错误）
@wf.step(sort=1, retry=3, retry_interval=2)
def validate_input(self):
    if not self.is_valid():
        return self.set_failure(message="输入无效")
    return self.set_success()

HsxWorkFlow 的核心引擎由 Code 模块提供，包含 StepActionHandler、WorkFlowHandler 和 WorkRegisterHandler 三个核心组件。本文档详细介绍这些组件的实现原理。

模块结构

src/hsxworkflow/Code/
├── StepAction.py            # 步骤执行处理器（基类）
├── StepActionUtils.py       # 状态枚举、结果封装、线程控制
├── WorkFlowHandler.py       # 执行模式实现
└── WorkRegister.py          # 装饰器注册系统

本文档介绍 HsxWorkFlow 框架的核心概念，包括 WorkRegisterHandler、StepActionHandler 和 WorkflowManager 三个核心组件。

概览

HsxWorkFlow 的核心架构由三个主要组件构成：

1. WorkRegisterHandler - 工作流注册器，负责收集工作流定义
2. WorkflowManager - 工作流管理器，负责注册、启动、停止工作流
3. StepActionHandler - 步骤处理器，所有工作流类的基类

HsxWorkFlow 集成 DrissionPage 实现浏览器自动化操作，支持 Chromium 的页面操作、数据抓取等功能。

概览

DriverClient

DriverClient 是 DrissionPage 的客户端封装类。

创建客户端

from hsxworkflow.DP.DPClient import DriverClient

driver = DriverClient()