.NET Core 環境變數詳解

来源:https://www.cnblogs.com/88223100/archive/2023/04/21/Detailed-explanation-of-NET-Core-environment-variables.html
-Advertisement-
Play Games

軟體從開發到正式上線，在這個過程中我們會分為多個階段，通常會有開發、測試、以及上線等。每個階段對應的環境參數配置我們會使用不同的參數。比如資料庫的連接字元串，開發環境一般我們都是連接的測試庫。以前這種情況通常是 COPY 兩個同名的配置文件來進行處理，然後在本地就使用本地的配置，生產環境就使用生產環... ...


一、概述

軟體從開發到正式上線，在這個過程中我們會分為多個階段，通常會有開發、測試、以及上線等。每個階段對應的環境參數配置我們會使用不同的參數。比如資料庫的連接字元串，開發環境一般我們都是連接的測試庫。以前這種情況通常是 COPY 兩個同名的配置文件來進行處理，然後在本地就使用本地的配置，生產環境就使用生產環境的配置文件，十分麻煩。而 ASP .NET CORE 利用環境變數來動態配置 JSON 文件對類似這種需求提供了支持，方便我們更好的去做這些事情。

二、ASP.NET Core環境

ASP.NET Core使用ASPNETCORE_ENVIRONMENT來標識運行時環境。。

ASP.NET Core使用環境變數基於運行時環境配置應用程式行為。

軟體開發環境在軟體開發組織中，我們通常具有以下開發環境。

  • Development->開發環境
  • Staging->演示（模擬、臨時）環境
  • Production->生產環境

為什麼我們需要不同的開發環境，如開發，演示，生產等等環境。

開發環境：我們的軟體開發人員通常將此環境用於我們的日常開發工作。我們希望在開發環境中載入非縮小的 JavaScript 和 CSS 文件，以便於調試。類似地，如果存在未處理的異常，我們需要開發人員異常頁面，以便我們可以理解異常的根本原因併在需要時進行修複。

演示環境：許多組織或者公司嘗試使其演示環境儘可能與實際生產環境保持一致。此環境的主要原因是識別任何與部署相關的問題。此外，如果您正在開發 B2B（企業對企業）應用程式，您可能正在與其他服務提供商系統連接。許多組織通常設置其臨時環境以與服務提供商進行交互，以進行完整的端到端測試。 我們通常不會在演示環境中進行故障排除和調試，同時為了獲得更好的性能，我們需要載入縮小的 JavaScript 和 CSS 文件。 如果存在未處理的異常，則顯示用戶友好的錯誤頁面而不是開發人員異常頁面。用戶友好的錯誤頁面不包含任何技術細節。它包含如下通用消息 :“出現問題，請使用下麵的聯繫方式發送電子郵件，聊天或致電我們的應用程式支持”

生產環境：我們用於日常業務的實際環境。應配置生產環境以獲得最大的安全性和性能。因此，載入縮小的 JavaScript 和 CSS 文件以提高性能。為了更好的安全性，請顯示用戶友好錯誤頁面而不是開發人員異常頁面。Developer Exception 頁面上的技術細節對最終用戶沒有意義，惡意用戶可以使用它們進入您的應用程式。

在Asp.NET Core項目中的Startup.cs文件，可以使用相應的方法來控制應用程式的行為。以下是創建示常式序時Startup.cs文件生成的預設代碼：

  1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  2. {
  3. if (env.IsDevelopment())
  4. {
  5. app.UseDeveloperExceptionPage();
  6. }
  7. else
  8. {
  9. app.UseExceptionHandler("/Home/Error");
  10. }
  11. app.UseStaticFiles();
  12.  
  13. app.UseRouting();
  14.  
  15. app.UseAuthorization();
  16.  
  17. app.UseEndpoints(endpoints =>
  18. {
  19. endpoints.MapControllerRoute(
  20. name: "default",
  21. pattern: "{controller=Home}/{action=Index}/{id?}");
  22. });
  23. }

其中 IWebHostEnvironment類型的變數表示的是當前應用程式運行的環境，ASP.Net Core提供了四個擴展方法，用於檢測 “ASPNETCORE_ENVIRONMENT”當前的值。

IsDevelopment()
IsStaging()
IsProduction()
IsEnvironment()

如果需要檢查應用程式是否在特定環境中運行，可以使用 env.IsEnvironment(“environmentname”) ，該方法忽略大小寫（請不要使用 env.EnvironmentName == “Development” 來檢查環境）。

過上面的代碼，我們可以知道，如果當前是開發環境，使用UseDeveloperExceptionPage()方法啟用開發環境的錯誤頁面處理，這樣有利於我們在開發過程中調試程式；但是在生產環境中我們不希望啟用這些功能，而是將出錯頁面指向路徑“/Home/Error”，給用戶顯示友好的錯誤界面。

launchSettings.json文件

ASP.Net Core包含一個launchSettings.json的新文件，您可以在項目中“Properties”文件夾中找到該文件：

image-20210318145513843

