c# - 如何关闭 Entity Framework Core 5 中的所有约定

我想关掉全部 (或至少大部分)Entity Framework Core 中的约定(我说的是 EF Core 5 或更高版本)，然后“手动”构建整个模型。
有人可能想知道为什么 .
这就是为什么 :我的任务是将几个大型遗留数据库从 Entity Framework 6 (EF) 迁移到 Entity Framework Core 5 (EFC)。这涉及数百个表和几个数据库。其中一些数据库是使用 Code First 方法创建的，而有些只是第三方数据库，我们需要从 C# 代码中查询和更新这些数据库。对于后面的数据库，我们必须完全匹配它们的模式。
由于问题的规模，EF和 EFC比方说，代码的风格必须共存几个月。这可以通过使用条件编译轻松实现(见下文)。
很可能是 EFC 中不支持或不方便支持的任何内容与 EF 相比(或被“入侵”到 EF 模型中)，如空间索引、多列 KeyAttribute PK，多列 ForeignKeyAttribute FK、自引用多个乘法表、在同一列上定义的多个索引(有些是过滤器，有些只是常规索引)等等等等。
没关系。我可以轻松处理EFC 无力通过使用条件编译“覆盖”属性来处理这个问题，例如

#if EFCORE
using Key = MyKeyAttribute;
using Column = MyColumnAttribute;
using Index = MyIndexAttribute;
using ForeignKey = MyForeignKeyAttribute;
#endif

然后对于每个 MyProject.csproj创建 MyProject_EFC.csproj在哪里 EFCORE已定义，然后使用反射“收集”所有这些自定义属性，然后使用 EFC流利的 API 来配置 EFC 的所有内容做不到。因此，遗留 ( EF ) 代码仍将看到原始代码，例如KeyAttribute然后跟随EF路线，而 EFC代码将看不到这些属性，因为它们已被重新定义。所以，它不会提示。 我已经有了所有的代码，它可以工作，也许我会在某个时候把它放在这里或放在 GitHub 中，但不是今天 .
让我抓狂的是，无论我做什么，EFC设法“潜入”阴影属性和类似的蹩脚的东西。这到了我真的想关闭 的地步。全部 EFC约定并手动构建整个模型。毕竟，我已经在这样做了，就像 90% 的模型一样。我宁愿想要 EFC throw(带有有意义的错误消息)而不是默默地做任何我不希望它做的事情。
遵循@IvanStoev 的建议，这是我目前所拥有的:

public static IModel CreateModel<TContext, TContextInfo>(Action<ModelBuilder, TContextInfo>? modifier = null)
    where TContext : DbContext, ISwyfftDbContext
    where TContextInfo : ContextInfo<TContext>, new()
{
    var contextInfo = new TContextInfo();
    var modelBuilder = new ModelBuilder();

    modelBuilder
        .HasKeys<TContext, TContextInfo>(contextInfo)
        .HasColumnNames<TContext, TContextInfo>(contextInfo)
        .ToTables<TContext, TContextInfo>(contextInfo)
        .DisableCascadeDeletes()
        .HasDefaultValues<TContext, TContextInfo>(contextInfo)
        .HasComputedColumns<TContext, TContextInfo>(contextInfo)
        .HasForeignKeys<TContext, TContextInfo>(contextInfo)
        .HasDatabaseIndexes<TContext, TContextInfo>(contextInfo);

    modifier?.Invoke(modelBuilder, contextInfo);
    var model = modelBuilder.FinalizeRelationalModel();
    return model;
}

private static IModel FinalizeRelationalModel(this ModelBuilder modelBuilder)
{
    var model = modelBuilder.Model;
    var conventionModel = model as IConventionModel;
    var databaseModel = new RelationalModel(model);
    conventionModel.SetAnnotation(RelationalAnnotationNames.RelationalModel, databaseModel);
    return modelBuilder.FinalizeModel();
}

在哪里 HasKeys , HasColumnNames等是我[较早]编写的扩展方法，用于继续使用多列 PK、Fs 等，EFC 不支持。和 conventionModel.SetAnnotation(RelationalAnnotationNames.RelationalModel, databaseModel)是强制性的，否则不会创建模型并且代码会因 NRE 而失败。
所以，当我坚持这个 CreateModel进入 DbContextOptions :

public static DbContextOptions<TContext> GetDbContextOptions(string connectionString, Func<IModel> modelCreator) =>
    new DbContextOptionsBuilder<TContext>()
        .UseModel(modelCreator())
        .UseSqlServer(connectionString, x => x.UseNetTopologySuite())
        .Options;

并通过运行例如创建迁移Add-Migration Initial然后 ModelSnapshot最终结果是正确的，没有垃圾阴影属性，也没有其他废话 EFC在这里或那里插入所有约定。但是，当我尝试查询任何表时，代码失败并显示:

