如何从共享类库NuGet包应用EF Core数据库架构及统一迁移

1. 迁移与架构应用的正确位置 #

不要直接在共享类库中执行EF命令——类库本身没有运行时配置，无法独立承载EF的迁移逻辑。最优方案是：

• 创建一个独立的迁移专用项目（比如命名为YourProject.Migrations），作为迁移的"宿主"。
• 让该项目引用你的共享DBContext类库，所有迁移文件统一存放在此项目的Migrations文件夹下。
• 所有消费者项目无需单独维护迁移，只需引用共享DBContext类库，迁移操作完全通过这个专用项目执行。

2. 数据库连接配置的处理 #

在迁移专用项目中提供配置，让EF能定位数据库：

• 添加appsettings.json文件存储连接字符串：

  {
    "ConnectionStrings": {
      "DefaultConnection": "Server=your-server;Database=your-db;User Id=xxx;Password=xxx;"
    }
  }
  

• 在项目的Program.cs中配置DBContext并读取配置：

  var configuration = new ConfigurationBuilder()
      .SetBasePath(Directory.GetCurrentDirectory())
      .AddJsonFile("appsettings.json")
      .Build();
  
  var optionsBuilder = new DbContextOptionsBuilder<YourDbContext>();
  optionsBuilder.UseSqlServer(configuration.GetConnectionString("DefaultConnection"));
  

• 执行EF命令时指定该项目为启动项目：

  dotnet ef migrations add InitialCreate --project YourProject.Migrations --startup-project YourProject.Migrations
  dotnet ef database update --project YourProject.Migrations --startup-project YourProject.Migrations
  

3. 多消费者项目的迁移复用 #

多个消费者项目共用迁移的方式：

• 所有消费者项目直接使用共享类库中的DBContext，无需自行添加迁移。
• 部署时，运行迁移专用项目的dotnet ef database update命令（或封装成可执行文件嵌入部署流程），即可将最新架构应用到目标数据库。
• 若不同消费者需要对接不同数据库实例，只需修改迁移专用项目的appsettings.json，或通过命令行参数传递连接字符串：

  dotnet ef database update --project YourProject.Migrations --startup-project YourProject.Migrations --connection "Server=consumer-server;Database=consumer-db;..."
  

4. 迁移维护的注意事项 #

• 所有DBContext实体模型的修改都在共享类库中完成，然后在迁移专用项目中生成新的迁移文件，确保迁移逻辑统一。
• 将迁移专用项目的Migrations文件夹纳入版本控制，让所有消费者共享同一套迁移脚本。
• 禁止在消费者项目中执行add-migration或update-database命令，避免出现分散的迁移文件。

内容的提问来源于stack exchange，提问作者Brandon Piña