Sparkdo.AuditLogging.Domain 1.0.1

Sparkdo.AuditLogging.Domain

Sparkdo 审计日志领域层，提供审计日志的核心业务逻辑和数据访问接口。

功能特性

• 完整的审计日志记录功能
• 支持 HTTP 请求审计
• 支持实体变更审计
• 支持审计日志查询和分析
• 支持多租户环境
• 与 Sparkdo 框架无缝集成

安装

<PackageReference Include="Sparkdo.AuditLogging.Domain" Version="x.x.x" />

核心组件

AuditLog

审计日志实体类，记录系统操作的详细信息：

• ApplicationName: 应用程序名称
• UserId: 用户ID
• UserName: 用户名
• TenantId: 租户ID
• TenantName: 租户名称
• ExecutionTime: 执行时间
• ExecutionDuration: 执行持续时间
• ClientIpAddress: 客户端IP地址
• Url: 请求URL
• HttpMethod: HTTP方法
• HttpStatusCode: HTTP状态码
• Exceptions: 异常信息
• EntityChanges: 实体变更集合
• Actions: 审计操作集合

EntityChange

实体变更记录类，记录实体的变更历史：

• ChangeTime: 变更时间
• ChangeType: 变更类型（创建/更新/删除）
• EntityId: 实体ID
• EntityTypeFullName: 实体类型全名
• PropertyChanges: 属性变更集合

AuditLogAction

审计日志操作类，记录方法调用的操作信息：

• ServiceName: 服务名称
• MethodName: 方法名称
• Parameters: 参数信息
• ExecutionTime: 执行时间
• ExecutionDuration: 执行持续时间

IAuditLogRepository

审计日志仓储接口，提供审计日志数据访问功能：

• GetListAsync(): 获取审计日志列表
• GetCountAsync(): 获取审计日志数量
• GetEntityChange(): 获取实体变更信息
• GetEntityChangeListAsync(): 获取实体变更列表
• GetEntityChangesWithUsernameAsync(): 获取带用户名的实体变更历史

AuditingStore

审计存储实现类，负责将审计日志信息保存到存储中：

• SaveAsync(): 保存审计日志信息

使用示例

基本配置

在模块中添加审计日志功能：

public class MyModule : Module
{
    public override void ConfigureServices(IConfigureContext context)
    {
        // 审计日志会自动集成到框架中
        // 只需确保 SparkdoAuditLoggingDomainModule 已加载
    }
}

查询审计日志

public class AuditLogAppService : ApplicationService
{
    private readonly IAuditLogRepository _auditLogRepository;

    public AuditLogAppService(IAuditLogRepository auditLogRepository)
    {
        _auditLogRepository = auditLogRepository;
    }

    public async Task<List<AuditLog>> GetAuditLogsAsync(DateTime? startTime = null, DateTime? endTime = null)
    {
        return await _auditLogRepository.GetListAsync(
            startTime: startTime,
            endTime: endTime,
            maxResultCount: 100
        );
    }

    public async Task<List<EntityChange>> GetEntityChangesAsync(string entityId, string entityTypeFullName)
    {
        return await _auditLogRepository.GetEntityChangeListAsync(
            entityId: entityId,
            entityTypeFullName: entityTypeFullName
        );
    }
}

扩展性

该库提供了完整的审计日志领域实现，可以通过以下方式扩展：

1. 实现自定义的 IAuditLogRepository 来替换默认的数据访问实现
2. 继承 AuditLog 或 EntityChange 来添加自定义属性
3. 实现自定义的 IAuditingStore 来处理审计日志的存储逻辑
4. 通过配置选项来调整审计日志行为

代码结构说明

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

实体类

• AuditLog: 审计日志实体
• EntityChange: 实体变更记录
• EntityPropertyChange: 实体属性变更记录
• AuditLogAction: 审计日志操作
• AuditLogExcelFile: 审计日志Excel文件

仓储接口

• IAuditLogRepository: 审计日志仓储接口
• IAuditLogExcelFileRepository: 审计日志Excel文件仓储接口

核心服务

• IAuditingStore: 审计存储接口
• AuditingStore: 审计存储实现
• IAuditLogInfoToAuditLogConverter: 审计日志信息转换器接口
• AuditLogInfoToAuditLogConverter: 审计日志信息转换器实现

常量定义

• AuditLogConstants: 审计日志常量
• EntityChangeConstants: 实体变更常量
• EntityPropertyChangeConstants: 实体属性变更常量
• AuditLogActionConstants: 审计日志操作常量
• AuditLogExcelFileConstants: 审计日志Excel文件常量

辅助类

• AuditLogEntityTypeFullNameConverter: 审计日志实体类型全名转换器

模块配置

• SparkdoAuditLoggingDomainModule: 审计日志领域模块配置

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