.NET Core Web App连接字符串获取及异常问题解决

问题场景 #

在.NET Core Web应用中获取连接字符串时，会遇到两类典型错误：

• 直接读取连接字符串返回null，后续使用触发System.NullReferenceException
• 尝试通过构造函数注入自定义ConnectionStrings类时，抛出InvalidOperationException（提示无法解析ConnectionStrings服务）
  已安装Microsoft.EntityFrameworkCore和Microsoft.EntityFrameworkCore.SqlServer NuGet包，配置文件与代码逻辑看似正确，但问题仍存在。

常见错误代码示例 #

错误1：直接读取配置返回null

// 非DI上下文或未正确初始化Configuration时，可能返回null
var connString = Configuration.GetConnectionString("DefaultConnection");
// 使用connString时触发NullReferenceException

错误2：直接注入自定义类导致服务无法解析

// 自定义连接字符串类
public class ConnectionStrings
{
    public string DefaultConnection { get; set; }
}

// 服务中直接注入ConnectionStrings，DI容器无法解析
public class MyDbService
{
    private readonly ConnectionStrings _connStrings;
    public MyDbService(ConnectionStrings connStrings)
    {
        _connStrings = connStrings;
    }
}

对应的appsettings.json配置

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

正确解决方案：使用IOptions选项模式 #

步骤1：定义配置绑定类 #

保持自定义ConnectionStrings类不变，确保属性名与配置节键名一致：

public class ConnectionStrings
{
    public string DefaultConnection { get; set; }
}

步骤2：在Program.cs中注册配置服务 #

将配置节绑定到ConnectionStrings类，并通过Configure<T>注册为IOptions<T>服务：

var builder = WebApplication.CreateBuilder(args);

// 绑定ConnectionStrings配置节到类，并注册IOptions服务
builder.Services.Configure<ConnectionStrings>(builder.Configuration.GetSection("ConnectionStrings"));

// 示例：注册DbContext时也可直接读取配置
builder.Services.AddDbContext<MyAppDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

var app = builder.Build();
// 后续中间件配置...

步骤3：在服务中注入IOptions #

通过IOptions<T>获取配置实例，避免直接注入未注册的类：

public class MyDbService
{
    private readonly string _defaultConnString;

    public MyDbService(IOptions<ConnectionStrings> connStringsOptions)
    {
        // 通过Value属性获取绑定后的配置实例
        _defaultConnString = connStringsOptions.Value.DefaultConnection;
    }
}

错误原因拆解 #

1. 直接读取返回null：

   • 若在非依赖注入上下文（如静态类、手动实例化的类）中访问Configuration，可能未正确加载配置文件；
   • 配置键名拼写错误（虽然.NET Core配置默认大小写不敏感，但自定义绑定需保证属性名与配置键完全匹配）。

2. 无法解析ConnectionStrings服务：
   -.NET Core DI容器仅能解析已注册的服务，直接注入自定义ConnectionStrings类时，容器未被告知如何实例化该类，因此抛出服务未注册的异常。

依赖注入与选项模式核心原理 #

• 依赖注入（DI）：DI容器负责管理服务的生命周期与实例化，只有通过builder.Services.AddXXX()或Configure<T>注册的服务，才能被容器解析并注入到其他服务中。
• 选项模式：IOptions<T>是.NET Core标准化的配置绑定方案，通过Configure<T>将配置节与类绑定，并注册为单例服务。它不仅能确保配置正确加载，还支持配置重载、数据验证、命名选项等高级特性，是.NET Core中读取配置的推荐方式。

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