此文件設置了Visual Studio可以啟動的不同環境，以下是示例項目中launchSettings.json文件生成的預設代碼：　

  1. {
  2. "iisSettings": {
  3. "windowsAuthentication": false,
  4. "anonymousAuthentication": true,
  5. "iisExpress": {
  6. "applicationUrl": "http://localhost:53445",
  7. "sslPort": 0
  8. }
  9. },
  10. "profiles": {
  11. "IIS Express": {
  12. "commandName": "IISExpress",
  13. "launchBrowser": true,
  14. "environmentVariables": {
  15. "ASPNETCORE_ENVIRONMENT": "Development"
  16. }
  17. },
  18. "WebApplication1": {
  19. "commandName": "Project",
  20. "dotnetRunMessages": "true",
  21. "launchBrowser": true,
  22. "applicationUrl": "http://localhost:5000",
  23. "environmentVariables": {
  24. "ASPNETCORE_ENVIRONMENT": "Development"
  25. }
  26. }
  27. }
  28. }

在這裡，有兩個配置節點：“IIS Express”、“WebApplication1”，這兩個節點，分別對應Visual Stuido的開始調試按鈕的下拉選項：

Visual Stuido的開始調試按鈕的下拉選項

aunchSettings.json 文件用於設置在 Visual Stuido 運行應用程式的環境。我們也可以添加節點，該節點名稱會自動添加到 Visual Stuido 調試按鈕的下拉選項中。

  1. {
  2. "iisSettings": {
  3. "windowsAuthentication": false,//是否啟用Windows身份驗證
  4. "anonymousAuthentication": true,//是否啟用匿名身份驗證
  5. "iisExpress": {
  6. "applicationUrl": "http://localhost:53445",//應用啟動的Url路徑。
  7. "sslPort": 0 //啟用SSL的埠
  8. }
  9. },
  10. "profiles": {
  11. "IIS Express": {
  12. "commandName": "IISExpress",
  13. "launchBrowser": true, //是否在瀏覽器中啟動
  14. "environmentVariables": { //將環境變數設置為鍵/值對
  15. "ASPNETCORE_ENVIRONMENT": "Development"
  16. }
  17. },
  18. "WebApplication1": {
  19. "commandName": "Project",
  20. "dotnetRunMessages": "true",
  21. "launchBrowser": true,
  22. "applicationUrl": "http://localhost:5000",
  23. "environmentVariables": {
  24. "ASPNETCORE_ENVIRONMENT": "Development"
  25. }
  26. }
  27. }
  28. }

其中commandName可以指定要啟動的Web伺服器。commandName可以是以下任意一項：

  • IISExpress
  • IIS
  • Project

更多屬性的詳細信息，可通過此鏈接瞭解：http://json.schemastore.org/launchsettings 。

在Visual Studio項目屬性的“調試”選項卡提供了一個GUI，用於編輯launchSettings.json文件。在重新啟動Web伺服器之前，對項目配置文件所做的更改可能不會生效。必須重新啟動Kestrel，才能檢測到對其環境所做的更改。

image-20210318151112999

要取得系統變數ASPNETCORE_ENVIRONMENT，在3.0版本之前可以通過註入IHostingEnvironment來獲取，3.x到5.0版本可以通過IWebHostEnvironment 來獲取，請看如下代碼片段：

  1. public class Startup
  2. {
  3. public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  4. {
  5. if (env.IsDevelopment())
  6. {
  7. }
  8.  
  9. app.Run(async (context) =>
  10. {
  11. await context.Response.WriteAsync(
  12. $"EnvironmentName: {env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}"
  13. );
  14. });
  15. }
  16. }

網站啟動後IWebHostEnvironment會從ASPNETCORE_ENVIRONMENT中獲取內容，該變數可以是我們需要的任何值，是可以自定義的。比如我們定義一個名為Test環境：

  1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  2. {
  3. env.EnvironmentName = "test";
  4.  
  5. if (env.IsDevelopment())
  6. {
  7. //TODO
  8. }else if (env.IsEnvironment("text"))
  9. {
  10. //TODO
  11. }
  12.  
  13. app.Run(async (context) =>
  14. {
  15. await context.Response.WriteAsync(
  16. $"EnvironmentName: {env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}"
  17. );
  18. });
  19. }
  1. 註：在 Windows 和 macOS 上，環境變數和值不區分大小寫。 預設情況下，Linux 環境變數和值要區分大小寫 。

三、應用事例

通過上面的講解我們對.net core中環境變數已經有了比較深入的理解，現在我們就以一個比較常用例子：在不同環境下資料庫連接串的獲取進行實戰演練。