(InvalidOperationException) Sequence contains no elements; 
Sequence contains no elements (   at System.Linq.ThrowHelper.ThrowNoElementsException()
   at System.Linq.Enumerable.Single[TSource](IEnumerable`1 source)
   at Microsoft.EntityFrameworkCore.Query.SqlExpressions.SelectExpression..ctor(IEntityType entityType, ISqlExpressionFactory sqlExpressionFactory)
   at Microsoft.EntityFrameworkCore.Query.SqlExpressionFactory.Select(IEntityType entityType)
   at Microsoft.EntityFrameworkCore.Query.RelationalQueryableMethodTranslatingExpressionVisitor.CreateShapedQueryExpression(IEntityType entityType)
   at Microsoft.EntityFrameworkCore.Query.QueryableMethodTranslatingExpressionVisitor.VisitExtension(Expression extensionExpression)
   at Microsoft.EntityFrameworkCore.Query.RelationalQueryableMethodTranslatingExpressionVisitor.VisitExtension(Expression extensionExpression)
   at System.Linq.Expressions.Expression.Accept(ExpressionVisitor visitor)
   at System.Linq.Expressions.ExpressionVisitor.Visit(Expression node)
   at Microsoft.EntityFrameworkCore.Query.QueryCompilationContext.CreateQueryExecutor[TResult](Expression query)
   at Microsoft.EntityFrameworkCore.Storage.Database.CompileQuery[TResult](Expression query, Boolean async)
   at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.CompileQueryCore[TResult](IDatabase database, Expression query, IModel model, Boolean async)
   at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.<>c__DisplayClass9_0`1.<Execute>b__0()
   at Microsoft.EntityFrameworkCore.Query.Internal.CompiledQueryCache.GetOrAddQuery[TResult](Object cacheKey, Func`1 compiler)
   at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.Execute[TResult](Expression query)
   at Microsoft.EntityFrameworkCore.Query.Internal.EntityQueryProvider.Execute[TResult](Expression expression)
   at Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.ToQueryString(IQueryable source)

这意味着 RelationalModel严重不完整。
任何进一步的想法将不胜感激。非常感谢!

最佳答案

可以通过构建 IModel 用手

static IModel CreateModel(/* args */)
{
    var modelBuilder = new ModelBuilder();
    // Build the model using the modelBuilder
    // ...
    return modelBuilder.FinalizeModel();
}

这里最重要的是使用无参数 ModelBuilder() 构造函数

Initializes a new instance of the ModelBuilder class with no conventions

然后使用 UseModel 将其与上下文相关联。方法，例如在目标上下文中 OnConfiguring覆盖

optionsBuilder.UseModel(CreateModel())

使用这种方法，OnModelCreating不使用目标上下文。
这应该可以达到您的要求。但请注意使用过的 ModelBuilder 的警告构造函数:

Warning: conventions are typically needed to build a correct model.

因此，您必须非常小心地明确映射所有内容。另一方面，EF Core 迁移内部使用完全相同的方法(BuildTargetModel 文件中的生成方法 .designer.cs)在类可能不存在或可能完全不同的位置生成模型，因此应该是如果使用得当，这是一个可行的选择。

更新:事实证明，警告中的“通常需要约定来构建正确的模型”实际上意味着约定(至少其中一些)对于构建正确的运行时模型确实是强制性的，因为它们用于执行一些控制运行时的操作行为。
最引人注目的是RelationalModelConvention它创建关系模型(表、列等)映射，以及 TypeMappingConvention它创建提供者数据类型映射。因此，这两个是强制性的。但谁知道呢，可能还有更多。并且允许扩展添加自己的。
因此，在进一步阅读之前，请考虑使用所有约定的标准方法。严重地。流畅的配置具有更高的优先级(约定 < 数据注释 < 流畅(显式))，因此如果您显式配置所有内容，则不应遇到意外的影子、鉴别器等属性问题。
现在，如果您想继续危险的道路，您应该创建所需的最小约定，或者更好的是，删除导致您出现问题的不需要的约定。公共(public) EF Core 5.x 修改约定的方法是注册自定义 IConventionSetPlugin 具有单一方法的实现

public ConventionSet ModifyConventions (ConventionSet conventionSet);

它允许您修改(替换、添加、删除)默认约定，甚至返回一个全新的约定集。
注册这样的插件并不容易，需要一堆管道(即使是样板)代码。但它是首选，因为它允许您删除特定的约定(只需注意约定类可以实现几个约定相关的接口(interface)，因此必须从几个 ConventionSet 列表中删除)，并且强制约定类具有额外的依赖项和使用用于解决它们的 DI 容器，因此从外部创建它们并不容易(如果不是不可能的话)。
话虽如此，这里有一个示例实现，它删除了所有约定，只保留在 ModelFinalizingConventions 中注册的那些。和 ModelFinalizedConventions这似乎对于构建正常运行的运行时模型至关重要:

using System.Collections.Generic;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.EntityFrameworkCore.Metadata.Conventions.Infrastructure;
using Microsoft.EntityFrameworkCore.Infrastructure;

namespace Microsoft.EntityFrameworkCore.Metadata.Conventions.Infrastructure
{
    public class CustomConventionSetPlugin : IConventionSetPlugin
    {
        public ConventionSet ModifyConventions(ConventionSet conventionSet)
        {
            conventionSet.EntityTypeAddedConventions.Clear();
            conventionSet.EntityTypeAnnotationChangedConventions.Clear();
            conventionSet.EntityTypeBaseTypeChangedConventions.Clear();
            conventionSet.EntityTypeIgnoredConventions.Clear();
            conventionSet.EntityTypeMemberIgnoredConventions.Clear();
            conventionSet.EntityTypePrimaryKeyChangedConventions.Clear();
            conventionSet.ForeignKeyAddedConventions.Clear();
            conventionSet.ForeignKeyAnnotationChangedConventions.Clear();
            conventionSet.ForeignKeyDependentRequirednessChangedConventions.Clear();
            conventionSet.ForeignKeyRequirednessChangedConventions.Clear();
            conventionSet.ForeignKeyUniquenessChangedConventions.Clear();
            conventionSet.IndexAddedConventions.Clear();
            conventionSet.IndexAnnotationChangedConventions.Clear();
            conventionSet.IndexRemovedConventions.Clear();
            conventionSet.IndexUniquenessChangedConventions.Clear();
            conventionSet.KeyAddedConventions.Clear();
            conventionSet.KeyAnnotationChangedConventions.Clear();
            conventionSet.KeyRemovedConventions.Clear();
            conventionSet.ModelAnnotationChangedConventions.Clear();
            //conventionSet.ModelFinalizedConventions.Clear();
            //conventionSet.ModelFinalizingConventions.Clear();
            conventionSet.ModelInitializedConventions.Clear();
            conventionSet.NavigationAddedConventions.Clear();
            conventionSet.NavigationAnnotationChangedConventions.Clear();
            conventionSet.NavigationRemovedConventions.Clear();
            conventionSet.PropertyAddedConventions.Clear();
            conventionSet.PropertyAnnotationChangedConventions.Clear();
            conventionSet.PropertyFieldChangedConventions.Clear();
            conventionSet.PropertyNullabilityChangedConventions.Clear();
            conventionSet.PropertyRemovedConventions.Clear();
            conventionSet.SkipNavigationAddedConventions.Clear();
            conventionSet.SkipNavigationAnnotationChangedConventions.Clear();
            conventionSet.SkipNavigationForeignKeyChangedConventions.Clear();
            conventionSet.SkipNavigationInverseChangedConventions.Clear();
            conventionSet.SkipNavigationRemovedConventions.Clear();
            return conventionSet;
        }
    }
}

// Boilerplate for regigistering the plugin

namespace Microsoft.EntityFrameworkCore.Infrastructure
{
    public class CustomConventionSetOptionsExtension : IDbContextOptionsExtension
    {
        public CustomConventionSetOptionsExtension() { }
        ExtensionInfo info;
        public DbContextOptionsExtensionInfo Info => info ?? (info = new ExtensionInfo(this));
        public void Validate(IDbContextOptions options) { }
        public void ApplyServices(IServiceCollection services)
            => services.AddSingleton<IConventionSetPlugin, CustomConventionSetPlugin>();
        sealed class ExtensionInfo : DbContextOptionsExtensionInfo
        {
            public ExtensionInfo(CustomConventionSetOptionsExtension extension) : base(extension) { }
            public override bool IsDatabaseProvider => false;
            public override string LogFragment => string.Empty;
            public override void PopulateDebugInfo(IDictionary<string, string> debugInfo) { }
            public override long GetServiceProviderHashCode() => 1234;
        }
    }
}

namespace Microsoft.EntityFrameworkCore
{
    public static partial class CustomDbContextOptionsExtensions
    {
        public static DbContextOptionsBuilder UseCustomConventionSet(this DbContextOptionsBuilder optionsBuilder)
        {
            if (optionsBuilder.Options.FindExtension<CustomConventionSetOptionsExtension>() == null)
                ((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(new CustomConventionSetOptionsExtension());
            return optionsBuilder;
        }
    }
}

它提供了一个方便的Use扩展方法类似于其他扩展，所以你只需要在配置过程中调用它，例如在 OnConfiguring覆盖

optionsBuilder.UseCustomConventionSet();

或以您的示例

public static DbContextOptions<TContext> GetDbContextOptions(string connectionString, Func<IModel> modelCreator) =>
    new DbContextOptionsBuilder<TContext>()
        .UseSqlServer(connectionString, x => x.UseNetTopologySuite())
        .UseCustomConventionSet()
        .Options;

OnConfiguring虽然是首选，因为这与数据库提供程序无关，并且也不像原始建议那样使用外部模型创建(和 UseModel ) - 流畅的配置可以追溯到 OnModelCreating覆盖。

关于c# - 如何关闭 Entity Framework Core 5 中的所有约定，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/67746656/

c# - 如何关闭 Entity Framework Core 5 中的所有约定

上一篇：android - 如何使用导航组件管理权限请求代码？

下一篇：c - 在命令完成之前，C 中的 popen 会阻塞吗？