EF 6.2中Entity Framework Core的EnableSensitiveDataLogging等效方案咨询

我明白你想要在EF 6.2里实现类似EF Core中EnableSensitiveDataLogging的功能，用来在Serilog日志里查看提交的数据对吧？确实EF 6.2没有这个内置选项，不过有几个靠谱的替代方案，结合你的Serilog配置给你详细说说：

方案一：重写SaveChanges/SaveChangesAsync记录实体变更数据 #

EF 6的DbContext允许我们重写SaveChanges和SaveChangesAsync方法，在这些方法里我们可以捕获到所有待提交的实体变更，然后序列化后用Serilog记录下来。同时还能方便地过滤掉敏感数据（比如密码、令牌）。

示例代码如下：

public class YourDbContext : DbContext
{
    // ... 你的DbSet和其他配置

    public override int SaveChanges()
    {
        LogEntityChanges();
        return base.SaveChanges();
    }

    public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
    {
        LogEntityChanges();
        return await base.SaveChangesAsync(cancellationToken);
    }

    private void LogEntityChanges()
    {
        // 获取所有处于新增或修改状态的实体
        var changedEntries = ChangeTracker.Entries()
            .Where(e => e.State is EntityState.Added or EntityState.Modified);

        foreach (var entry in changedEntries)
        {
            var entityType = entry.Entity.GetType().Name;
            var entityState = entry.State.ToString();

            // 针对特定实体类型过滤敏感字段，比如用户实体
            if (entry.Entity is User userEntity)
            {
                // 只记录非敏感字段，敏感字段替换为***
                var safeUser = new 
                { 
                    userEntity.Id, 
                    userEntity.Username, 
                    userEntity.Email, 
                    Password = "***" 
                };
                Log.Information("实体 {EntityType} 状态为 {EntityState}，数据：{EntityData}",
                    entityType, entityState, safeUser);
            }
            else
            {
                // 普通实体直接序列化记录
                Log.Information("实体 {EntityType} 状态为 {EntityState}，数据：{EntityData}",
                    entityType, entityState, entry.Entity);
            }
        }
    }
}

方案二：使用EF 6拦截器记录SQL和参数值 #

如果你更关注EF生成的SQL语句以及对应的参数值（这和EF Core的EnableSensitiveDataLogging效果最接近），可以使用EF 6的IDbCommandInterceptor拦截器，捕获每次执行的数据库命令，然后记录SQL和参数。

第一步：创建拦截器类 #

public class SensitiveDataLoggingInterceptor : IDbCommandInterceptor
{
    public void NonQueryExecuting(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
    {
        LogDbCommand(command);
    }

    public void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        LogDbCommand(command);
    }

    public void ScalarExecuting(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
    {
        LogDbCommand(command);
    }

    private void LogDbCommand(DbCommand command)
    {
        // 记录执行的SQL语句
        Log.Information("执行SQL语句：{SqlText}", command.CommandText);

        // 记录参数，自动过滤敏感参数
        foreach (DbParameter param in command.Parameters)
        {
            var paramValue = param.ParameterName.ToLower() switch
            {
                var name when name.Contains("password") || name.Contains("authtoken") => "***",
                _ => param.Value
            };

            Log.Information("SQL参数 {ParamName} = {ParamValue}", param.ParameterName, paramValue);
        }
    }
}

第二步：注册拦截器 #

在你的DbContext构造函数里添加拦截器：

public class YourDbContext : DbContext
{
    public YourDbContext()
    {
        // 注册拦截器
        DbInterception.Add(new SensitiveDataLoggingInterceptor());
    }

    // ... 其他配置
}

方案三：通过ActionFilter记录Web API提交的原始模型 #

你已经用了SerilogWebClassic的EnableFormDataLogging来记录表单提交的数据，但如果你的API接收JSON格式的请求体，这个配置可能覆盖不到。这时可以自定义一个ActionFilter，捕获API接口的输入模型并记录。

第一步：创建ActionFilter #

public class LogRequestModelFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (actionContext.ActionArguments.Any())
        {
            var controllerName = actionContext.ControllerContext.ControllerDescriptor.ControllerName;
            var actionName = actionContext.ActionDescriptor.ActionName;

            foreach (var arg in actionContext.ActionArguments)
            {
                var safeModel = FilterSensitiveProperties(arg.Value);
                Log.Information("API请求 [{Controller}/{Action}] 提交的模型：{ModelData}",
                    controllerName, actionName, safeModel);
            }
        }

        base.OnActionExecuting(actionContext);
    }

    // 通用敏感数据过滤方法
    private object FilterSensitiveProperties(object model)
    {
        if (model == null) return null;

        var modelType = model.GetType();
        var safeProperties = new Dictionary<string, object>();

        foreach (var prop in modelType.GetProperties())
        {
            var propName = prop.Name.ToLower();
            if (propName.Contains("password") || propName.Contains("authtoken"))
            {
                safeProperties[prop.Name] = "***";
            }
            else
            {
                safeProperties[prop.Name] = prop.GetValue(model);
            }
        }

        return safeProperties;
    }
}

第二步：注册全局Filter #

在Web API的WebApiConfig里注册这个Filter：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 注册全局请求模型日志过滤器
        config.Filters.Add(new LogRequestModelFilter());

        // ... 你的路由、其他配置
    }
}

这几个方案可以单独使用，也可以结合起来，根据你的实际需求选择。记得始终注意敏感数据的过滤，避免日志泄露隐私信息。

内容的提问来源于stack exchange，提问作者dora