Sparkdo.Auditing 1.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Sparkdo.Auditing --version 1.0.1
                    


                    

                
NuGet\Install-Package Sparkdo.Auditing -Version 1.0.1
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.Auditing" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Sparkdo.Auditing" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sparkdo.Auditing" />
                    


                            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.Auditing --version 1.0.1
                    


                    

                
#r "nuget: Sparkdo.Auditing, 1.0.1"
#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.Auditing@1.0.1
#: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.Auditing&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sparkdo.Auditing&version=1.0.1
                    


                            Install as a Cake Tool

Sparkdo.Auditing

Sparkdo 审计库，提供方法调用和实体变更的自动审计日志记录功能。

功能特性

  • 方法调用审计：自动记录服务方法的调用信息
  • 实体变更审计：跟踪实体的创建、更新和删除操作
  • 审计贡献者模式：支持自定义审计信息扩展
  • 多租户支持：记录租户相关信息
  • 用户信息跟踪：记录当前用户信息
  • 异常审计：记录方法执行中的异常信息
  • 审计存储扩展：支持自定义审计日志存储方式
  • 与 Sparkdo 框架无缝集成

安装

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

核心组件

AuditingInterceptor

审计拦截器，用于拦截方法调用并记录审计信息：

  • 自动记录方法执行时间
  • 记录方法参数信息
  • 捕获并记录异常信息

DefaultAuditingManager

默认审计管理器实现，负责管理审计作用域：

  • BeginScope(): 开始一个新的审计作用域
  • Current: 获取当前审计作用域

DefaultAuditingHelper

默认审计帮助类，提供审计信息创建功能：

  • CreateAuditLogInfo(): 创建审计日志信息
  • CreateAuditLogAction(): 创建审计动作信息
  • ShouldSaveAudit(): 判断是否应该保存审计日志

JsonAuditSerializer

JSON 审计序列化器，用于序列化审计参数：

  • 支持忽略敏感类型的序列化
  • 支持自定义序列化配置

SparkdoAuditingOptions

审计配置选项，允许自定义审计行为：

  • IsEnabled: 启用/禁用审计功能
  • HideErrors: 隐藏审计错误
  • Contributors: 审计贡献者列表
  • IgnoredTypes: 忽略审计的类型列表

审计存储

  • IAuditingStore: 审计存储接口
  • SimpleLogAuditingStore: 简单日志审计存储实现（默认）

审计属性设置器

  • IAuditPropertySetter: 审计属性设置器接口
  • DefaultAuditPropertySetter: 默认审计属性设置器实现

扩展性

该库提供了完整的审计功能实现，可以通过以下方式扩展：

  1. 实现自定义的 AuditLogContributor 来添加特定的审计信息
  2. 实现自定义的 IAuditingStore 来改变审计日志的存储方式
  3. 通过 SparkdoAuditingOptions 配置审计行为
  4. 使用 Audited 和 AuditingDisable 特性来控制特定类或方法的审计行为

代码结构说明

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

审计信息模型

  • AuditLogInfo: 审计日志信息
  • AuditLogActionInfo: 审计动作信息
  • EntityChangeInfo: 实体变更信息
  • EntityPropertyChangeInfo: 实体属性变更信息

核心服务

  • IAuditingManager: 审计管理器接口
  • DefaultAuditingManager: 默认审计管理器实现
  • IAuditingHelper: 审计帮助类接口
  • DefaultAuditingHelper: 默认审计帮助类实现
  • IAuditingStore: 审计存储接口
  • SimpleLogAuditingStore: 简单日志审计存储实现
  • IAuditPropertySetter: 审计属性设置器接口
  • DefaultAuditPropertySetter: 默认审计属性设置器实现

配置

  • SparkdoAuditingOptions: 审计配置选项
  • SparkdoAuditingModule: 审计模块配置

拦截器

  • AuditingInterceptor: 审计拦截器
  • AuditingInterceptorRegistrar: 审计拦截器注册器

序列化

  • IAuditSerializer: 审计序列化器接口
  • JsonAuditSerializer: JSON 审计序列化器实现

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

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Sparkdo.Auditing:

Package Downloads
Sparkdo.Ddd.Domain

Sparkdo DDD 领域模型库，提供领域驱动设计的核心组件实现
Sparkdo.AutoMapper

Sparkdo AutoMapper 集成库，提供基于 AutoMapper 的对象映射功能实现
Sparkdo.AspNetCore

Sparkdo ASP.NET Core 集成库，提供与 ASP.NET Core 框架深度集成的功能实现
Sparkdo.AuditLogging.Domain

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

Sparkdo Mapperly 集成库，提供基于 Mapperly 的对象映射功能实现

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.2-preview.1 149 12/4/2025
1.0.1 793 11/27/2025
1.0.0 790 11/25/2025
1.0.0-preview.5 96 10/24/2025