快捷導(dǎo)航

C#讀取appsettings.json配置的常用方法

更新時間：2026年03月09日 08:26:35 作者：xyy123

本文檔介紹了在 C# 項目中讀取 appsettings.json 文件的常用方法,涵蓋了現(xiàn)代 .NET 的依賴注入（DI）模式以及適用于非 DI 環(huán)境的靜態(tài)讀取模式,并詳細(xì)說明了不同數(shù)據(jù)類型的讀取方式及常見踩坑點,需要的朋友可以參考下

本文檔介紹了在 C# 項目中讀取 appsettings.json 文件的常用方法，涵蓋了現(xiàn)代 .NET 的依賴注入（DI）模式以及適用于非 DI 環(huán)境的靜態(tài)讀取模式，并詳細(xì)說明了不同數(shù)據(jù)類型的讀取方式及常見踩坑點。

示例配置文件準(zhǔn)備

在開始之前，在項目根目錄創(chuàng)建一個 appsettings.json 文件，內(nèi)容如下：

{
  "AppName": "MyAwesomeApp",
  "MaxUsers": 100,
  "SupportedLanguages": [ "zh-CN", "en-US", "ja-JP" ],
  "Database": {
    "Host": "127.0.0.1",
    "Port": 3306
  }
}

極其重要的第一步：

在 Visual Studio 中，右鍵點擊 appsettings.json -> 屬性 -> 將 “復(fù)制到輸出目錄” (Copy to Output Directory) 設(shè)置為 “如果較新則復(fù)制” (Copy if newer) 。否則程序運(yùn)行時會報找不到文件的錯誤！

模式一：依賴注入模式（推薦）

適用于 ASP.NET Core、Worker Service 等自帶依賴注入容器的現(xiàn)代 .NET 項目。推薦使用強(qiáng)類型綁定（Options Pattern）。

1. 定義映射類

public class DatabaseOptions
{
    public string Host { get; set; }
    public int Port { get; set; }
}

2. 注冊配置 (Program.cs)

var builder = WebApplication.CreateBuilder(args);

// 將 JSON 中的 "Database" 節(jié)點綁定到 DatabaseOptions 類
builder.Services.Configure<DatabaseOptions>(builder.Configuration.GetSection("Database"));

3. 在服務(wù)中注入并使用

public class MyService
{
    private readonly DatabaseOptions _dbOptions;

    // 使用 IOptions<T> 注入
    public MyService(IOptions<DatabaseOptions> options)
    {
        _dbOptions = options.Value;
    }

    public void Connect()
    {
        Console.WriteLine($"Connecting to {_dbOptions.Host}:{_dbOptions.Port}");
    }
}

模式二：靜態(tài)工具類模式（隨時隨地讀取）

適用于控制臺應(yīng)用、WinForms/WPF，或者你想在任意靜態(tài)方法中直接讀取配置的場景。

前置準(zhǔn)備： 通過 NuGet 安裝以下包：

Microsoft.Extensions.Configuration
Microsoft.Extensions.Configuration.Json
Microsoft.Extensions.Configuration.Binder

1. 創(chuàng)建靜態(tài)配置助手類

使用靜態(tài)構(gòu)造函數(shù)確保配置只被加載一次：

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

public static class ConfigHelper
{
    public static IConfiguration Configuration { get; }

    static ConfigHelper()
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);
            
        Configuration = builder.Build();
    }
}

2. 按數(shù)據(jù)類型讀取示例

以下代碼演示了如何使用 ConfigHelper 讀取不同類別的數(shù)據(jù)：

using System;
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;

public class ConfigDemo
{
    public static void Run()
    {
        // ----------------------------------------------------
        // 1. 讀取基本類型 (String, Int, Bool 等)
        // 使用 GetValue<T> 可以在找不到配置時提供一個 fallback (默認(rèn)值)
        // ----------------------------------------------------
        string appName = ConfigHelper.Configuration.GetValue<string>("AppName", "DefaultApp");
        int maxUsers = ConfigHelper.Configuration.GetValue<int>("MaxUsers", 50);
        
        Console.WriteLine($"App: {appName}, Max Users: {maxUsers}");

        // ----------------------------------------------------
        // 2. 讀取列表 (List / Array)
        // 需先 GetSection() 獲取節(jié)點，再 Get<T>() 綁定
        // ----------------------------------------------------
        var languages = ConfigHelper.Configuration.GetSection("SupportedLanguages").Get<List<string>>();
        
        if (languages != null)
        {
            Console.WriteLine("Languages: " + string.Join(", ", languages));
        }

        // ----------------------------------------------------
        // 3. 讀取對象 (Object)
        // 同樣先獲取節(jié)點，再綁定到 C# 實體類
        // ----------------------------------------------------
        var dbConfig = ConfigHelper.Configuration.GetSection("Database").Get<DatabaseOptions>();
        
        if (dbConfig != null)
        {
            Console.WriteLine($"DB Port: {dbConfig.Port}");
        }
    }
}

常見異常與排錯指南 (Troubleshooting)

在讀取配置文件時，經(jīng)常會遇到以下兩種邊緣情況，請務(wù)必在代碼中做好防御性編程：

1. 鍵不存在或值為空 (Null)

現(xiàn)象： 不會報錯拋出異常。

表現(xiàn)：

使用 GetValue<T>() 時，如果沒有提供默認(rèn)值，會返回類型 T 的默認(rèn)值（如 int 變?yōu)?0，bool 變?yōu)?false）。
使用 .Get<List<T>>() 或 .Get<Object>() 時，如果節(jié)點不存在，會返回 null。

應(yīng)對方案： 對于對象和列表，使用前必須進(jìn)行判空校驗 (if (obj != null)) ，或者在 C# 類定義時初始化為空列表（例如 public List<string> Langs { get; set; } = new();）。

2. 數(shù)據(jù)類型不匹配

現(xiàn)象： 會拋出 System.InvalidOperationException 異常。

表現(xiàn)： 比如 JSON 中寫的是 "MaxUsers": "一百"，但你試圖用 GetValue<int>("MaxUsers") 讀取。底層轉(zhuǎn)換器無法將 "一百" 解析為整型，程序?qū)⒈罎ⅰ?/p>

應(yīng)對方案： * 嚴(yán)格規(guī)范 JSON 的數(shù)據(jù)類型（數(shù)字不要加雙引號，保持為純數(shù)字）。

對于高度不可信的外部配置，建議先讀取為 string，然后使用 int.TryParse() 進(jìn)行安全轉(zhuǎn)換：

string rawValue = ConfigHelper.Configuration["MaxUsers"];
if (int.TryParse(rawValue, out int safeMaxUsers)) {
    // 解析成功，使用 safeMaxUsers
} else {
    // 解析失敗，使用默認(rèn)邏輯
}

到此這篇關(guān)于C#讀取appsettings.json配置的常用方法的文章就介紹到這了,更多相關(guān)C#讀取appsettings.json配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: