Sparkdo.AuditLogging.Domain 1.0.2

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Sparkdo.AuditLogging.Domain --version 1.0.2
                    
NuGet\Install-Package Sparkdo.AuditLogging.Domain -Version 1.0.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sparkdo.AuditLogging.Domain" Version="1.0.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sparkdo.AuditLogging.Domain" Version="1.0.2" />
                    
Directory.Packages.props
<PackageReference Include="Sparkdo.AuditLogging.Domain" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Sparkdo.AuditLogging.Domain --version 1.0.2
                    
#r "nuget: Sparkdo.AuditLogging.Domain, 1.0.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Sparkdo.AuditLogging.Domain@1.0.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Sparkdo.AuditLogging.Domain&version=1.0.2
                    
Install as a Cake Addin
#tool nuget:?package=Sparkdo.AuditLogging.Domain&version=1.0.2
                    
Install as a Cake Tool

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. 继承 AuditLogEntityChange 来添加自定义属性
  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 文档注释,便于开发者理解和使用。

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Sparkdo.AuditLogging.Domain:

Package Downloads
Sparkdo.AuditLogging.EntityFrameworkCore

Sparkdo 审计日志EntityFrameworkCore实现,提供基于EF Core的审计日志数据访问实现

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3-preview.1 33 5/17/2026
1.0.2 107 4/27/2026
1.0.2-preview.5 56 4/15/2026
1.0.2-preview.4 70 2/8/2026
1.0.2-preview.3 70 2/1/2026
1.0.2-preview.2 66 1/31/2026
1.0.2-preview.1 175 12/4/2025
1.0.1 223 11/27/2025
1.0.0 232 11/25/2025