基于CQRS模式，如何在.NET Core中让EF生成仅含指定属性的INSERT语句？

问题背景 #

我在CRUD操作中采用CQRS模式，当前需实现插入操作，拥有一个包含6个属性的CommunicationEntity。现有代码如下：

public class InsertCommunicationCommand
{
    // Include only the properties you want to insert
    public string Property1 { get; set; }
    public string Property2 { get; set; }
    public string Property3 { get; set; }
    public string Property4 { get; set; }
    public string Property5 { get; set; }
    public string Property6 { get; set; }

    // Add any validation logic if needed
    public bool IsValid()
    {
        // Implement your validation logic here
        return true;
    }
}

public class InsertCommunicationCommandHandler
{
    private readonly YourDbContext _dbContext;

    public InsertCommunicationCommandHandler(YourDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    public void Handle(InsertCommunicationCommand command)
    {
        if (!command.IsValid())
        {
            // Handle validation errors
            return;
        }

        // Create a new CommunicationEntity with only the properties you want to insert
        var entity = new CommunicationEntity
        {
            Property1 = command.Property1,
            Property2 = command.Property2
        };

        // Attach the entity to the context and mark it as added
        
        _dbContext.CommunicationEntities.Add(entity);

        // Save changes to the database
        _dbContext.SaveChanges();
    }
}

我希望仅插入Property1和Property2的值，但EF生成的INSERT语句却包含了所有属性。需要让EF生成仅包含已设置值的INSERT语句，请问在.NET Core中使用Entity Framework是否可以实现？

解决方案 #

方法1：显式跟踪已赋值属性（推荐） #

通过DbContext.Entry()手动控制属性的修改状态，只让EF跟踪你需要插入的属性：

public void Handle(InsertCommunicationCommand command)
{
    if (!command.IsValid())
    {
        // 处理验证错误
        return;
    }

    var entity = new CommunicationEntity();
    // 手动设置属性并标记为已修改
    var entry = _dbContext.Entry(entity);
    entry.Property(e => e.Property1).CurrentValue = command.Property1;
    entry.Property(e => e.Property2).CurrentValue = command.Property2;
    
    // 将实体标记为新增状态
    _dbContext.CommunicationEntities.Add(entity);
    _dbContext.SaveChanges();
}

这种方式下，EF会严格只插入你显式设置的属性，因为只有这些属性被标记为IsModified = true。

方法2：利用可选属性的默认行为 #

如果Property3到Property6在数据库中允许为NULL，且你不需要给它们设置默认值，可以通过配置EF忽略未赋值的属性：

首先在DbContext的OnModelCreating中标记属性为可选：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<CommunicationEntity>()
        .Property(e => e.Property3)
        .IsRequired(false);
    modelBuilder.Entity<CommunicationEntity>()
        .Property(e => e.Property4)
        .IsRequired(false);
    // 对Property5、Property6执行同样配置
}

然后修改Handler，显式将未赋值的属性排除在修改跟踪外：

public void Handle(InsertCommunicationCommand command)
{
    if (!command.IsValid())
    {
        // 处理验证错误
        return;
    }

    var entity = new CommunicationEntity
    {
        Property1 = command.Property1,
        Property2 = command.Property2
        // 不设置其他属性，保持默认null
    };

    _dbContext.CommunicationEntities.Add(entity);
    
    // 遍历属性，将未赋值的可选属性标记为未修改
    var entry = _dbContext.Entry(entity);
    foreach (var property in entry.Properties)
    {
        if (property.CurrentValue == null && property.Metadata.IsNullable)
        {
            property.IsModified = false;
        }
    }

    _dbContext.SaveChanges();
}

方法3：使用原生SQL语句（完全可控） #

如果需要绝对精确控制SQL语句，直接执行原生INSERT：

public void Handle(InsertCommunicationCommand command)
{
    if (!command.IsValid())
    {
        // 处理验证错误
        return;
    }

    var sql = @"INSERT INTO tblCommunication(Property1, Property2)
                VALUES (@Property1, @Property2)";
    
    _dbContext.Database.ExecuteSqlRaw(sql, 
        new SqlParameter("@Property1", command.Property1),
        new SqlParameter("@Property2", command.Property2));
}

这种方式完全绕过EF的实体跟踪，直接生成你需要的SQL语句，适合对SQL有严格要求的场景。

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