ASP .NET CORE 根據環境變數支持多個 appsettings.json

来源:https://www.cnblogs.com/myzony/archive/2018/08/04/9418858.html
-Advertisement-
Play Games

0.背景 在開發項目的過程當中,生產環境與調試環境的配置肯定是不一樣的。拿個最簡單的例子來說,比如連接字元串這種東西,調試環境肯定是不能連接生產資料庫的。在之前的話,這種情況只能說是你 COPY 兩個同名的配置文件來進行處理。然後你在本地就使用本地的配置,生產環境就使用生產環境的配置文件,十分麻煩。 ...


0.背景

在開發項目的過程當中,生產環境與調試環境的配置肯定是不一樣的。拿個最簡單的例子來說,比如連接字元串這種東西,調試環境肯定是不能連接生產資料庫的。在之前的話,這種情況只能說是你 COPY 兩個同名的配置文件來進行處理。然後你在本地就使用本地的配置,生產環境就使用生產環境的配置文件,十分麻煩。

而 ASP .NET CORE 支持利用環境變數來動態配置 JSON 文件,下麵就來看一下吧。

1.準備工作

首先在你的 ASP .NET CORE 項目當中添加一個 appsettings.json 文件,內容如下:

{
  "ConnectionString": {
    "Default": "Normal Database"
  }
}

之後再繼續添加一個 appsettings.Development.json,之後在你的解決方案管理器就會看到下麵這種情況。

更改其內容如下:

{
  "ConnectionString": {
    "Default": "Development Database"
  }
}

之後呢,我們繼續添加一個生產環境的配置文件,名字叫做 appsettings.Production.json ,更改其內容如下:

{
  "ConnectionString": {
    "Default": "Production Database"
  }
}

最後我們的文件應該如下圖:

以上就是我們的準備工作,我們準備了兩個環境的配置文件以及一個預設情況的配置文件,下麵我就就來看看如何應用環境變數來達到我們想要的效果。

2.環境控制

在項目調試的時候,我們可以通過右鍵項目屬性,跳轉到調試可以看到一個環境變數的設定,通過更改 ASPNETCORE_ENVIRONMENT 的值來切換不同環境。

可以看到目前我們處於 Development 也就是開發環境,那麼按照我們的設想,就應該讀取 appsettings.Development.json 的文件數據了。

2.編寫代碼

新建一個 AppConfigure 靜態類,他的內部有一個字典,用於緩存不同環境不同路徑的 IConfigurationRoot 配置。

public static class AppConfigure
{
    // 緩存字典
    private static readonly ConcurrentDictionary<string, IConfigurationRoot> _cacheDict;

    static AppConfigure()
    {
        _cacheDict = new ConcurrentDictionary<string, IConfigurationRoot>();
    }

    // 傳入 JSON 文件夾路徑與當前的環境變數值
    public static IConfigurationRoot GetConfigurationRoot(string jsonDir, string environmentName = null)
    {
        // 設置緩存的 KEY
        var cacheKey = $"{jsonDir}#{environmentName}";

        // 添加預設的 JSON 配置
        var builder = new ConfigurationBuilder().SetBasePath(jsonDir).AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

        // 根據環境變數添加相應的 JSON 配置文件
        if (!string.IsNullOrEmpty(environmentName))
        {
            builder = builder.AddJsonFile($"appsettings.{environmentName}.json", optional: true, reloadOnChange: true);
        }

        // 返回構建成功的 IConfigurationRoot 對象
        return builder.Build();
    }
}

用法的話也很簡單:

public Startup(IHostingEnvironment env)
{
    var configurationRoot = AppConfigure.GetConfigurationRoot(env.ContentRootPath, env.EnvironmentName);
    Console.WriteLine(configurationRoot["ConnectionString:Default"]);
}

3.測試

測試的話直接更改環境變數就可以看到效果了,更改其值為 Production。

現在我們來運行,並且添加一個監視變數。

看樣子它現在讀取的就是我們的生產環境的數據了。

4.代碼分析

其實吧,也不用這麼麻煩,在 Startup.cs 通過構造註入得到的 IConfiguration 就是按照 GetConfigurationRoot() 這個方法來進行構建的,你直接使用 Configuration/ConfigurationRoot 的索引器就可以訪問到與環境變數相應的 JSON 文件了。

可能你還不太理解,明明在 GetConfigurationRoot() 方法裡面使用 AddJsonFile() 方法只是添加了兩次個 Provider ,為什麼在使用索引器訪問 JSON 配置的時候就是使用的當前環境的 JSON 文件呢?

我其實以為最開始 .NET CORE 對於 IConfiguration 的索引器實現就是讀取了當前環境變數,然後根據這個環境變數去匹配對應的 Provider 取得值。

