.NET Core基础之读取配置文件详解

在.NET Core应用程序中，我们可以使用配置文件来存储应用程序的配置信息。本攻略将详细介绍如何读取配置文件，并提供两个示例说明。

配置文件格式

在.NET Core应用程序中，我们可以使用多种格式的配置文件，包括JSON、XML、INI等。以下是一个简单的JSON格式的配置文件示例：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

在上面的配置文件中，我们定义了Logging和ConnectionStrings两个配置节。Logging配置节包含了LogLevel配置项，它定义了日志记录的级别。ConnectionStrings配置节包含了DefaultConnection配置项，它定义了数据库连接字符串。

读取配置文件

我们可以按照以下步骤来读取配置文件：

1. 在应用程序中添加Microsoft.Extensions.Configuration和Microsoft.Extensions.Configuration.Json NuGet包。
2. 创建一个ConfigurationBuilder对象。
3. 使用AddJsonFile方法向ConfigurationBuilder对象添加配置文件。
4. 调用Build方法来构建Configuration对象。
5. 使用GetSection方法来获取配置节。
6. 使用GetValue方法来获取配置项的值。

以下是一个简单的示例：

using Microsoft.Extensions.Configuration;

namespace MyApp
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            string connectionString = configuration.GetConnectionString("DefaultConnection");
            string logLevel = configuration.GetSection("Logging:LogLevel:Default").Value;
        }
    }
}

在上面的代码中，我们使用ConfigurationBuilder类来构建Configuration对象。我们使用AddJsonFile方法来添加配置文件。我们使用GetConnectionString方法来获取数据库连接字符串。我们使用GetSection方法来获取Logging配置节。我们使用GetValue方法来获取LogLevel配置项的值。

示例说明

示例1：使用配置文件配置日志记录

我们可以使用以下代码来使用配置文件配置日志记录：

using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Configuration;
using System.IO;

namespace MyApp
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            var loggerFactory = LoggerFactory.Create(builder =>
            {
                builder.AddConfiguration(configuration.GetSection("Logging"));
                builder.AddConsole();
            });

            ILogger logger = loggerFactory.CreateLogger<Program>();

            logger.LogInformation("Hello, world!");
        }
    }
}

在上面的代码中，我们使用ILoggerFactory接口来创建ILogger对象。我们使用AddConfiguration方法来添加Logging配置节。我们使用AddConsole方法来添加控制台日志记录器。我们使用CreateLogger方法来创建ILogger对象。我们使用LogInformation方法来记录日志。

示例2：使用配置文件配置数据库连接

我们可以使用以下代码来使用配置文件配置数据库连接：

using Microsoft.Extensions.Configuration;
using System.Data.SqlClient;

namespace MyApp
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            string connectionString = configuration.GetConnectionString("DefaultConnection");

            using (SqlConnection connection = new SqlConnection(connectionString))
            {
                connection.Open();
                // Do something with the connection
            }
        }
    }
}

在上面的代码中，我们使用SqlConnection类来连接数据库。我们使用GetConnectionString方法来获取数据库连接字符串。

结论

本攻略介绍了如何读取配置文件，并提供了两个示例说明。使用配置文件可以帮助我们轻松地配置应用程序的各种参数，提高开发效率。在读取配置文件时，我们需要使用ConfigurationBuilder类来构建Configuration对象，使用GetSection方法来获取配置节，使用GetValue方法来获取配置项的值。