ASP.NET Core 練習 - 從類別程式庫讀取網站 appSettings

再來一個原本在 ASP.NET 不用但搬到 ASP.NET Core 讓我傻住的簡單需求 - 如何在類別程式庫(Class Library)讀取 ASP.NET Core appSettings.json 裡的設定？

.NET Core 不再使用 exe.config 或 web.config 存放 appSettings，而是改存 appsettings.json。.NET 時代要讀取 appSettings，一律用 System.Configuration.ConfigurationManager 就對了，它會看著辦，若是 Console/WinForm/WPF 從 exe.config 拿；若是 ASP.NET 則到 web.config 取。

.NET Core 不再有 System.Configuration 命名空間，取而代之的是 Microsoft.Extensions.Configuration.IConfiguration 介面，讀取程式碼對映的是介面，不需要了解底層如何實作。依循此一設計理念，正確的做法是讓類別程式庫也透過 ASP.NET Core 的 DI 依賴注入機制取得 IConfiguration，而非自己去讀取 appsettings.json 進行解析，一個很重要的原因是 appSettings.json 並非 ASP.NET Core IConfiguration 唯一的設定來源，而是依序由六個地方取得：參考

1. ChainedConfigurationProvider 主機通用的設定，例如以 ASPNETCORE_ 起首的環境變數
2. appsettings.json
3. appsettings.環境別.json
   例如：appsettings.Production.json、appsettings.Development.json
4. App Secrets 應用於正式環境，如 Azure Key Value 金鑰保管機制
5. OS 的環境變數
6. 命令列參數

那要如何在類別程式存取 IConfiguration？用實例來示範，假設我們有個 .NET Core 類別程式庫專案 - Foo，其中 FooClass 有個 Test() 方法想讀取 另一個 ASP.NET Core 專案 appsettings.json 中的 AllowedHosts 設定。ASP.NET Core 專案參照 Foo 專案，預備在 Controller 中呼叫 FooClass：

第一步要讓 FooClass 認識 IConfiguration，故要參照 Microsoft.Extensions.Configuration NuGet Package：

再來就是依循之前介紹過的 ASP.NET Core DI 設計技巧 - 透過建構式參數取得 IConfiguration：

using Microsoft.Extensions.Configuration;
using System;

namespace Foo
{
    public class FooClass
    {
        private readonly IConfiguration configruration;

        public FooClass(IConfiguration configruration)
        {
            this.configruration = configruration;
        }

        public string TestReadAppSetting()
        {
            return configruration["AllowedHosts"];
        }
    }
}

既然要融合 ASP.NET Core DI，使用 FooClass 時不再是直接 new 一個 Instance，需先在 Startup.cs ConfigureServices() 註冊：

public void ConfigureServices(IServiceCollection services)
{
    //...略...
    services.AddScoped<Foo.FooClass>();
    //...略...
}

註冊後，我們便可以在 Controller、Model、Razor Page Model 經由建構式參數取得 FooClass Instance，而 ASP.NET Core 建立 FooClass 時會傳入網站使用中的 IConfiguration，這樣子所有的東西就串連在一起囉。在 HomeController 加入簡單測試，成功!

【補充】

這篇文章主要著眼於 ASP.NET 移植到 ASP.NET Core，原有程式寫法要對映的替代做法，未涉及設計架構面優化的考量。

從類別程式庫讀取程序(網站或 exe)的設定值是一種可行做法但未必是最好的，雖然簡單直覺但也有缺點。由於類別會用到什麼設定值是隱含的，從呼叫介面上看不出來，必須由說明文件或追程式碼才知，開發者容易遺漏或誤用出錯。一種更嚴謹的做法是明確宣告專屬的 Option 類別，使用端明確指定傳入類別，一來強型別化，二來類別有哪些參數可調一目瞭然。

ASP.NET WebForm 時代我常使用靜態類別，習慣抄起來就用，類別直接讀取 config 感覺很自然；ASP.NET Core 強迫使用 DI 物件全面 Instance 化後，固定有建構式與建構式參數，多一個參數傳入設定反倒理所當然。如此改用 Options 參數取代直接讀取 appSetting 已不再那麼突兀，是值得考慮的方向。

感謝讀者 Phoenix 提醒。

Tips of how to read appSettings of ASP.NET Core web site from class library.