如何覆盖默认的SQL迁移生成器？

免责声明：我已经很多年没有用VB编写代码了，这些代码示例是我将C＃中的工作示例转换为OPs本机VB时的无用尝试。请随时更新我的​​语法;）

您可以通过在create table语句的一部分中调用Tablebuilder.ForeignKey时为可选参数指定值，来手动编辑迁移脚本以为每个脚本指定一个自定义名称：ForeignKeyName

CreateTable(
  "dbo.CorporationVariety",
  Function(c) New With
    {
      .Id = c.Int(nullable: false, identity:= true),
      .CorporationId = c.Int(nullable:= false),
      .VarietyId = c.Int(nullable:= false),
    }) _
  .PrimaryKey(Function(t) t.Id)
  .ForeignKey("dbo.Corporation", Function(t) t.CorporationId, name := "FKCorporatationCorporationVarietyCorporationId")
  .ForeignKey("dbo.Variety", Function(t) t.VarietyId, name := "FKVarietyCorporationVarietyVarietyId")
  .Index(Function(t) t.CorporationId)
  .Index(Function(t) t.VarietyId)

或作为DbMigration.AddForeignKey语句的一部分：

AddForeignKey("dbo.CorporationVariety", "CorporationId", "dbo.Corporation", name := "FKCorporatationCorporationVarietyCorporationId")
AddForeignKey("dbo.CorporationVariety", "VarietyId", "dbo.Variety", name := "FKVarietyCorporationVarietyVarietyId")

如果您的模型中有很多键，并且您想在所有键上实施特定的约定（如要在给定场景中应用的标准规则或代码序列），那么通常是第一个要查找的位置解决方案是EF Code First Conventions。

不幸的是，既没有标准的约定可以帮助您，也不能使用流利的符号为外键定义自定义名称...

通常，我们会继续创建“自定义代码优先约定”来定义您的自定义逻辑，这通常以两种方式起作用：

1. 您的约定通过Fluent表示法执行标准配置
   • 我们已经注意到该选项对我们不可用...
2. 您的约定逻辑通过注释将自定义元数据存储到模型中

在EF Code First Runtime中，主键和外键似乎是异常的，associations即使它们相对容易定义，似乎也没有一种方法可以轻松地从中访问注释。

我很惊讶地发现了这一点，偶然发现了进一步证实这一点的帖子：https : //stackoverflow.com/a/54369685/1690217

更新我在开始本文时假设公约是正确的方法，因为多年来我将其用于许多其他需要应用的定制。如果要实现其他类似类型的自定义，请首先查看“约定”。

我们仍然可以轻松地覆盖VisualBasicMigrationCodeGenerator生成迁移代码文件的标准，因此让我们直接跳入其中。共同应用到您的自定义名称ForeignKey，然后实现自定义的MigrationCodeGenerator来处理约定的输出。

1. 创建一个自定义 VisualBasicMigrationCodeGenerator
2. 注册代码生成器，以便EF将其用于生成下一个迁移

注意：这不会强制重命名数据库中的现有密钥。为此，您需要强制删除每个密钥并重新添加回去。对于大型模型，考虑到上述步骤，请考虑使用T4模板创建自定义的一次性迁移逻辑以实现此目的。

将您的Custom VisualBasicMigrationCodeGenerator视为您的个人EF代码第一个发酵面团文化，您可以共享此知识并将其用于每个新应用程序，并在每次迭代中添加新功能和改进。但是约定是您可能不需要在每个项目中使用的配置选项（这就是为什么将_Conventions_用于OP解决方案是我的第一个方向。）

1.创建一个自定义VisualBasicMigrationCodeGenerator

创建一个继承自EF VisualBasicMigrationCodeGenerator的新类，我们要做的最小工作就是重写AddForeignKeyOperation和修改键的Name并调用基本实现。这将影响添加到模型中的所有新键。

为了定位作为CreateTable的一部分添加的键，我们将必须重写GenerateInline(AddForeignKeyOperation...)，但是基本实现（在C＃Generator中）不遵循自定义名称，因此我们必须完全替换实现。

• 执行此操作时，转到GitHub上的EF项目并从原始实现开始，然后根据需要注入您的自定义项。

请原谅这个C＃，我没有时间翻译它，尽管它确实会生成正确的VB代码；）

public class CustomVBMigrationCodeGenerator : System.Data.Entity.Migrations.Design.VisualBasicMigrationCodeGenerator
{

    protected override void Generate(AddForeignKeyOperation addForeignKeyOperation, IndentedTextWriter writer)
    {
        ApplyCustomFKName(addForeignKeyOperation);
        base.Generate(addForeignKeyOperation, writer);
    }

    private void ApplyCustomFKName(ForeignKeyOperation operation)
    {
        // expecting FK without scheme or underscores: "FK{DependentTable}{PrincipalTable}{FKField}"
        operation.Name = $"FK{StripSchemeFromName(operation.DependentTable)}{StripSchemeFromName(operation.PrincipalTable)}{String.Join("", operation.DependentColumns)}";
    }
    private string StripSchemeFromName(string dbObjectName)
    {
        return dbObjectName.Split(new[] { '.' }, 2).Last();
    }

    /// <summary>
    /// Generates code to perform an <see cref="AddForeignKeyOperation" /> as part of a <see cref="CreateTableOperation" />.
    /// </summary>
    /// <param name="addForeignKeyOperation"> The operation to generate code for. </param>
    /// <param name="writer"> Text writer to add the generated code to. </param>
    protected virtual void GenerateInline(AddForeignKeyOperation addForeignKeyOperation, IndentedTextWriter writer)
    {
        // sourced from https://github.com/aspnet/EntityFramework6/blob/master/src/EntityFramework/Migrations/Design/VisualBasicMigrationCodeGenerator.cs
        Check.NotNull(addForeignKeyOperation, "addForeignKeyOperation");
        Check.NotNull(writer, "writer");

        writer.WriteLine(" _");
        writer.Write(".ForeignKey(" + Quote(addForeignKeyOperation.PrincipalTable) + ", ");
        Generate(addForeignKeyOperation.DependentColumns, writer);

        // Our Custom logic
        ApplyCustomFKName(addForeignKeyOperation);

        // Insert our custom name if provided
        if (!addForeignKeyOperation.HasDefaultName)
        {
            writer.Write(", name := " + Quote(addForeignKeyOperation.Name));
        }

        if (addForeignKeyOperation.CascadeDelete)
        {
            writer.Write(", cascadeDelete := True");
        }

        writer.Write(")");
    }
}

2.注册代码生成器，以便EF使用它来生成下一个迁移

在您的项目中找到Configuration.vb，将构造方法设置CodeGenerator为您的实例CustomVBMigrationCodeGenerator：

Public Sub New()

  AutomaticMigrationsEnabled = false
  CodeGenerator = new CustomVBMigrationCodeGenerator()

End Sub

现在执行add-migration来生成新的迁移，您将看到在迁移脚本中定义的新的自定义名称。

Generate(DropForeignKeyOperation...)如果您需要从此配置_or_降级，并且如果alter table命令要求先删除密钥，则可能需要同样重写这些方法。