.NET Core读取配置文件方式详细总结

. 配置文件格式

在 .NET Core 应用程序中，最常用的配置文件格式是 JSON（JavaScript Object Notation）格式，可以通过 Newtonsoft.Json 这个 NuGet 包来实现。

在配置文件中，可以定义一些固定的属性，如连接字符串、应用程序的端口号、账号和密码等。

JSON 配置文件通常是通过键-值对存储的，如下所示：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=127.0.0.1;Database=mydatabase;User ID=myuser;Password=mypassword;"
  },
  "AppSettings": {
    "UseSomeFeature": true
  }
}

在配置文件中可以看到，有三个主要的属性组：

• Logging：用来配置日志记录的内容
• ConnectionStrings：用来配置数据库连接字符串
• AppSettings：其他应用选项的分类

. 读取配置文件内容

在 .NET Core 中读取配置文件内容的方式有多种。下面我们讲解两种常用的方式。

IOptions 接口方式

IOptions 是一种用于在 ASP.NET Core 中从配置文件读取值的强类型机制。 借助 IOptions 接口以及相应的各种扩展方法，可以方便地从 appsettings.json 文件中提取配置值。以下是一个使用 IOptions 的示例。

using Microsoft.Extensions.Options;

public class MyConfiguration
{
   public bool FeatureEnabled { get; set; }
}

public class HomeController : Controller
{
    private readonly MyConfiguration _config;

    public HomeController(IOptions<MyConfiguration> config)
    {
        _config = config.Value;
    }

    public IActionResult Index()
    {
        bool enabled = _config.FeatureEnabled;

        // ...
    }
}

示例代码使用 IOptions 来读取 appsettings.json 文件中的配置值，并使 HomeController 实例直接读取 MyConfiguration 数据类型的配置。由于此时提供了强类型配置支持，HomeController 就可以从配置文件中提取特定的配置值（例如 FeatureEnabled），而无需处理转换操作。默认情况下，IOptions 以单个“根对象” TModel 的形式进行注册。

IConfiguration 接口方式

另一种常用的读取配置文件的方式是使用 IConfiguration 接口。下面我们来看一个简单的示例。

using Microsoft.Extensions.Configuration;

public class HomeController : Controller
{
    private readonly IConfiguration _config;

    public HomeController(IConfiguration config)
    {
        _config = config;
    }

    public IActionResult Index()
    {
        bool enabled = _config.GetValue<bool>("AppSettings:UseSomeFeature");

        // ...
    }
}

在这个示例中，_config 通过构造函数注入了 IConfiguration 对象。Index() 方法使用 GetValue() 方法提取配置了 AppSettings 内容中的 UseSomeFeature 值，该值是一个布尔型的属性值。

. 总结

配置文件是 .NET Core 应用程序中经常使用的一种方式，可以实现对应用程序选项的自定义设置。在本文中，我们介绍了两种基于 .NET Core 读取配置文件的方式：IOptions和IConfiguration。通过这两种方法，使得应用程序可以从 appsettings.json 文件中读取及处理自定义的配置数据。