Sparkdo.Auditing.Contracts
1.0.2
dotnet add package Sparkdo.Auditing.Contracts --version 1.0.2
NuGet\Install-Package Sparkdo.Auditing.Contracts -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.Contracts" 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.Contracts" Version="1.0.2" />
<PackageReference Include="Sparkdo.Auditing.Contracts" />
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.Contracts --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sparkdo.Auditing.Contracts, 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.Contracts@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.Contracts&version=1.0.2
#tool nuget:?package=Sparkdo.Auditing.Contracts&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Sparkdo.Auditing.Contracts
Sparkdo 审计合约库,提供审计功能的核心接口和属性定义。
功能特性
- 审计属性接口:定义实体审计所需的标准属性
- 审计标记特性:通过特性控制审计行为
- 审计对象接口:标准化的审计对象契约
- 与 Sparkdo 框架无缝集成
安装
<PackageReference Include="Sparkdo.Auditing.Contracts" Version="x.x.x" />
核心组件
审计属性接口
IWithCreationTime: 包含创建时间属性IWithModificationTime: 包含修改时间属性IWithDeletionTime: 包含删除时间属性IWithEntityVersion: 包含实体版本属性
创建者接口
IMayHaveCreator: 可能有创建者的实体接口IMustHaveCreator: 必须有创建者的实体接口
审计对象接口
ICreationAuditedObject: 创建审计对象接口IModificationAuditedObject: 修改审计对象接口IDeletionAuditedObject: 删除审计对象接口IAuditedObject: 完整审计对象接口(包含创建和修改审计)IFullAuditedObject: 完全审计对象接口(包含创建、修改和删除审计)
审计特性
AuditedAttribute: 标记需要审计的类、方法或属性AuditingDisableAttribute: 禁用审计的特性
枚举类型
EntityChangeType: 实体变更类型枚举(创建、更新、删除)
使用示例
基本审计实体
public class MyEntity : IAuditedObject
{
public DateTime CreationTime { get; set; }
public Guid? CreatorId { get; set; }
public DateTime? LastModificationTime { get; set; }
public Guid? LastModifierId { get; set; }
}
必须有创建者的实体
public class MyEntity : IMustHaveCreator
{
public Guid CreatorId { get; set; }
public DateTime CreationTime { get; set; }
}
使用审计特性
[Audited]
public class MyService
{
public void MyMethod()
{
// 此方法将被审计
}
}
public class AnotherService
{
[Audited]
public void AuditedMethod()
{
// 此方法将被审计
}
[AuditingDisable]
public void NotAuditedMethod()
{
// 此方法不会被审计
}
}
扩展性
该库提供了标准的审计契约,可以通过以下方式扩展:
- 实现自定义的审计接口
- 创建自定义的审计特性
- 结合 Sparkdo.Auditing 模块实现具体的审计逻辑
所有公共接口和类都添加了详细的 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.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.Core (>= 1.0.2)
- System.Linq.Dynamic.Core (>= 1.7.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Sparkdo.Auditing.Contracts:
| Package | Downloads |
|---|---|
|
Sparkdo.Auditing
Sparkdo 审计库,提供方法调用和实体变更的自动审计日志记录功能 |
|
|
Sparkdo.Ddd.Application.Contracts
Sparkdo DDD应用层契约库,提供应用服务接口定义和数据传输对象(DTO)基类 |
|
|
Sparkdo.TenantManagement.Domain.Shared
Sparkdo 租户管理共享资源和配置 |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.2 | 388 | 4/27/2026 |
| 1.0.2-preview.5 | 94 | 4/15/2026 |
| 1.0.2-preview.4 | 100 | 2/8/2026 |
| 1.0.2-preview.3 | 114 | 2/1/2026 |
| 1.0.2-preview.2 | 121 | 1/31/2026 |
| 1.0.2-preview.1 | 181 | 12/4/2025 |
| 1.0.1 | 1,161 | 11/27/2025 |
| 1.0.0 | 1,154 | 11/25/2025 |
| 1.0.0-preview.5 | 151 | 10/24/2025 |