最後翻閱了 .NET CORE 的源代碼之後發現是我想錯了,其實他就是單純的翻轉了一下 Providers 的集合,然後取的第一個元素。

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using Microsoft.Extensions.Primitives;

namespace Microsoft.Extensions.Configuration
{
    public class ConfigurationRoot : IConfigurationRoot
    {
        private IList<IConfigurationProvider> _providers;
        private ConfigurationReloadToken _changeToken = new ConfigurationReloadToken();

        // 初始化 ConfigurationRoot 的時候傳入配置提供者
        public ConfigurationRoot(IList<IConfigurationProvider> providers)
        {
            if (providers == null)
            {
                throw new ArgumentNullException(nameof(providers));
            }

            _providers = providers;
            foreach (var p in providers)
            {
                p.Load();
                ChangeToken.OnChange(() => p.GetReloadToken(), () => RaiseChanged());
            }
        }

        public IEnumerable<IConfigurationProvider> Providers => _providers;


        public string this[string key]
        {
            get
            {
                // 反轉 Providers ,之後遍歷
                foreach (var provider in _providers.Reverse())
                {
                    string value;

                   // 如果拿到了值,直接返回,不再遍歷
                    if (provider.TryGet(key, out value))
                    {
                        return value;
                    }
                }

                return null;
            }

            set
            {
                if (!_providers.Any())
                {
                    throw new InvalidOperationException(Resources.Error_NoSources);
                }

                foreach (var provider in _providers)
                {
                    provider.Set(key, value);
                }
            }
        }
    }

    // ... 省略了的代碼
}

回到第三節所寫的代碼,可以看到我們首先添加的是 appsettings.json 然後再根據環境變數添加的 $"appsettings.{environmentName}.json" ,所以反轉之後取得的肯定就是帶環境變數的配置文件咯。

5.不同 OS 的環境變數配置

5.1 Windows

直接右鍵電腦手動添加環境變數。

5.2 Linux

使用 export 命令直接進行環境變數設置。

export ASPNETCORE_ENVIRONMEN='Production'

5.3 Docker

Docker 配置最為簡單,直接在啟動容器的時候加上 -e 參數即可,例如:

docker run -d -e ASPNETCORE_ENVIRONMEN=Production --name testContainer testImage

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • unsigned char a[5] = { 12,36,96,128,182 }; a[]範圍為0~256. 數組中數都有效。 char a[5] = { 12,36,96,128,182 }; a[]範圍為-128~127. 數組中128和182均無效。 ...
  • 廢話不多說,直接開乾! 硬體配置 處理器: Intel(R) Core(TM) i5-4690k CPU @3.90GHz 記憶體容量: 8.00 GB 軟體版本 OS: Microsoft Windows 10 HTTP 跑分工具: https://github.com/codesenberg/bo ...
  • 本文主要參考自孫鐘秀主編的《操作系統教程》一書中關於進程和線程的部分。 進程 為什麼引入進程? 一,刻畫系統動態性,發揮系統併發性,提高資源利用率。 以C 為例,在編輯器Visual Studio Code寫了幾行代碼,保存為cs文件。在未運行狀態的下的代碼,稱之為靜態的程式。靜態的程式是一個相對的 ...
  • 1 private void button1_Click(object sender, EventArgs e) 2 { 3 DataTable dt = new DataTable(); 4 dt.Columns.Add("Group"); 5 dt.Columns.Add("id... ...
  • 1.NuGet包管理器中安裝log4net 2.接著在項目中添加log4net.config文件,以及手擼或尋找一個LogHelper 添加完log4net.config一定要設置屬性,將其始終複製到輸出目錄 3.最後需要在AssemblyInfo.cs中添加一行代碼 效果如下: Demo下載:ht ...
  • NET特性類都有個特點類名+Attribute,繼承基類Attribute,我們看下微軟自帶的特性類:DescriptionAttribute namespace System.ComponentModel { // 摘要: // 指定屬性或事件的說明。 [AttributeUsage(Attrib ...
  • 什麼是單點登錄統一認證:假如某公司旗下有10個網站(比如各種管理網站:人事系統啊,財務系統啊,業績系統啊等),我是該公司一管理員或者用戶,按照傳統網站模式是這樣:我打開A網站 輸入賬號密碼 然後進入到A網站辦點事,辦完之後,我有需要到B網站去辦點事,這個時候又需要輸入賬號密碼,假如你還要到C網站辦點 ...
  • 接著 前面,前面的過程是普遍常用的依賴註入解析過程,我們正常都是在startup類中註入依賴服務,但是,筆者這周開發的時候遇到個問題,不同服務的生命周期不同,不能調用服務。舉個例子,AddDbContext註入資料庫上下文,生命周期預設是scoped,但是我有個需求註入的服務是單例的,因此我註入的單 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...