为什么 EF Core 在使用自定义 ValueGenerator 时尝试插入空值？

Question

问题已更新以反映更多细节和简化的复制案例，因为我在 cmets 的帮助下进行了更深入的挖掘。

我有一个自定义的 ValueGenerator 如下：

public class UtcDateTimeGenerator : ValueGenerator<DateTime>
{
    public override DateTime Next(EntityEntry entry)
    {
        // This method never seems to be called
        return DateTime.UtcNow;
    }

    protected override object NextValue(EntityEntry entry)
    {
        // This one is called.
        return DateTime.UtcNow;
    }

    public override bool GeneratesTemporaryValues => false;
}

我的实体：

public abstract class AggregateRoot<TId>
    where TId : IComparable
{
    public TId Id { get; set; }
}

public abstract class AuditedAggregateRoot<TId> : AggregateRoot<TId>
    where TId : IComparable
{
    public DateTime Created { get; internal set; }
    public DateTime LastModified { get; internal set; }
}

public class Player : AuditedAggregateRoot<Guid>
{
    public string ExternalId { get; internal set; }
    public string DisplayName { get; internal set; }
    public string Email { get; internal set; }
    public DateTime LastLogin { get; internal set; }

    /// <summary>
    /// Required for Entity Framework Core
    /// </summary>
    private Player()
    {
    }

    public Player([NotNull]string externalId, [NotNull]string displayName, [NotNull]string email)
    {
        ExternalId = externalId;
        DisplayName = displayName;
        Email = email;
    }
}

我的实体的IEntityTypeConfiguration：

public abstract class AggregateRootTypeConfiguration<TEntity, TKey> : IEntityTypeConfiguration<TEntity>
    where TEntity : AggregateRoot<TKey>
    where TKey : IComparable
{
    public virtual void Configure(EntityTypeBuilder<TEntity> builder)
    {
        builder.HasKey(x => x.Id);
        builder.Property(x => x.Id)
            .HasValueGenerator<SequentialGuidValueGenerator>()
            .ValueGeneratedOnAdd()
            .IsRequired();
    }
}

public class AuditedAggregateRootTypeConfiguration<TEntity, TKey> : AggregateRootTypeConfiguration<TEntity, TKey>
    where TEntity : AuditedAggregateRoot<TKey>
    where TKey : IComparable
{
    public override void Configure(EntityTypeBuilder<TEntity> builder)
    {
        base.Configure(builder);
        builder.Property(x => x.Created)
            .HasValueGenerator<UtcDateTimeGenerator>()
            .ValueGeneratedOnAdd()
            .IsRequired();

        builder.Property(x => x.LastModified)
            .HasValueGenerator<UtcDateTimeGenerator>()
            .ValueGeneratedOnAddOrUpdate()
            .IsRequired();
    }
}

public class PlayerEntityTypeConfiguration : AuditedAggregateRootTypeConfiguration<Player, Guid>
{
    public override void Configure(EntityTypeBuilder<Player> builder)
    {
        base.Configure(builder);
        builder.Property(x => x.Email)
            .HasMaxLength(254)
            .IsRequired();

        builder.Property(x => x.ExternalId)
            .HasMaxLength(200)
            .IsRequired();

        builder.Property(x => x.DisplayName)
            .HasMaxLength(200)
            .IsRequired();

        builder.HasIndex(x => x.ExternalId).IsUnique();
        builder.HasIndex(x => x.Email).IsUnique();
        builder.HasIndex(x => x.DisplayName).IsUnique();
    }
}

数据库上下文：

public class MyDbContext : DbContext
{
    public EmpiresDbContext(DbContextOptions<EmpiresDbContext> dbContextOptions) : base(dbContextOptions)
    {
    }

