EntityFramework Core 9.0 迁移生成异常问题解析

问题背景

在使用 EntityFramework Core 9.0 版本时，开发者遇到了一个关于迁移生成的异常问题。当模型类中包含带有私有后备字段的只读集合属性时，执行 dotnet ef migrations add 命令会抛出 System.InvalidOperationException 异常，提示无法为 System.Reflection.NullabilityInfoContext 类型生成 C# 字面量。

问题重现

典型的问题场景出现在以下代码结构中：

public class Model
{
    public int Id { get; set; }
    
    public IReadOnlyCollection<string> Uids => _uids.ToList();
    private List<string> _uids = [];
    
    public void AddUids(IEnumerable<string> uids)
    {
        _uids.AddRange(uids);
    }
    
    public void RemoveUids(IEnumerable<string> uids)
    {
        foreach (var uid in uids)
        {
            _uids.Remove(uid);
        }
    }
}

在 DbContext 中配置时，如果使用 Property 方法来映射这个集合属性：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Model>().Property(x => x.Uids).HasField("_uids");
}

这种情况下，虽然数据库创建和删除操作 (EnsureCreated/EnsureDeleted) 能够正常工作，但在尝试生成迁移时会抛出异常。

问题原因

这个问题的根本原因在于 EntityFramework Core 9.0 对只读集合属性的处理机制。当使用 Property 方法映射集合属性时，EF Core 内部会尝试处理属性的可空性信息，但在处理 NullabilityInfoContext 类型时遇到了困难。

实际上，对于集合类型的属性，特别是原始类型集合（如 List<string>），应该使用 PrimitiveCollection 方法而不是 Property 方法进行配置。

解决方案

推荐解决方案

正确的配置方式应该是使用 PrimitiveCollection 方法：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Model>().PrimitiveCollection(x => x.Uids).HasField("_uids");
}

这种方法能够正确处理集合属性，并且不会在生成迁移时抛出异常。

临时解决方案

如果由于某些原因必须使用 Property 方法，可以添加自定义的值转换器和比较器：

builder.Property(x => x.Uids).HasField("_uids")
    .HasConversion(
        v => JsonConvert.SerializeObject(v),
        v => JsonConvert.DeserializeObject<List<string>>(v)!,
        ReadOnlyCollectionValueComparer<string>.Create());

不过这种方法不如使用 PrimitiveCollection 方法优雅，且可能带来额外的性能开销。

最佳实践

1. 集合属性映射：对于原始类型的集合属性，始终使用 PrimitiveCollection 方法进行配置。

2. 只读属性模式：虽然使用只读属性和后备字段是一种良好的封装实践，但在 EF Core 中需要特别注意配置方式。

3. 版本兼容性：这个问题在 EF Core 9.0 中已经确认，并将在 9.0.2 版本中修复。在此之前，使用推荐的 PrimitiveCollection 方法可以避免问题。

技术背景

只读集合属性的设计考虑

使用 IReadOnlyCollection<T> 作为公共接口，而内部使用 List<T> 作为后备存储，是一种常见的防御性编程模式。这种模式可以防止外部代码意外修改集合内容，同时保持内部修改的灵活性。

EF Core 中的集合处理

在 EF Core 中，集合属性的处理有以下几种方式：

1. 导航属性：用于表示实体间的关系
2. 原始集合：用于存储原始类型（如 string, int 等）的集合
3. 值对象集合：用于存储复杂类型的集合

对于原始集合，EF Core 9.0 引入了专门的 PrimitiveCollection 配置方法，提供了更好的类型支持和性能优化。

总结

当在 EntityFramework Core 9.0 中使用只读集合属性时，开发者应当注意使用正确的配置方法。对于原始类型集合，优先使用 PrimitiveCollection 而不是 Property 方法进行配置。这不仅能够避免迁移生成时的异常，也能确保代码的清晰性和可维护性。

这个问题预计将在 EF Core 9.0.2 版本中得到修复，但在修复发布前，采用正确的配置方法是解决此问题的最佳途径。