首先在launchSettings.json定義不同的環境，如下所示：

  1. {
  2. "iisSettings": {
  3. "windowsAuthentication": false,
  4. "anonymousAuthentication": true,
  5. "iisExpress": {
  6. "applicationUrl": "http://localhost:53445",
  7. "sslPort": 0
  8. }
  9. },
  10.  
  11. "profiles": {
  12. "IIS Express": {
  13. "commandName": "IISExpress",
  14. "launchBrowser": true,
  15. "environmentVariables": {
  16. "ASPNETCORE_ENVIRONMENT": "Development"
  17. }
  18. },
  19. "WebApplication-Development": {
  20. "commandName": "Project",
  21. "dotnetRunMessages": "true",
  22. "launchBrowser": true,
  23. "applicationUrl": "http://localhost:5000",
  24. "environmentVariables": {
  25. "ASPNETCORE_ENVIRONMENT": "Development"
  26. }
  27. },
  28. "WebApplication-Production": {
  29. "commandName": "Project",
  30. "dotnetRunMessages": "true",
  31. "launchBrowser": true,
  32. "applicationUrl": "http://localhost:5000",
  33. "environmentVariables": {
  34. "ASPNETCORE_ENVIRONMENT": "Production"
  35. }
  36. }
  37. }
  38. }

launchSettings.json

分別指定了不同的環境，每一種環境對應一個配置文件，如下圖所示：

launchSettings.json

在不同的配置文件中定義一個配置項，取值不同，如下圖所示：

appsettings.Development.json

appsettings.Production.json

在Startup.cs代碼中加入輸出：得到不同下運行配置文件得到對應的值，如下：

  1. Console.WriteLine("當前環境下的連接：" + Configuration.GetSection("ConnectionString:Default").Value);

根據不同的環境運行，看下設置的效果：

image-20210318161838544

以開發環境運行：

以開發環境運行

以生產環境運行：

以生產環境運行

通過這個簡單的事例，已經瞭解了環境的配置方式與使用過程，相信大家以此為基礎，可以應用到實際的項目中。在ASP.NET Core中，開發者可以使用環境變數輕而易舉控制應用程式在不同的環境中的行為。

 

參考文章：

在 ASP.NET Core 中使用多個環境

本文來自博客園，作者：古道輕風，轉載請註明原文鏈接：https://www.cnblogs.com/88223100/p/Detailed-explanation-of-NET-Core-environment-variables.html


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

-Advertisement-
Play Games
更多相關文章
  • 記一次jedis連接池頑固問題排查與修改
    這輩子不想再看到jedisBrokenPipe！！ 測試環境運行16天後報錯信息： 05:42:32.629 [http-nio-8093-exec-2] ERROR o.a.c.c.C.[.[.[.[dispatcherServlet] - [log,175] - Servlet.service( ...
  • 我的OpenAI庫發佈了！！！
    chatGPT正式發佈已經有段時間了，這段時間我也深度體驗了chatGPT的魅力。 OpenAI除了提供網頁版的chatGPT，還通過api的形式提供了很多其它服務，包括文字糾錯、圖片生成、音頻轉換等等。 作為程式員，即使有現成的openai庫，但還是免不了想自己造輪子，所以就有這個openai庫。 ...
  • MDC輕量化日誌鏈路跟蹤的若幹種應用場景
    "If debugging is the process of removing software bugs, then programming must be the process of putting them in." - Edsger Dijkstra “如果調試是消除軟體Bug的過程，那 ...
  • WCF教程_編程入門自學教程_菜鳥教程-免費教程分享
    教程簡介 Windows通訊開發平臺（Windows Communication Foundation，簡稱WCF）是由微軟開發的一系列支持數據通信的應用程式框架，可以翻譯為Windows通訊開發平臺。 整合了原有的windows通訊的 .net Remoting，WebService，Socket ...
  • ASP.NET CORE WEBAPI 登錄 JWT 鑒權 ，介面許可權驗證
    ###JWT的簡單使用 ####介紹 當今Web開發中，API的使用越來越廣泛，而API的安全性也變得越來越重要。其中，JWT（JSON Web Token）鑒權和授權是一種常見的解決方案。 本篇文章將會介紹JWT鑒權和授權的原理、實現方式以及註意事項。 ####什麼是JWT？ JWT是一種基於JS ...
  • C#寫一套最全的MySQL幫助類（包括增刪改查）
    介紹說明：這個幫助類包含了六個主要的方法：ExecuteNonQuery、ExecuteScalar、ExecuteQuery、ExecuteQuery（泛型）、Insert、Update和Delete。其中，ExecuteNonQuery用於執行不返回結果集的SQL語句；ExecuteScalar ...
  • 字元串優化
    C#字元串優化學習總結 記憶體區域 我們知道一個由C/C++編譯的程式占用的記憶體分為以下幾個部分： 1、棧區（stack）： 由編譯器自動分配釋放 ，存放函數的參數值，局部變數的值等。其操作方式類似於數據結構中的棧。 2、堆區（heap） ： 一般由程式員分配釋放， 若程式員不釋放，程式結束時可能由O ...
  • 如何在 .NET Core WebApi 中處理 MultipartFormDataContent 中的文件
    在上一篇文章（如何在 .NET Core WebApi 中處理 MultipartFormDataContent）中，我們有描述過如何以最簡單的方式在 .NET Core WebApi 中處理 MultipartFormDataContent 。基於框架層面的封裝，我們可以快速的從 Request. ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類