Audit.NET中移除审计事件内置字段的技术方案

背景介绍

在软件开发中，审计日志记录是一个关键功能，它帮助开发者追踪系统操作、排查问题并满足合规要求。Audit.NET是一个流行的.NET审计日志库，它提供了丰富的功能来记录应用程序中的各种事件。

问题描述

在使用Audit.NET时，开发者可能会遇到需要精简审计日志内容的情况。例如，某些内置字段（如Duration、EntityFrameworkEvent.Result等）可能包含不必要的信息，或者出于安全考虑需要从日志中移除。然而，这些字段是AuditEvent类的内置属性，不是简单的自定义字段，无法通过常规的CustomFields集合来移除。

解决方案

JSON序列化控制方案

针对这个问题，最有效的解决方案是利用.NET的JSON序列化控制功能。在.NET 7及以上版本中，可以通过TypeInfoResolver和JsonTypeInfo来精细控制序列化过程。

实现步骤

1. 创建类型信息修改器：定义一个静态方法AuditEventModifier，用于修改特定类型的序列化行为。

2. 配置属性序列化规则：在修改器中，针对AuditEvent和EntityFrameworkEvent类型，设置特定属性的ShouldSerialize回调，使其始终返回false。

3. 应用到全局配置：将自定义的JsonSerializerOptions配置到Audit.NET的全局设置中。

代码示例

static void AuditEventModifier(JsonTypeInfo typeInfo)
{
    if (typeof(AuditEvent).IsAssignableFrom(typeInfo.Type))
    {
        foreach (var prop in typeInfo.Properties)
        {
            if (prop.Name == nameof(AuditEvent.Duration))
            {
                prop.ShouldSerialize = static (_, _) => false;
            }
        }
    }
    else if (typeof(EntityFrameworkEvent).IsAssignableFrom(typeInfo.Type))
    {
        foreach (var prop in typeInfo.Properties)
        {
            if (prop.Name == nameof(EntityFrameworkEvent.Result))
            {
                prop.ShouldSerialize = static (_, _) => false;
            }
        }
    }
}

// 应用到全局配置
Audit.Core.Configuration.JsonSettings = new JsonSerializerOptions
{
    TypeInfoResolver = new DefaultJsonTypeInfoResolver
    {
        Modifiers = { AuditEventModifier }
    }
};

通用化解决方案

为了更灵活地控制多个类型的多个属性，可以采用字典来管理需要保留的属性，实现更通用的解决方案：

private static readonly Dictionary<Type, List<string>> DefaultAuditEventProperties = new()
{
    { typeof(AuditEventEntityFramework), new List<string> { 
        nameof(AuditEventEntityFramework.EntityFrameworkEvent), 
        nameof(AuditEventEntityFramework.Environment), 
        nameof(AuditEventEntityFramework.StartDate) } },
    { typeof(EntityFrameworkEvent), new List<string> { 
        nameof(EntityFrameworkEvent.Entries) } },
    { typeof(EventEntry), new List<string> { 
        nameof(EventEntry.Name), 
        nameof(EventEntry.Action), 
        nameof(EventEntry.Changes), 
        nameof(EventEntry.ColumnValues) } },
    { typeof(AuditEventEnvironment), new List<string> { 
        nameof(AuditEventEnvironment.UserName), 
        nameof(AuditEventEnvironment.DomainName) } },
};

private static void DefineAuditableFields() =>
    Audit.Core.Configuration.JsonSettings = new JsonSerializerOptions
    {
        TypeInfoResolver = new DefaultJsonTypeInfoResolver
        {
            Modifiers = { AuditEventModifier },
        },
    };

private static void AuditEventModifier(JsonTypeInfo typeInfo)
{
    DefaultAuditEventProperties.TryGetValue(typeInfo.Type, out var auditProperties);
    auditProperties ??= new List<string>();

    foreach (var property in typeInfo.Properties)
    {
        property.ShouldSerialize = (_, _) => auditProperties.Contains(property.Name);
    }
}

技术原理

这种解决方案利用了System.Text.Json在.NET 7中引入的TypeInfoResolver功能。TypeInfoResolver允许开发者在运行时修改类型的序列化行为，而ShouldSerialize回调则决定了特定属性是否应该被序列化。

当设置为返回false时，对应的属性将不会出现在最终的JSON输出中，从而达到"移除"字段的效果。这种方法实际上是在序列化阶段过滤掉了不需要的字段，而不是真正从对象中删除它们。

注意事项

1. 版本要求：此方案需要.NET 7或更高版本，因为它依赖于System.Text.Json的新特性。

2. 性能考虑：虽然这种解决方案非常灵活，但添加过多的类型修改器可能会对序列化性能产生轻微影响。

3. 数据完整性：移除内置字段可能会影响审计日志的完整性，请确保移除的字段不会影响后续的日志分析和问题排查。

4. 存储格式：此方案主要适用于JSON格式的存储，如果使用其他格式的数据提供程序，可能需要不同的实现方式。

总结

通过利用.NET的JSON序列化控制功能，开发者可以灵活地控制Audit.NET中审计事件的输出内容。这种方案不仅适用于移除内置字段，还可以扩展到更复杂的日志内容定制场景，为应用程序的审计日志提供了更高的可定制性。