    public DbSet<Player> Players { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(EmpiresDbContext).Assembly);
        base.OnModelCreating(modelBuilder);
    }
    
    /*
     * Overrides below to fix EF Core not calling ValueGenerator's on update
     * See: https://github.com/dotnet/efcore/issues/19765#issuecomment-617679987
     */
    
    public override int SaveChanges(bool acceptAllChangesOnSuccess)
    {
        GenerateOnUpdate();
        return base.SaveChanges(acceptAllChangesOnSuccess);
    }

    public override Task<int> SaveChangesAsync(
        bool acceptAllChangesOnSuccess, CancellationToken cancellationToken = default)
    {
        GenerateOnUpdate();
        return base.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
    }

    private void GenerateOnUpdate()
    {
        foreach (var entityEntry in ChangeTracker.Entries())
        {
            foreach (var propertyEntry in entityEntry.Properties)
            {
                var property = propertyEntry.Metadata;
                var valueGeneratorFactory =
                    property.GetValueGeneratorFactory();
                var generatedOnUpdate = (property.ValueGenerated & ValueGenerated.OnUpdate)
                                        == ValueGenerated.OnUpdate;
                if (!generatedOnUpdate || valueGeneratorFactory == null)
                {
                    continue;
                }

                var valueGenerator = valueGeneratorFactory.Invoke(
                    property,
                    entityEntry.Metadata);
                propertyEntry.CurrentValue = valueGenerator.Next(entityEntry);
            }
        }
    }
}

我将MyDbContext 注入到服务中，然后在CreatePlayer 方法中：

var player = new Player(externalId, displayName, email);
_dbContext.Players.Add(player);
await _dbContext.SaveChangesAsync();

但是，当await _dbContext.SaveChangesAsync(); 被调用时，我得到一个异常：

SqlException：无法将值 NULL 插入列“LastModified”

我已经用断点检查了 Dbcontext 中的 propertyEntry.CurrentValue = valueGenerator.Next(entityEntry); 行正在被命中，并且它正在为 LastModified 属性分配正确的值。

通过 SQL 跟踪，我可以看到生成的 SQL 如下：

exec sp_executesql N'SET NOCOUNT ON;
INSERT INTO [Players] ([Id], [Created], [DisplayName], [Email], [ExternalId], [LastLogin])
VALUES (@p0, @p1, @p2, @p3, @p4, @p5);
SELECT [LastModified]
FROM [Players]
WHERE @@ROWCOUNT = 1 AND [Id] = @p0;

',N'@p0 uniqueidentifier,@p1 datetime2(7),@p2 nvarchar(200),@p3 nvarchar(254),@p4 nvarchar(4000),@p5 datetime2(7)',@p0='C17E4EC8-CDD6-458A-8CEF-08D8C5D6F63A',@p1='2021-01-31 11:00:27.1068666',@p2=N'Kyr',@p3=N'test@test.test',@p4=N'my-iDp-id-removed-for-security',@p5='0001-01-01 00:00:00'

正如您在上面看到的，LastModified 列甚至没有被引用。

Answer 1

您的ValueGenerator 非常适合我。

要缩小问题的原因，请暂时在服务类中直接依赖 DbContext -

public class PlayerService : IPlayerService
{
    private EmpiresDbContext _dbContext;
    
    public PlayerService(EmpiresDbContext context)
    {
        _dbContext = context;
    }
}

看看下面的代码是否有效-

var player = new Player(externalId, displayName, email);
try
{
    _dbContext.Players.Add(player);
    await _dbContext.SaveChangesAsync();
}
catch(DbUpdateException ex)
{
    var message = ex.Message;
    throw;
}

两个建议（与您的问题没有直接关系）-

1. 从您的代码中删除所有.ConfigureAwait(false)。查看this answer 了解原因。
2. 不要将事务用于这样的单个插入操作；它会牺牲性能而没有任何好处。

编辑：
浏览您更新后的帖子中的代码，我看到您正在使用带有LastModified 字段的.ValueGeneratedOnAddOrUpdate() 配置，据我所知，此配置有一个已知问题。您甚至可能会在 EF Core 的 GitHub repo 上找到发布的问题。

我建议使用.ValueGeneratedOnAdd() 配置，与Created 字段一样，然后手动处理更新场景。