如何在 EF Core Code First 中自定义迁移生成？

Question

我的DbContext. 当从它继承时，我需要生成一个额外的“SQL”迁移操作来为它创建一个特定的触发器。它通过检查重叠范围来确保表结构是一致的。由于在 SQL Server 中没有重叠的索引或检查约束，我必须使用触发器（在检查约束中使用函数会导致与迁移相同的问题以及 SQL 中的混乱函数“命名空间”）。

由于我在OnModelCreating考虑更改生成的迁移期间没有找到任何创建触发器的方法。但是怎么做呢？

尝试使用SqlServerMigrationsSqlGeneratorand SqlServerMigrationsAnnotationProvider，但顾名思义，它们仅在生成 SQL 命令期间的最后阶段使用。这使得它们在使用迁移时有点“隐藏”。在需要时难以定制并在之后进行维护。

考虑使用CSharpMigrationOperationGenerator这似乎非常适合我的需求。但是有一个问题 - 我无法访问这个类。也不是命名空间。

根据来源，此类驻留在Microsoft.EntityFrameworkCore.Migrations.Design命名空间中并且是公共的。为了访问它Microsoft.EntityFrameworkCore.Design，必须安装一个包。

但它不起作用。

我在这里缺少什么？如何访问和继承这个类？或者也许有更好和正确的方法在特定表的迁移期间自动创建触发器？

Answer 1

如何提供您自己的ICSharpMigrationOperationGenerator实现

考虑使用 CSharpMigrationOperationGenerator 这似乎非常适合我的需求。但是有一个问题 - 我无法访问这个类。也不是命名空间。

根据来源，此类驻留在 Microsoft.EntityFrameworkCore.Migrations.Design 命名空间中并且是公共的。为了访问它，必须安装 Microsoft.EntityFrameworkCore.Design 包。

但它不起作用。

我在这里缺少什么？如何访问和继承这个类？

假设您在设计时调用以下 CLI 命令来添加新迁移：

dotnet ef migrations add "SomeMigration"

这是一个完全工作的示例控制台程序，它将使用一个ICSharpMigrationOperationGenerator名为的自定义实现MyCSharpMigrationOperationGenerator，继承自CSharpMigrationOperationGenerator：

dotnet ef migrations add "SomeMigration"

的MyCSharpMigrationOperationGenerator类，输出为每个添加的表中的下列行作为证明它被称为：

using System;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.EntityFrameworkCore.Internal;
using Microsoft.EntityFrameworkCore.Migrations.Design;
using Microsoft.EntityFrameworkCore.Migrations.Operations;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace IssueConsoleTemplate
{
    public class MyCSharpMigrationOperationGenerator : CSharpMigrationOperationGenerator
    {
        public MyCSharpMigrationOperationGenerator(CSharpMigrationOperationGeneratorDependencies dependencies)
            : base(dependencies)
        {
        }

        protected override void Generate(CreateTableOperation operation, IndentedStringBuilder builder)
        {
            Console.WriteLine("\r\n\r\n---\r\nMyCSharpMigrationOperationGenerator was used\r\n---\r\n");
            base.Generate(operation, builder);
        }
    }
    
    public class MyDesignTimeServices : IDesignTimeServices
    {
        public void ConfigureDesignTimeServices(IServiceCollection services)
            => services.AddSingleton<ICSharpMigrationOperationGenerator, MyCSharpMigrationOperationGenerator>();
    }
    
    public class IceCream
    {
        public int IceCreamId { get; set; }
        public string Name { get; set; }
    }
    
    public class Context : DbContext
    {
        public DbSet<IceCream> IceCreams { get; set; }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder
                .UseSqlServer(@"Data Source=.\MSSQL14;Integrated Security=SSPI;Initial Catalog=So63575132")
                .UseLoggerFactory(
                    LoggerFactory.Create(
                        b => b
                            .AddConsole()
                            .AddFilter(level => level >= LogLevel.Information)))
                .EnableSensitiveDataLogging()
                .EnableDetailedErrors();
        }
    }

    internal static class Program
    {
        private static void Main()
        {
        }
    }
}

正如@KasbolatKumakhov 在他的评论中指出的那样，还应该提到引用的方式Microsoft.EntityFrameworkCore.Design 已经从 2.2改变了。到 3.0：

从 EF Core 3.0 开始，它是一个 DevelopmentDependency 包。这意味着依赖项不会传递到其他项目中，并且默认情况下您不能再引用其程序集。[...] 如果需要引用此包来覆盖 EF Core 的设计时行为，则可以更新项目中的 PackageReference 项元数据。

---
MyCSharpMigrationOperationGenerator was used
---

如何正确实现附加MigrationOperation（例如触发器创建）

由于我在 OnModelCreating 期间没有找到任何创建触发器的方法，所以我想改变生成的迁移。但是怎么做呢？

要正确执行此操作，您需要执行以下操作：

