如何将Core Web API项目的配置提供给类库依赖项访问
类库读取ASP.NET Core WebAPI项目配置的解决方案
问题根因
.NET Core 及后续版本的.NET框架重构了配置体系,不再默认支持传统ConfigurationManager读取app.config/web.config的逻辑,默认使用多源(JSON文件、环境变量、命令行参数等)的全新配置模型,因此你原有代码中的ConfigurationManager.AppSettings调用无法读取WebAPI项目appsettings.json中的配置值。
推荐方案:通过依赖注入传递配置(符合.NET官方规范)
该方案解耦类库和配置来源,可移植性、可测试性更强,实现步骤如下:
- 类库项目安装NuGet依赖包:
Microsoft.Extensions.Configuration.Abstractions - 改造类库中的
TestUtility类,通过构造函数注入配置对象:
using Microsoft.Extensions.Configuration; public class TestUtility { private readonly IConfiguration _configuration; // 构造函数注入IConfiguration public TestUtility(IConfiguration configuration) { _configuration = configuration; } public string ConfigTest() { // 直接读取配置项,空值返回默认提示 return _configuration["HomeAddress"] ?? "I can't reach the configuration."; } }
- 在WebAPI项目的启动文件(Program.cs/Startup.cs)中注册
TestUtility服务:
// .NET 6+ 顶层语句写法 var builder = WebApplication.CreateBuilder(args); // 注册TestUtility到依赖注入容器 builder.Services.AddScoped<TestUtility>(); // 其余原有配置...
- 改造控制器,不再手动实例化
TestUtility,改为注入获取:
public class LabController : ControllerBase { private readonly TestUtility _testUtility; // 构造函数注入TestUtility实例 public LabController(TestUtility testUtility) { _testUtility = testUtility; } [HttpGet] public IActionResult Get() { string result = _testUtility.ConfigTest(); return Ok(new { Message = result}); } }
调整完成后启动项目即可正常读取到HomeAddress的配置值。
兼容旧代码的过渡方案(不推荐)
如果你暂时不想调整原有类库的代码结构,可以通过兼容旧配置体系的方式实现读取:
- WebAPI项目安装NuGet依赖包:
System.Configuration.ConfigurationManager - 在WebAPI项目根目录新增
app.config文件,内容如下:
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="HomeAddress" value="123 Elm St."/> </appSettings> </configuration>
- 右键点击该
app.config文件,选择「属性」,将「复制到输出目录」设置为「如果较新则复制」
此时原有ConfigurationManager.AppSettings的代码无需修改即可正常读取配置值,但该方案无法使用.NET Core配置体系的多环境、多配置源等特性,仅适合临时过渡使用。
注意事项
- 优先使用依赖注入方案,类库无需关心配置的具体来源,后续切换配置源、调整配置逻辑都无需修改类库代码
- 不要在类库中硬编码配置读取逻辑,避免类库和具体配置体系耦合,降低可移植性
内容的提问来源于stack exchange,提问作者Felix Cartwright
相关产品推荐
相关产品推荐

