Sparkdo.Uow 1.0.1

Sparkdo.Uow

Sparkdo 工作单元实现库，提供完整的工作单元模式实现。

功能特性

• 完整的工作单元模式实现
• 事务管理支持
• 数据库 API 管理
• 事件发布机制
• 与 Sparkdo 框架无缝集成
• 支持嵌套工作单元
• 支持工作单元保留和恢复

安装

<PackageReference Include="Sparkdo.Uow" Version="x.x.x" />

核心组件

UnitOfWork

工作单元核心实现，提供工作单元模式的基本功能：

• Id: 工作单元唯一标识符
• Options: 配置选项
• Outer: 外层工作单元引用
• SaveChangesAsync(): 保存更改
• CompleteAsync(): 完成工作单元（提交事务）
• RollbackAsync(): 回滚工作单元
• Reserve(): 保留工作单元
• 事件：Failed（失败事件）、Disposed（释放事件）

DefaultUnitOfWorkManager

默认工作单元管理器实现，用于创建和管理工作单元：

• Current: 获取当前工作单元
• BeginAsync(): 开始新的工作单元
• ReserveAsync(): 保留工作单元
• BeginReserved(): 开始已保留的工作单元
• TryBeginReserved(): 尝试开始已保留的工作单元

UnitOfWorkOptions

工作单元配置选项实现：

• IsTransactional: 是否启用事务
• IsolationLevel: 事务隔离级别
• Timeout: 超时时间（毫秒）

扩展类

• UnitOfWorkExtensions: 工作单元扩展方法
• UnitOfWorkManagerExtensions: 工作单元管理器扩展方法
• UnitOfWorkHelper: 工作单元助手类

拦截器

• UnitOfWorkInterceptor: 工作单元拦截器，用于自动管理工作单元
• UnitOfWorkInterceptorConfigure: 工作单元拦截器配置

模块配置

• SparkdoUnitOfWorkModule: 工作单元模块配置

使用示例

基本用法

public class MyService
{
    private readonly IUnitOfWorkManager _unitOfWorkManager;

    public MyService(IUnitOfWorkManager unitOfWorkManager)
    {
        _unitOfWorkManager = unitOfWorkManager;
    }

    [UnitOfWork]
    public async Task DoWorkAsync()
    {
        // 在事务中执行操作
        // 工作单元会自动提交或回滚
    }

    public async Task DoWorkManuallyAsync()
    {
        using var uow = await _unitOfWorkManager.BeginAsync(true);
        try
        {
            // 执行操作
            await uow.CompleteAsync();
        }
        catch
        {
            await uow.RollbackAsync();
            throw;
        }
    }
}

配置选项

// 在 Startup.cs 或 Program.cs 中配置
services.Configure<SparkdoUnitOfWorkDefaultOptions>(options =>
{
    options.TransactionBehavior = UnitOfWorkTransactionBehavior.Enabled;
    options.IsolationLevel = IsolationLevel.ReadCommitted;
    options.Timeout = 30000; // 30秒
});

扩展性

该库提供了完整的工作单元实现，可以通过以下方式扩展：

1. 实现自定义的 IDatabaseApi 和 ITransactionApi 来提供数据库和事务操作
2. 实现自定义的 IUnitOfWorkEventPublisher 来处理工作单元事件发布
3. 通过自定义特性或拦截器来增强工作单元功能

代码结构说明

本项目包含以下主要组件：

核心实现

• UnitOfWork: 工作单元核心实现
• DefaultUnitOfWorkManager: 默认工作单元管理器实现
• UnitOfWorkOptions: 工作单元配置选项实现
• SparkdoUnitOfWorkDefaultOptions: 工作单元默认配置选项

扩展类

• UnitOfWorkExtensions: 工作单元扩展方法
• UnitOfWorkManagerExtensions: 工作单元管理器扩展方法
• UnitOfWorkHelper: 工作单元助手类

拦截器

• UnitOfWorkInterceptor: 工作单元拦截器
• UnitOfWorkInterceptorConfigure: 工作单元拦截器配置

辅助类

• ChildUnitOfWork: 子工作单元实现
• AmbientUnitOfWork: 环境工作单元实现
• EventOrderGenerator: 事件顺序生成器
• AlwaysDisableTransactionsUnitOfWorkManager: 总是禁用事务的工作单元管理器

模块配置

• SparkdoUnitOfWorkModule: 工作单元模块配置

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。