.net core 读取配置文件的几种方式

原创

mob64ca12edea6e 2023-08-24 06:56:06 ©著作权

文章标签 配置文件 Core 配置项 文章分类 .Net 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12edea6e的原创作品，请联系作者获取转载授权，否则将追究法律责任

.NET Core读取配置文件的几种方式

1. 简介

在.NET Core开发中，配置文件是非常重要的一部分。通过配置文件，我们可以灵活地配置应用程序的各种参数，例如数据库连接字符串、日志级别等。本文将介绍.NET Core读取配置文件的几种常用方式，并提供相应的代码示例。

2. 流程概述

下面是读取配置文件的整体流程，可以用表格形式展示：

步骤	描述
1	创建配置对象
2	指定配置文件
3	读取配置项

接下来，我们将详细讲解每一步需要做什么，以及相应的代码示例。

3. 步骤详解

3.1. 创建配置对象

在读取配置文件之前，首先需要创建配置对象。在.NET Core中，可以使用ConfigurationBuilder类来创建配置对象。以下是创建配置对象的代码示例：

var builder = new ConfigurationBuilder();

3.2. 指定配置文件

创建配置对象后，我们需要指定配置文件的路径。配置文件可以是多种格式，例如JSON、XML等。以下是指定配置文件的代码示例：

builder.SetBasePath(Directory.GetCurrentDirectory())
       .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);

上述代码中，我们使用了SetBasePath方法指定了配置文件的基础路径，这里使用了当前工作目录。然后使用AddJsonFile方法添加了一个JSON格式的配置文件。optional参数指示配置文件是否是可选的，reloadOnChange参数指示配置文件在发生改变时是否重新加载。

3.3. 读取配置项

配置文件加载完成后，我们可以使用配置对象来读取配置项。以下是读取配置项的代码示例：

var config = builder.Build();
var value = config["Key"];

上述代码中，我们使用Build方法构建了配置对象。然后可以通过索引器的方式读取配置项的值，其中Key为配置项的键。

4. 示例

下面是一个完整的示例代码，演示了使用.NET Core读取配置文件的流程：

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

namespace ConfigurationDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder();
            builder.SetBasePath(Directory.GetCurrentDirectory())
                   .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);
            
            var config = builder.Build();
            var value = config["Key"];
            
            Console.WriteLine($"Key: {value}");
        }
    }
}

在上述示例中，假设配置文件appsettings.json中有一个配置项Key，我们通过索引器的方式读取了该配置项的值，并输出到控制台。