EF Core 9.0 中关于只读集合属性的迁移问题解析

在 EF Core 9.0 版本中，开发者在使用只读集合属性时遇到了一个特殊的迁移问题。这个问题表现为：当模型类中包含一个带有私有后备字段的 IReadOnlyCollection<string> 属性时，虽然数据库的创建和删除操作能够正常执行，但在尝试添加新的迁移时却会抛出异常。

问题现象

典型的错误场景如下：开发者在模型类中定义了一个只读集合属性，并为其配置了私有后备字段：

public class Model
{
    public int Id { get; set; }
    public IReadOnlyCollection<string> Uids => _uids.ToList();
    private List<string> _uids = [];
}

在 DbContext 中，开发者可能这样配置：

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

当执行 dotnet ef migrations add 命令时，系统会抛出以下异常：

System.InvalidOperationException: Cannot scaffold C# literals of type 'System.Reflection.NullabilityInfoContext'. The provider should implement CoreTypeMapping.GenerateCodeLiteral to support using it at design time.

问题根源

这个问题的根本原因在于 EF Core 9.0 中对集合属性的处理方式发生了变化。开发者使用了 Property() 方法来配置集合属性，而实际上对于原始类型集合（如字符串集合），应该使用 PrimitiveCollection() 方法。

EF Core 团队确认这是一个框架层面的问题，特别是在设计时（design-time）处理 NullabilityInfoContext 类型时出现了异常。这个问题不仅出现在 SQL Server 提供程序中，其他数据库提供程序（如 PostgreSQL）也报告了相同的问题。

解决方案

临时解决方案

在 EF Core 9.0.2 修复发布前，开发者可以采用以下两种临时解决方案：

1. 使用 PrimitiveCollection 替代 Property

modelBuilder.Entity<Model>().PrimitiveCollection(x => x.Uids).HasField("_uids");

2. 使用自定义值转换器

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

官方修复

EF Core 团队已经确认将在 9.0.2 版本中修复这个问题。修复预计在 2024 年 2 月中旬发布。

最佳实践建议

1. 集合属性配置：对于原始类型集合（如字符串、整数等），始终使用 PrimitiveCollection() 方法进行配置。

2. 只读集合模式：虽然只读集合模式（通过返回 ToList() 的副本来保护内部集合）是一种良好的实践，但在 EF Core 中需要特别注意配置方式。

3. 版本选择：如果项目依赖此功能，建议等待 9.0.2 版本发布后再升级，或者采用上述临时解决方案。

总结

这个问题展示了 EF Core 在处理复杂类型和设计时代码生成时的内部机制。开发者在使用只读集合属性时需要特别注意配置方法，避免使用不支持的 API 组合。EF Core 团队已经确认了这个问题并将很快发布修复，在此期间开发者可以选择使用 PrimitiveCollection 或自定义转换器作为临时解决方案。