VWED_server/.cursor/rules/utils-and-components.mdc

153 lines
3.7 KiB
Plaintext
Raw Normal View History

2025-04-30 16:57:46 +08:00
---
description:
globs:
alwaysApply: false
---
# VWED任务模块 - 工具和组件
## 工具函数概述
VWED任务模块系统包含多种工具函数和辅助类用于支持系统的各项功能。这些工具函数被广泛应用于系统的各个模块中。
### 日志工具
系统使用自定义的日志工具,支持多级别日志记录和日志文件管理。
**相关文件**: [utils/logger.py](mdc:utils/logger.py)
**主要功能**:
- 多级别日志DEBUG, INFO, WARNING, ERROR, CRITICAL
- 日志文件轮转
- 格式化日志输出
- 控制台和文件双重输出
### 内置函数
系统提供了一系列内置函数,用于在任务执行过程中进行常见操作。
**相关文件**: [utils/built_in_functions.py](mdc:utils/built_in_functions.py)
**主要功能**:
- 字符串处理函数
- 日期时间处理函数
- 数学计算函数
- 数据转换函数
- 条件判断函数
### 加密工具
系统提供了加密和解密功能,用于敏感数据的保护。
**相关文件**: [utils/crypto_utils.py](mdc:utils/crypto_utils.py)
**主要功能**:
- AES加密/解密
- RSA加密/解密
- 哈希函数
- Base64编码/解码
- JWT令牌处理
### 组件管理器
组件管理器负责加载、注册和管理系统中的预设组件。
**相关文件**: [utils/component_manager.py](mdc:utils/component_manager.py)
**主要功能**:
- 组件注册与发现
- 组件参数验证
- 组件生命周期管理
- 组件依赖管理
### API响应工具
统一处理API响应格式的工具函数。
**相关文件**: [utils/api_response.py](mdc:utils/api_response.py)
**主要功能**:
- 标准响应格式化
- 错误响应处理
- 分页响应处理
### 数据验证工具
用于验证用户输入和数据完整性的工具。
**相关文件**: [utils/validator.py](mdc:utils/validator.py)
**主要功能**:
- 数据类型验证
- 格式验证
- 业务规则验证
- 跨字段验证
### 数据库迁移工具
用于管理数据库架构变更的工具。
**相关文件**: [utils/db_migration.py](mdc:utils/db_migration.py)
**主要功能**:
- 数据库架构迁移
- 版本控制
- 数据迁移
- 回滚功能
## 预设组件概述
预设组件是系统中预定义的功能模块,可以被用户在任务设计器中拖拽和配置,构建任务流程。
### 基础组件
系统提供了一系列基础组件,作为所有预设组件的基类。
**相关文件**: [components/base_components.py](mdc:components/base_components.py)
### 组件类型
系统中的预设组件主要分为以下几类:
1. **流程控制组件**
- 条件判断组件
- 循环组件
- 并行执行组件
- 延时组件
2. **数据处理组件**
- 数据转换组件
- 数据过滤组件
- 数据聚合组件
- 数据映射组件
3. **集成组件**
- AGV控制组件
- 站点管理组件
- 设备控制组件
- API调用组件
4. **业务组件**
- 库位操作组件
- 订单处理组件
- 库存管理组件
- 质检组件
### 组件配置
每个组件都有一系列可配置的参数,用户可以通过任务编辑界面进行配置。参数分为以下几类:
1. **基本参数**:组件的必要配置,如名称、描述等
2. **输入参数**:组件的输入数据配置
3. **输出参数**:组件处理后的输出数据配置
4. **高级参数**:特定组件的高级配置选项
### 组件执行机制
组件的执行由调度系统控制,具有以下特点:
1. **生命周期**:初始化 -> 参数验证 -> 执行 -> 清理
2. **异常处理**:每个组件都有自己的异常处理机制
3. **上下文传递**:组件之间通过上下文传递数据
4. **状态跟踪**:系统会记录每个组件的执行状态和结果