Ever-Gauzy 项目中时间跟踪实体的软删除功能实现解析

背景与需求分析

在现代企业管理系统中，数据安全性和可恢复性至关重要。Ever-Gauzy 作为一款开源的企业管理平台，其时间跟踪模块需要完善的软删除机制来保护用户数据。传统硬删除会直接物理移除数据库记录，而软删除则通过标记状态实现逻辑删除，既满足业务需求又保留数据可追溯性。

技术实现方案

核心设计思路

1. 实体状态标记：为时间跟踪相关实体（时间日志、时间段、活动记录等）添加 deletedAt 字段，类型为时间戳
2. 查询过滤：所有查询操作自动排除已标记删除的记录
3. 级联处理：建立实体间的级联软删除关系
4. 恢复机制：提供专门的恢复接口还原被删除记录

具体实现步骤

// 基础实体定义示例
@Entity()
export class TimeLog extends SoftDeletableBaseEntity {
    @DeleteDateColumn({ type: 'timestamptz' })
    deletedAt?: Date;
    
    // 其他业务字段...
}

// 服务层删除操作示例
async softDelete(id: string): Promise<void> {
    await this.repository.softDelete(id);
    this.eventBus.publish(new TimeLogDeletedEvent(id));
}

关键技术点

1. TypeORM 软删除集成：

   • 利用 @DeleteDateColumn 装饰器自动管理删除标记
   • 通过 softDelete/restore 方法实现状态变更
   • 自定义 Repository 实现全局查询过滤

2. 事件驱动架构：

   • 删除操作触发领域事件
   • 订阅者处理相关业务逻辑（如更新统计信息）

3. 事务一致性：

   • 采用单元工作模式确保多实体操作原子性
   • 实现补偿事务机制处理异常场景

性能优化考量

1. 索引策略：

   • 为 deletedAt 字段建立部分索引（WHERE deletedAt IS NULL）
   • 高频查询字段组合索引优化

2. 批量处理：

   • 实现批量软删除接口减少数据库压力
   • 后台任务定期清理过期删除记录

业务价值体现

1. 合规性保障：满足数据留存法规要求
2. 误操作防护：提供数据恢复能力
3. 审计追踪：完整记录数据生命周期
4. 系统稳定性：避免外键约束导致的删除异常

最佳实践建议

1. 定期归档长期处于删除状态的记录
2. 实现删除确认和二次验证机制
3. 为敏感操作记录详细审计日志
4. 提供可视化回收站管理界面

该实现已在 Ever-Gauzy 代码库通过完整测试验证，相关提交覆盖了从实体定义到业务逻辑的全套解决方案，为时间跟踪模块提供了企业级的数据安全保障。