Sparkdo.StateChecking 1.0.1

Sparkdo.StateChecking

Sparkdo 状态检查库，提供简单的状态检查功能，用于检查对象是否处于启用状态。

功能特性

• 简单的状态检查接口和实现
• 支持批量状态检查
• 可序列化的状态检查器
• 与 Sparkdo 框架无缝集成

安装

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

核心组件

状态检查接口

• ISimpleStateChecker<TState>: 简单状态检查器接口
• ISimpleBatchStateChecker<TState>: 批量状态检查器接口
• IWithSimpleStateCheckers<TState>: 带有状态检查器的对象接口

状态检查管理器

• ISimpleStateCheckerManager<TState>: 状态检查管理器接口
• DefaultSimpleStateCheckerManager<TState>: 默认状态检查管理器实现

状态检查序列化

• ISimpleStateCheckerSerializer: 状态检查器序列化接口
• DefaultSimpleStateCheckerSerializer: 默认状态检查器序列化实现
• ISimpleStateCheckerSerializerContributor: 状态检查器序列化贡献者接口

配置

• SparkdoSimpleStateCheckerOptions<TState>: 状态检查器选项
• SparkdoStateCheckingModule: 状态检查模块配置

使用示例

定义带有状态检查的对象

public class MyEntity : IWithSimpleStateCheckers<MyEntity>
{
    public List<ISimpleStateChecker<MyEntity>> StateCheckers { get; } = new();
    
    public string Name { get; set; }
}

实现自定义状态检查器

public class MyStateChecker : ISimpleStateChecker<MyEntity>
{
    public async Task<bool> IsEnabledAsync(SimpleStateCheckerContext<MyEntity> context)
    {
        // 实现状态检查逻辑
        return true;
    }
}

使用状态检查管理器

public class MyService
{
    private readonly ISimpleStateCheckerManager<MyEntity> _stateCheckerManager;
    
    public MyService(ISimpleStateCheckerManager<MyEntity> stateCheckerManager)
    {
        _stateCheckerManager = stateCheckerManager;
    }
    
    public async Task<bool> IsEntityEnabledAsync(MyEntity entity)
    {
        return await _stateCheckerManager.IsEnabledAsync(entity);
    }
}

扩展性

该库提供了完整的状态检查实现，可以通过以下方式扩展：

1. 实现自定义的状态检查器
2. 实现自定义的批量状态检查器
3. 实现自定义的状态检查器序列化贡献者
4. 通过配置选项添加全局状态检查器

代码结构说明

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

核心接口

• ISimpleStateChecker<TState>: 简单状态检查器接口
• ISimpleBatchStateChecker<TState>: 批量状态检查器接口
• IWithSimpleStateCheckers<TState>: 带有状态检查器的对象接口
• ISimpleStateCheckerManager<TState>: 状态检查管理器接口
• ISimpleStateCheckerSerializer: 状态检查器序列化接口
• ISimpleStateCheckerSerializerContributor: 状态检查器序列化贡献者接口

核心实现

• DefaultSimpleStateCheckerManager<TState>: 默认状态检查管理器实现
• SimpleBatchStateCheckerBase<TState>: 批量状态检查器基类
• DefaultSimpleStateCheckerSerializer: 默认状态检查器序列化实现

配置

• SparkdoSimpleStateCheckerOptions<TState>: 状态检查器选项
• SparkdoStateCheckingModule: 状态检查模块配置

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