如何在EF Core中自动修剪所有实体的字符串字段后执行增改操作？

要实现EF Core中所有实体的字符串字段在添加或更新前自动修剪，核心思路是利用EF Core的保存拦截器，在SaveChanges或SaveChangesAsync执行前遍历实体的字符串属性并完成修剪处理。

步骤1：实现自定义保存拦截器 #

创建一个继承SaveChangesInterceptor的拦截器，重写保存前的方法来处理字符串修剪逻辑：

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Diagnostics;
using System.Reflection;

public class StringTrimInterceptor : SaveChangesInterceptor
{
    public override InterceptionResult<int> SavingChanges(DbContextEventData eventData, InterceptionResult<int> result)
    {
        TrimEntityStrings(eventData.Context);
        return base.SavingChanges(eventData, result);
    }

    public override ValueTask<InterceptionResult<int>> SavingChangesAsync(DbContextEventData eventData, InterceptionResult<int> result, CancellationToken cancellationToken = default)
    {
        TrimEntityStrings(eventData.Context);
        return base.SavingChangesAsync(eventData, result, cancellationToken);
    }

    private void TrimEntityStrings(DbContext? context)
    {
        if (context == null) return;

        // 筛选出处于添加或修改状态的实体
        var targetEntities = context.ChangeTracker.Entries()
            .Where(e => e.State is EntityState.Added or EntityState.Modified)
            .Select(e => e.Entity);

        foreach (var entity in targetEntities)
        {
            // 获取实体所有可写的字符串属性，排除标记了NoTrim的属性
            var stringProperties = entity.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance)
                .Where(p => p.PropertyType == typeof(string) 
                            && p.CanWrite 
                            && !Attribute.IsDefined(p, typeof(NoTrimAttribute)));

            foreach (var property in stringProperties)
            {
                var currentValue = property.GetValue(entity) as string;
                if (!string.IsNullOrEmpty(currentValue))
                {
                    property.SetValue(entity, currentValue.Trim());
                }
            }
        }
    }
}

步骤2：定义排除修剪的特性（可选） #

如果部分字符串字段不需要自动修剪，可以通过自定义特性标记排除：

[AttributeUsage(AttributeTargets.Property)]
public class NoTrimAttribute : Attribute
{
}

使用示例：

public class Article
{
    public int Id { get; set; }
    public string Title { get; set; } // 会自动修剪
    [NoTrim]
    public string RawContent { get; set; } // 跳过修剪
}

步骤3：在DbContext中注册拦截器 #

在DbContext的配置方法中添加自定义拦截器：

public class AppDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder
            .UseSqlServer("YourConnectionString")
            .AddInterceptors(new StringTrimInterceptor());
    }

    // 定义DbSet...
}

关键注意点 #

• 仅处理Added和Modified状态的实体，避免无意义的性能消耗
• 跳过null和空字符串，防止将null值转为空字符串
• 通过特性实现灵活的字段排除，适配不同业务需求

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