Sparkdo.Auditing
1.0.2
dotnet add package Sparkdo.Auditing --version 1.0.2
NuGet\Install-Package Sparkdo.Auditing -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.Auditing" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sparkdo.Auditing" Version="1.0.2" />
<PackageReference Include="Sparkdo.Auditing" />
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.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sparkdo.Auditing, 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.Auditing@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.Auditing&version=1.0.2
#tool nuget:?package=Sparkdo.Auditing&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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: 默认审计属性设置器实现
扩展性
该库提供了完整的审计功能实现,可以通过以下方式扩展:
- 实现自定义的
AuditLogContributor来添加特定的审计信息 - 实现自定义的
IAuditingStore来改变审计日志的存储方式 - 通过
SparkdoAuditingOptions配置审计行为 - 使用
Audited和AuditingDisable特性来控制特定类或方法的审计行为
代码结构说明
本项目包含以下主要组件:
审计信息模型
AuditLogInfo: 审计日志信息AuditLogActionInfo: 审计动作信息EntityChangeInfo: 实体变更信息EntityPropertyChangeInfo: 实体属性变更信息
核心服务
IAuditingManager: 审计管理器接口DefaultAuditingManager: 默认审计管理器实现IAuditingHelper: 审计帮助类接口DefaultAuditingHelper: 默认审计帮助类实现IAuditingStore: 审计存储接口SimpleLogAuditingStore: 简单日志审计存储实现IAuditPropertySetter: 审计属性设置器接口DefaultAuditPropertySetter: 默认审计属性设置器实现
配置
SparkdoAuditingOptions: 审计配置选项SparkdoAuditingModule: 审计模块配置
拦截器
AuditingInterceptor: 审计拦截器AuditingInterceptorRegistrar: 审计拦截器注册器
序列化
IAuditSerializer: 审计序列化器接口JsonAuditSerializer: JSON 审计序列化器实现
所有公共接口和类都添加了详细的 XML 文档注释,便于开发者理解和使用。
| Product | Versions 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.
-
net10.0
- JetBrains.Annotations (>= 2025.2.4)
- Microsoft.Extensions.Configuration (>= 10.0.5)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.5)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.5)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.5)
- Microsoft.Extensions.Configuration.Json (>= 10.0.5)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.DependencyModel (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Composite (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Embedded (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Physical (>= 10.0.5)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Localization (>= 10.0.5)
- Microsoft.Extensions.Logging (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.5)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.5)
- Nito.AsyncEx.Context (>= 5.1.2)
- Sparkdo.Auditing.Contracts (>= 1.0.2)
- Sparkdo.MultiTenancy.Abstractions (>= 1.0.2)
- Sparkdo.Security (>= 1.0.2)
- Sparkdo.Threading (>= 1.0.2)
- Sparkdo.Timing (>= 1.0.2)
- System.Linq.Dynamic.Core (>= 1.7.1)
- TimeZoneConverter (>= 7.2.0)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on Sparkdo.Auditing:
| Package | Downloads |
|---|---|
|
Sparkdo.Ddd.Domain
Sparkdo DDD 领域模型库,提供领域驱动设计的核心组件实现 |
|
|
Sparkdo.AutoMapper
Sparkdo Mapture 集成库,提供基于 Mapture 的对象映射功能实现 |
|
|
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 | 322 | 4/27/2026 |
| 1.0.2-preview.5 | 75 | 4/15/2026 |
| 1.0.2-preview.4 | 95 | 2/8/2026 |
| 1.0.2-preview.3 | 93 | 2/1/2026 |
| 1.0.2-preview.2 | 109 | 1/31/2026 |
| 1.0.2-preview.1 | 187 | 12/4/2025 |
| 1.0.1 | 853 | 11/27/2025 |
| 1.0.0 | 848 | 11/25/2025 |
| 1.0.0-preview.5 | 135 | 10/24/2025 |