在ASP.NET Core應用中如何設置和獲取與執行環境相關的信息？

来源:http://www.cnblogs.com/artech/archive/2016/12/06/hosting-environment.html
-Advertisement-
Play Games

HostingEnvironment是承載應用當前執行環境的描述，它是對所有實現了IHostingEnvironment介面的所有類型以及對應對象的統稱。HostingEnvironment類型是對IHostingEnvironment介面的預設實現。對於通過HostingEnvironment的四... ...


HostingEnvironment是承載應用當前執行環境的描述，它是對所有實現了IHostingEnvironment介面的所有類型以及對應對象的統稱。如下麵的代碼片段所示，一個HostingEnvironment對象承載的執行環境的描述信息體現在定義這個介面的6個屬性上。ApplicationName和EnvironmentName分別代表當前應用的名稱和執行環境的名稱。WebRootPath和ContentRootPath是指向兩個根目錄的路徑，前者指向的目錄用於存放可供外界通過HTTP請求訪問的資源，後者指向的目錄存放的則是應用自身內部所需的資源。至於這個介面的ContentRootFileProvider和WebRootFileProvider屬性返回的則是針對這兩個目錄的FileProvider對象。如下所示的HostingEnvironment類型是對IHostingEnvironment介面的預設實現。[本文已經同步到《ASP.NET Core框架揭秘》之中] 

   1: public interface IHostingEnvironment
   2: {
   3:     string         ApplicationName { get; set; }
   4:     string         EnvironmentName { get; set; }
   5:     IFileProvider  ContentRootFileProvider { get; set; }
   6:     string         ContentRootPath { get; set; }
   7:     IFileProvider  WebRootFileProvider { get; set; }
   8:     string         WebRootPath { get; set; }
   9: }
  10:  
  11: public class HostingEnvironment : IHostingEnvironment
  12: {
  13:     string         ApplicationName { get; set; }
  14:     string         EnvironmentName { get; set; }
  15:     IFileProvider  ContentRootFileProvider { get; set; }
  16:     string         ContentRootPath { get; set; }
  17:     IFileProvider  WebRootFileProvider { get; set; }
  18:     string         WebRootPath { get; set; }
  19: }

一、ApplicationEnvironment

接下來我們會對HostingEnvironment對象承載的執行環境描述信息的來源進行詳細介紹，不過在此之前我們有必要來瞭解另一個名為ApplicationEnvironment的類型，它定義在 “Microsoft.Extensions.PlatformAbstractions”這個NuGet包中。我們從其命名也可以看出這個對象描述的也是與執行環境相關的信息，而它承載的這些信息提下在如下四個屬性成員上，它們分別表示應用的名稱、基路徑、版本和採用的.NET Framework。 

   1: public class ApplicationEnvironment
   2: {
   3:     public string         ApplicationName {  get; }
   4:     public string         ApplicationBasePath {  get; }
   5:     public string         ApplicationVersion {  get; }
   6:     public FrameworkName  RuntimeFramework { get; }
   7: }

如果需要獲取一個ApplicationEnvironment對象來描述當前執行環境，我們需要使用到如下這個名為PlatformServices的對象，它的Application屬性返回的就是我們所需的ApplicationEnvironment對象。因為該類型並不存在一個公共的構函數，所以我們不能直接實例化一個PlatformServices對象，不過我們可以利用Default屬性得到這個單例對象。 

   1: public class PlatformServices
   2: {
   3:     private PlatformServices();
   4:     public ApplicationEnvironment     Application { get; }
   5:     public static PlatformServices    Default { get; }
   6: }

對於一個ApplicationEnvironment對象來說，它的ApplicationName、ApplicationVersion和RuntimeFramework屬性決定於定義了程式入口Main方法的程式集，具體來說ApplicationName和ApplicationVersion分別返回這個程式集名稱和版本，而這個編譯這個程式集採用的.NET Framework的版本對應的正是RuntimeFramework屬性。至於ApplicationBasePath屬性，它返回的實際上是AppContext的BaseDirectoryPath屬性對應的路徑，運行時使用這個基礎路徑來解析被載入的目標程式集的真實路徑。針對這四個屬性的取值可以通過下麵這段程式來驗證。 

   1: public class Program
   2: {
   3:     public static void Main()
   4:     {
   5:         Assembly assembly = typeof(Program).GetTypeInfo().Assembly;
   6:         AssemblyName assemblyName = assembly.GetName();
   7:         ApplicationEnvironment env = PlatformServices.Default.Application;
   8:  
   9:         Debug.Assert(env.ApplicationBasePath == AppContext.BaseDirectory);
  10:         Debug.Assert(env.ApplicationName == assemblyName.Name);
  11:         Debug.Assert(env.ApplicationVersion == assemblyName.Version.ToString());
  12:         Debug.Assert(env.RuntimeFramework.ToString() == assembly.GetCustomAttribute<TargetFrameworkAttribute>().FrameworkName);
  13:     }
  14: }