• 将您自己的注释添加到相关表格中（例如MyPrefix:Trigger）
• 实现你自己的MigrationOperation（例如CreateTriggerMigrationOperation）
• 提供您自己的IMigrationsModelDiffer实现（派生自MigrationsModelDiffer；这是内部的），返回您自己的MigrationOperation
• 提供您自己的ICSharpMigrationOperationGenerator实现（派生自CSharpMigrationOperationGenerator），然后为您自己生成 C# 代码MigrationOperation
• 提供您自己的IMigrationsSqlGenerator实现（派生自 SqlServerMigrationsSqlGenerator），然后处理将您自己的MigrationOperation实现转换为 SQL

Answer 2

这并不完全是您所要求的，但它以低成本完成类似的工作，并且可能对某人来说很方便。

using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Migrations.Operations;

public static class MigrationBuilderExtensions
{
    public static void ConfigForOracle(this MigrationBuilder migrationBuilder)
    {
        //For each table registered in the builder, let's create a sequence and a trigger
        foreach (CreateTableOperation createTableOperation in migrationBuilder.Operations.ToArray().OfType<CreateTableOperation>())
        {
            string tableName = createTableOperation.Name;
            string primaryKey = createTableOperation.PrimaryKey.Columns[0];
            migrationBuilder.CreateSequence<int>(name: $"SQ_{tableName}", schema: createTableOperation.Schema);
            migrationBuilder.Sql($@"CREATE OR REPLACE TRIGGER ""TR_{tableName}""
                                    BEFORE INSERT ON ""{tableName}""
                                    FOR EACH ROW
                                    WHEN (new.""{primaryKey}"" IS NULL)
                                    BEGIN
                                        SELECT ""SQ_{tableName}"".NEXTVAL
                                        INTO   :new.""{primaryKey}""
                                        FROM   dual;
                                    END;");
        }
    }
}

您可以在扩展方法中执行任何您想要的操作，然后在方法的末尾调用它Migration.Up()。我使用它为 Oracle 11g 表创建序列和触发器以实现标识符增量。

Answer 3

我认为它并不是为了修改 ef core csharp 代码生成。但是为了生成自定义迁移语句（在我的例子中是触发器），我使用 SqlOperation 执行以下操作（缩短为相关）。

实施模型不同

public class MyMigrationsModelDiffer : MigrationsModelDiffer {

  public MyMigrationsModelDiffer(IRelationalTypeMappingSource typeMappingSource,
    IMigrationsAnnotationProvider migrationsAnnotations,
    IChangeDetector changeDetector,
    IUpdateAdapterFactory updateAdapterFactory,
    CommandBatchPreparerDependencies commandBatchPreparerDependencies)
    : base(typeMappingSource, migrationsAnnotations, changeDetector, updateAdapterFactory, commandBatchPreparerDependencies) { }

  protected override IEnumerable<MigrationOperation> Diff(IModel source, IModel target, DiffContext diffContext) {
    return base.Diff(source, target, diffContext).Concat(GetTriggerTriggerDifferences(source, target));
  }

  public override Boolean HasDifferences(IModel source, IModel target) {
    return base.HasDifferences(source, target) || HasTriggerAnnotationDifferences(source, target);
  }

  public IEnumerable<MigrationOperation> GetTriggerTriggerDifferences(IModel source, IModel target) {
    if (source == null || target == null) {
      return new new List<MigrationOperation>(0);
    }

    Dictionary<String, IAnnotation> triggerAnnotationPerEntity = new Dictionary<String, IAnnotation>();
    foreach (var entityType in source.GetEntityTypes()) {
      triggerAnnotationPerEntity[entityType.Name] = GetTableAnnotation(entityType);
    }
    var operations = new List<MigrationOperation>();
    foreach (var entityType in target.GetEntityTypes()) {
      triggerAnnotationPerEntity.TryGetValue(entityType.Name, out IAnnotation sourceTriggerTable);
      IAnnotation targetTriggerTable = GetTableAnnotation(entityType);

      if (targetTriggerTable?.Value == sourceTriggerTable?.Value) {
        continue;
      }

      Boolean isCreate = targetTriggerTable != null;
      String tableName = (entityType as EntityType)?.GetTableName();
      String primaryKey = entityType.FindPrimaryKey().Properties[0].Name;
      if (isCreate) {
        SqlOperation sqlOperation = new SqlOperation();
        sqlOperation.Sql = $@"CREATE TRIGGER...";
        operations.Add(sqlOperation);
      }
      else {
        // drop trigger sqloperation
      }
    }
    return operations;
  }

  private static IAnnotation GetTableAnnotation(IEntityType entityType) {
    return entityType.GetAnnotations()?.FirstOrDefault(x => x.Name == "WantTrigger");
  }

  public Boolean HasTriggerAnnotationDifferences(IModel source, IModel target) {
    return GetTriggerTriggerDifferences(source, target).Any();
  }
}

替换 DbContext 中不同的模型

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
  base.OnConfiguring(optionsBuilder);
  if (optionsBuilder == null) {
    return;
  }
  optionsBuilder.ReplaceService<IMigrationsModelDiffer, MyMigrationsModelDiffer>();
}

用注释标记所需的模型。

builder.Entity<MyTable>().HasAnnotation("WantTrigger", "1.0");