.NET 7多项目中Worker控制台应用EF连接字符串配置最佳实践

问题背景 #

我创建了三个.NET 7项目：API、Database、Worker。Database项目中已配置DbContext，API和Worker项目均引用该项目。API项目采用最小托管模型，通过如下代码配置数据库连接：

var builder = WebApplication.CreateBuilder(args);
....

builder.Services.AddDbContext<EnergyPricesContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"))
);

但Worker项目是控制台应用，无法直接使用上述代码，因为它没有builder、依赖注入，也没有appsettings.json文件。我曾考虑创建包含appsettings.json和Startup文件的bootstrap项目供所有项目引用，但认为这并非良策。请问在多项目场景下，配置数据库连接字符串的最佳实践是什么？

解决方案 #

1. 给Worker项目引入通用主机，对齐API的配置/DI模式 #

.NET控制台Worker项目完全可以使用通用主机（Generic Host），复用API项目的配置系统和依赖注入能力，无需额外的bootstrap项目：

• 给Worker项目安装必要的NuGet包：

  Install-Package Microsoft.Extensions.Hosting
  Install-Package Microsoft.EntityFrameworkCore.SqlServer
  

• 在Worker项目中添加appsettings.json文件，右键设置文件属性为复制到输出目录：如果较新则复制，配置连接字符串：

  {
    "ConnectionStrings": {
      "DefaultConnection": "你的SQL Server连接字符串"
    }
  }
  

• 修改Worker项目的Program.cs，用通用主机配置DbContext和托管服务：

  var host = Host.CreateDefaultBuilder(args)
      .ConfigureServices((context, services) =>
      {
          // 和API写法对齐的DbContext配置
          services.AddDbContext<EnergyPricesContext>(options =>
              options.UseSqlServer(context.Configuration.GetConnectionString("DefaultConnection")));
          // 注册Worker托管服务
          services.AddHostedService<Worker>();
      })
      .Build();
  
  await host.RunAsync();
  

2. 多项目共享配置的最佳实践 #

利用.NET配置系统的原生优先级避免重复配置

.NET配置系统默认支持多层级配置来源，优先级从高到低为：命令行参数 > 环境变量 > 配置文件 > 用户Secrets（仅开发环境）。基于这个特性：

• 开发环境：使用用户Secrets存储连接字符串，避免提交到代码仓库。API和Worker项目都可右键项目→管理用户机密，添加相同键值：

  {
    "ConnectionStrings": {
      "DefaultConnection": "开发环境连接字符串"
    }
  }
  

• 生产环境：用环境变量传递连接字符串，所有项目自动读取。比如设置环境变量ConnectionStrings__DefaultConnection（双下划线对应配置层级结构），无需修改任何项目的配置文件。

摒弃共享bootstrap项目方案

创建bootstrap项目共享配置会增加项目耦合度，降低灵活性。.NET配置系统本身支持跨项目共享配置来源（环境变量、密钥管理服务等），完全不需要额外的共享项目。

可选：解决方案级共享配置

如果需要多个项目复用固定通用配置，可在解决方案根目录创建shared-appsettings.json，然后在各项目的配置构建器中引入：

// 在API或Worker的配置构建中添加共享配置文件
var builder = WebApplication.CreateBuilder(args);
builder.Configuration.AddJsonFile(@"..\..\shared-appsettings.json", optional: true, reloadOnChange: true);

这种方式适合固定配置，灵活性不如环境变量/用户Secrets。

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