如果我們沒有對應用的名稱做顯式設置，當前HostingEnvironment的ApplicationName屬性體現的應用名稱來源於這個ApplicationEnvironment對象的同名屬性。HostingEnvironment包括ApplicationName在內的四個屬性（不包括WebRootFileProvider和ContentRootFileProvider屬性，因為它們決定於對應ContentRootPath和WebRootPath屬性）都可以通過WebHostOptions來設置。通過前面一章的介紹我們知道WebHostOptions對象是根據WebHostBuilder的採用的配置來創建的，所以我們可以利用配置的方式來決定執行環境。

二、Configuration和WebHostOptions

對於通過HostingEnvironment的四個屬性（ApplicationName、EnvironmentName、WebRootPath和ContentRootPath） 承載的四個與執行環境相關的設置，在WebHostOptions對象上都具有對應的屬性，後者是前者的數據來源。由於WebHostOptions對象是WebHostBuilder根據它採用的配置來創建的，所以這些設置最初來源於使用的配置。值得一提的是，如果EnvironmentName屬性未作顯式設置，它使用的預設值為“Production”。

9

由於WebHostBuilder會採用環境變數作為配置來源，並且採用“ASPNETCORE_”作為環境變數過濾採用的首碼，所以我們完全可以按照如下的方式通過設置環境變數的方式來初始化由HostingEnvironment承載的執行環境選項。 

   1: Environment.SetEnvironmentVariable("ASPNETCORE_APPLICATIONNAME", "MyApp");
   2: Environment.SetEnvironmentVariable("ASPNETCORE_ENVIRONMENT", "Staging");
   3: Environment.SetEnvironmentVariable("ASPNETCORE_WEBROOT", @"c:\myapp\wwwroot\");
   4: Environment.SetEnvironmentVariable("ASPNETCORE_CONTENTROOT", @"c:\myapp\contentroot");
   5:  
   6: new WebHostBuilder()
   7:     .UseConfiguration(new ConfigurationBuilder().AddJsonFile("weboptions.json"))
   8:     .ConfigureServices(svcs => {
   9:         IHostingEnvironment env = svcs.BuildServiceProvider().GetRequiredService<IHostingEnvironment>();
  10:         Debug.Assert(env.ApplicationName == "MyApp");
  11:         Debug.Assert(env.EnvironmentName == "Staging");
  12:         Debug.Assert(env.WebRootPath == @"c:\myapp\wwwroot\");
  13:         Debug.Assert(env.ContentRootPath == @"c:\myapp\contentroot");
  14:     })
  15:     .UseKestrel()
  16:     .Build();

雖然WebHostBuilder預設使用環境變數作為配置源，但是我們可以顯式地創建一個Configuration對象並通過調用它的擴展方法UseConfiguration進行“導入”。對於上面這段程式，如果我們將配置定義在一個具有如下結構的JSON文件（weboptions.json）,我們只需要在創建WebHost之前按照如下的方式調用UseConfiguration方法將對應配置導入進來即可。

weboptions.json： 

   1: {
   2:   "applicationName": "MyApp",
   3:   "environment"    : "Staging",
   4:   "webRoot"        : "c:\\myapp\\wwwroot",
   5:   "contentRoot"    : "c:\\myapp\\contentroot"
   6: }

Program

   1: new WebHostBuilder()
   2:     .UseConfiguration(new ConfigurationBuilder().AddJsonFile("weboptions.json").Build())
   3:     .ConfigureServices(svcs => {
   4:         IHostingEnvironment env = svcs.BuildServiceProvider().GetRequiredService<IHostingEnvironment>();
   5:         Debug.Assert(env.ApplicationName  == "MyApp");
   6:         Debug.Assert(env.EnvironmentName  == "Staging");
   7:         Debug.Assert(env.WebRootPath       == @"c:\myapp\wwwroot\");
   8:         Debug.Assert(env.ContentRootPath  == @"c:\myapp\contentroot");
   9:     })
  10:     .UseKestrel()
  11:     .Build();

三、特殊的ApplicationName

對於HostingEnvironment的這四個屬性來說，表示應用名稱的ApplicationName比較特殊。雖然它的初始值來源於配置，當我們調用Configure方法或者UseStartup方法是，這個屬性會被覆蓋。如下這段程式與上面不同之處在於創建WebHost之前調用Configure方法，我們採用環境變數設置的應用名（“MyApp”）將失效。 

   1: Environment.SetEnvironmentVariable("ASPNETCORE_APPLICATIONNAME", "MyApp");
   2: new WebHostBuilder()
   3:     .ConfigureServices(svcs => {
   4:         IHostingEnvironment env = svcs.BuildServiceProvider().GetRequiredService<IHostingEnvironment>();
   5:         Debug.Assert(env.ApplicationName != "MyApp");
   6:     })
   7:     .UseKestrel()
   8:     .Configure(app => {})
   9: .Build();

其實這個問題的答案我們在《應用的入口——Startup》中已經給出了。如下所示的是WebHostBuilder用於註冊Startup的兩個擴展方法Configure和UseStartup的定義，我們可以清楚地看到在創建並註冊Startup之前，它們都會設置當前應用的名稱。 

   1: public static class WebHostBuilderExtensions
   2: {    
   3:     public static IWebHostBuilder Configure(this IWebHostBuilder hostBuilder, Action<IApplicationBuilder> configureApp)
   4:     {
   5:         var startupAssemblyName = configureApp.GetMethodInfo().DeclaringType.GetTypeInfo().Assembly.GetName().Name;
   6:  
   7:         return hostBuilder
   8:             .UseSetting("applicationName", startupAssemblyName)
   9:             …
  10:     }
  11:  
  12:     public static IWebHostBuilder UseStartup(this IWebHostBuilder hostBuilder, Type startupType)
  13:     {
  14:         var startupAssemblyName = startupType.GetTypeInfo().Assembly.GetName().Name;
  15:         return hostBuilder
  16:             .Use
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 質數的判斷，實現bool IsPrime(int number)
    1、重覆輸入一個數,判斷該數是否是質數,輸入q結束?質數的判斷用方法來實現bool IsPrime(int number) 1 static void Main(string[] args) 2 { 3 // 要求：重覆讓用戶輸入一個數,判斷該數是否是質數,輸入q結束? 質數的判斷用方法來實現boo ...
  • 參數類型params
    params參數練習 1 namespace Test 2 { 3 class Program 4 { 5 static void Main(string[] args) 6 { 7 //params 構造函數聲明數組，可變數組長度 8 UseParam1(4,2,3); 9 UserParam2( ...
  • petapoco-SQLServer模型增加註釋
    petapoco是個基於T4模板的輕量級ORM，好用效率高，具體介紹略了 獲取註釋基本原理是調用資料庫::fn_listextendedproperty函數，獲取擴展屬性MS_Description technet參考資料：sys.fn_listextendedproperty (Transact- ...
  • MVC如何使用開源分頁插件shenniu.pager.js
    最近比較忙，前期忙公司手機端介面項目，各種開發+調試+發佈現在幾乎上線無問題了；雖然公司項目忙不過在期間抽空做了兩件個人覺得有意義的事情，一者使用aspnetcore開發了個人線上項目（要說線上其實只能ip訪問，沒有功能變數名稱哈哈），其架構組成由：aspnetcore1.0.0+redis+ postgr ...
  • 最好的.NET開源免費ZIP庫DotNetZip（.NET組件介紹之三）
    在項目開發中，除了對數據的展示更多的就是對文件的相關操作，例如文件的創建和刪除，以及文件的壓縮和解壓。文件壓縮的好處有很多，主要就是在文件傳輸的方面，文件壓縮的好處就不需要贅述，因為無論是開發者，還是使用者對於文件壓縮的好處都是深有體會。至於文件壓縮的原理，在我的另一篇博客中有簡單的介紹，在這裡就不 ...
  • 【CLR via C#】CSC將源代碼編譯成托管模塊
    下圖展示了編譯源代碼文件的過程。如圖所示，可用支持 CLR 的任何一種語言創建源代碼文件。然後，用一個對應的編譯器檢查語法和分析源代碼。無論選用哪一個編譯器，結果都是一個托管模塊（managedmodule）。托管模塊是一個標準的 32 位 Microsoft Windows 可移植執行體（PE32 ...
  • 在Application_Error事件中獲取當前的Action和Control
    ASP.NET MVC程式處理異常時，方法有很多，網上也有列舉了6種，下麵是使用全局處理在Global.asax文件的Application_Error事件中實現。既然是ASP.NET MVC,我需要捕捉到Controller和Action名稱。怎樣實現可以參考下麵代碼： 程式運行結果： ...
  • Visual Studio 2015 各版本對比及下載地址
    2015年7月20日23時30分，微軟舉行了Visual Studio 2015的發佈會，跟隨者Visual Studio 2015 而來的是，.net 開源，C#支持wp，ios，android三大系統手機開發。 Visual Studio 2015 系統要求 (註：詳細可以參考 Visual S ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類