.NET Core 2.0中服务类库读取WebApi的appsettings最佳方式

刚好我对这个场景很熟悉，下面给你拆解两种可行的实现方案，第二种更推荐，因为更贴合.NET的配置最佳实践。

方案一：直接注入IConfiguration读取配置 #

这种方式最直接，不需要额外定义类，适合快速实现简单的配置读取需求。

步骤： #

1. 在Services类库中添加依赖
   首先在你的Services类库项目里，通过NuGet安装Microsoft.Extensions.Configuration包——因为.NET Core 2.0里这个包不会默认包含在类库项目中。

2. 在服务类中注入IConfiguration
   在需要读取配置的服务类里，通过构造函数注入IConfiguration实例，然后就可以直接通过键路径读取配置值了：

   public class ThirdPartyService
   {
       private readonly IConfiguration _config;
   
       // 构造函数注入IConfiguration
       public ThirdPartyService(IConfiguration config)
       {
           _config = config ?? throw new ArgumentNullException(nameof(config));
       }
   
       public void CallThirdPartyApi()
       {
           // 读取ThirdPartyApi节点下的配置项
           var apiUrl = _config["ThirdPartyApi:ApiUrl"];
           var apiVersion = _config["ThirdPartyApi:ApiVersion"];
           
           // 这里写你的业务逻辑，比如调用第三方API
       }
   }
   

3. 在WebApi项目中注册服务
   打开WebApi项目的Startup.cs，在ConfigureServices方法里注册你的Services类库中的服务：

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddMvc();
       // 注册ThirdPartyService，IConfiguration会自动从WebApi的配置容器中注入
       services.AddScoped<ThirdPartyService>();
   }
   

优缺点： #

• ✅ 优点：实现简单，零额外代码，快速上手
• ❌ 缺点：硬编码配置键路径，容易写错；没有类型安全，编译时无法发现错误；单元测试时需要模拟整个IConfiguration，不够灵活

方案二：强类型绑定配置（推荐） #

这种方式把配置节点映射成一个强类型类，不仅更清晰，还能获得类型安全和更好的可测试性，是.NET配置的最佳实践。

步骤： #

1. 在Services类库中定义配置类
   创建一个和appsettings.json中ThirdPartyApi节点结构完全匹配的类：

   public class ThirdPartyApiSettings
   {
       public string ApiUrl { get; set; }
       public string ApiVersion { get; set; }
       // 如果有其他配置项，继续在这里添加对应的属性
   }
   

2. 确保WebApi的appsettings.json结构正确
   确认你的appsettings.json里的节点和上面的类对应：

   {
     "ThirdPartyApi": {
       "ApiUrl": "https://your-third-party-api.com",
       "ApiVersion": "v1"
     }
   }
   

3. 在WebApi项目中绑定配置并注册服务
   打开Startup.cs，在ConfigureServices方法里，把配置节点绑定到强类型类，然后将这个类注册为服务：

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddMvc();
   
       // 绑定ThirdPartyApi节点到强类型类
       var thirdPartySettings = new ThirdPartyApiSettings();
       Configuration.GetSection("ThirdPartyApi").Bind(thirdPartySettings);
       // 或者用更简洁的方式：Configuration.Bind("ThirdPartyApi", thirdPartySettings);
   
       // 将配置类注册为单例服务，这样整个应用中都能复用
       services.AddSingleton(thirdPartySettings);
   
       // 注册你的Services类库服务
       services.AddScoped<ThirdPartyService>();
   }
   

   注意：需要确保WebApi项目安装了Microsoft.Extensions.Configuration.Binder包，Bind方法依赖这个包。

4. 在Services类库中注入强类型配置
   现在可以直接在服务类中注入ThirdPartyApiSettings，不用再和IConfiguration打交道了：

   public class ThirdPartyService
   {
       private readonly ThirdPartyApiSettings _settings;
   
       public ThirdPartyService(ThirdPartyApiSettings settings)
       {
           _settings = settings ?? throw new ArgumentNullException(nameof(settings));
       }
   
       public void CallThirdPartyApi()
       {
           // 直接使用强类型属性，类型安全，编译时就能发现错误
           var apiUrl = _settings.ApiUrl;
           var apiVersion = _settings.ApiVersion;
           
           // 业务逻辑代码
       }
   }
   

优缺点： #

• ✅ 优点：类型安全，编译时校验；代码可读性高；单元测试时可以轻松构造模拟的配置对象，不用依赖IConfiguration
• ❌ 缺点：需要额外定义配置类（这其实也是规范代码的一部分，不算真正的缺点）

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