Service Fabric解决方案中使用dotnet ef CLI的最佳实践咨询

我之前在Service Fabric项目里整合dotnet ef CLI时也踩过类似的坑，下面是几个经过实践验证的最佳方案，能帮你兼顾Service Fabric的配置管理和EF工具的正常使用：

这个方案核心是让Service Fabric和dotnet ef共用同一套环境变量来获取连接字符串，避免重复配置：

• 先在一个共享的类库项目里定义统一的配置键，比如：

  public static class DbConfigurationKeys
  {
      public const string DefaultConnection = "DefaultDbConnection";
  }
  

• 在Service Fabric的ApplicationManifest.xml中，给每个需要访问数据库的服务添加环境变量：

  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="YourServicePkg" ServiceManifestVersion="1.0.0"/>
    <EnvironmentVariables>
      <EnvironmentVariable Name="DefaultDbConnection" Value="Server=your-server;Database=your-db;User Id=xxx;Password=xxx"/>
    </EnvironmentVariables>
  </ServiceManifestImport>
  

• 在服务项目的启动代码（比如Program.cs）里，通过环境变量读取连接字符串并配置DbContext：

  var connectionString = Environment.GetEnvironmentVariable(DbConfigurationKeys.DefaultConnection) 
                         ?? throw new InvalidOperationException("数据库连接字符串未配置");
  
  builder.Services.AddDbContext<YourDbContext>(options => 
      options.UseSqlServer(connectionString));
  

• 使用dotnet ef时，只需要在命令行先设置环境变量，再执行命令（以Windows为例）：

  set DefaultDbConnection="Server=local-dev;Database=your-db;Trusted_Connection=True"
  dotnet ef migrations add InitialCreate --project YourServiceProject --startup-project YourServiceProject
  

  或者在服务项目的launchSettings.json里添加环境变量，这样用Visual Studio的Package Manager Console执行ef命令时会自动读取。

如果更习惯用Service Fabric的配置包管理配置，可以通过分支判断让EF工具读取本地配置，服务运行时读取配置包：

• 在Service Fabric应用项目中添加Config配置包，在Settings.xml里定义连接字符串：

  <Section Name="DatabaseSettings">
    <Parameter Name="ConnectionString" Value="Server=prod-server;Database=your-db;User Id=xxx;Password=xxx"/>
  </Section>
  

• 在服务项目的启动代码里，通过环境变量判断是否是EF CLI环境，分别读取配置：

  string connectionString;
  var isEfCli = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("EF_CLI_MODE"));
  
  if (isEfCli)
  {
      // EF CLI环境：读取本地appsettings.json
      connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
  }
  else
  {
      // Service Fabric运行环境：读取配置包
      var activationContext = FabricRuntime.GetActivationContext();
      var configPackage = activationContext.GetConfigurationPackageObject("Config");
      connectionString = configPackage.Settings.Sections["DatabaseSettings"]
                          .Parameters["ConnectionString"].Value;
  }
  
  builder.Services.AddDbContext<YourDbContext>(options => 
      options.UseSqlServer(connectionString));
  

• 在服务项目的appsettings.json里添加本地开发用的连接字符串：

  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=YourLocalDb;Trusted_Connection=True"
  }
  

• 执行EF命令时，指定EF环境变量：

  set EF_CLI_MODE=true
  dotnet ef migrations add InitialCreate --project YourServiceProject --startup-project YourServiceProject
  

如果只是偶尔执行EF操作，不想改代码，可以直接在命令里指定连接字符串：

dotnet ef migrations add InitialCreate --project YourServiceProject --startup-project YourServiceProject --connection "Server=(localdb)\\mssqllocaldb;Database=YourLocalDb;Trusted_Connection=True"

这个方案适合临时测试，但不适合日常频繁操作，毕竟每次输入长串连接字符串效率太低。

额外注意事项 #

• 必须指定正确的启动项目：dotnet ef只能识别.NET项目，所以执行命令时--startup-project必须指向服务的.NET项目，而不是Service Fabric的.sfproj。
• 迁移自动应用：部署到Service Fabric时，建议在服务启动时自动应用迁移，避免手动操作：

  using (var scope = app.Services.CreateScope())
  {
      var dbContext = scope.ServiceProvider.GetRequiredService<YourDbContext>();
      dbContext.Database.Migrate();
  }
  

• 环境区分：可以通过Service Fabric的ApplicationParameters（比如Local.xml、Cloud.xml）来配置不同环境的连接字符串，不用修改ApplicationManifest.xml本身。

内容的提问来源于stack exchange，提问作者Minos