在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
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類