ASP.NET Core 配置和使用環境變數的實現
前言
通常在應用程式開發到正式上線,在這個過程中我們會分為多個階段,通常會有 開發、測試、以及正式環境等。每個環境的引數配置我們會使用不同的引數,因此呢,在ASP.NET Core中就提供了相關的環境API,方便我們更好的去做這些事情。
環境
ASP.NET Core使用ASPNETCORE_ENVIRONMENT來標識執行時環境。
ASP.NET Core預設環境
- Development:開發環境
- Staging:暫存環境(測試環境)
- Production:正式環境
要取得系統變數ASPNETCORE_ENVIRONMENT,在3.0版本之前可以通過注入IHostingEnvironment來獲取,3.x通過IWebHostEnvironment 請看如下程式碼片段:
public class Startup { public void Configure(IApplicationBuilder app,IWebHostEnvironment env) { if (env.IsDevelopment()) { } app.Run(async (context) => { await context.Response.WriteAsync( $"EnvironmentName: {env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}" ); }); } }
網站啟動後IWebHostEnvironment會從ASPNETCORE_ENVIRONMENT中獲取內容,該變數可以是我們需要的任何值。也就是該變數不一定要一定是預設的值,我們是可以自定義的。
比如我們定義一個名為Test環境
public void Configure(IApplicationBuilder app,IWebHostEnvironment env) { env.EnvironmentName = "test"; if (env.IsDevelopment()) { //TODO }else if (env.IsEnvironment("text")) { //TODO } app.Run(async (context) => { await context.Response.WriteAsync( $"EnvironmentName: {env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}" ); }); }
注:在 Windows 和 macOS 上,環境變數和值不區分大小寫。 預設情況下,Linux 環境變數和值要區分大小寫 。
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureAppConfiguration((hostContext,config) => { var env = hostContext.HostingEnvironment; config.SetBasePath(Path.Combine(env.ContentRootPath,"Configuration")) .AddJsonFile(path: "settings.json",optional: false,reloadOnChange: true) .AddJsonFile(path: $"settings.{env.EnvironmentName}.json",optional: true,reloadOnChange: true); }) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
通過上述程式碼我們,讀取我們的配置檔案回顯讀取setting.json並設定為optional: false,表示該配置為必要的配置;再往下繼續讀取再讀取settings.{env.EnvironmentName}.json檔案。當載入遇到相同的Key那麼就會覆蓋掉前面的配置項。
- SetBasePath:設定配置的目錄位置,如果是放在不同目錄,再把路徑換掉即可。
- AddJsonFile:
- path:檔案的路徑位置。
- optional:如果是必要的配置檔案,可選就要設定為false,當檔案不存在就會引發FileNotFoundException。
- reloadOnChange:如果檔案被更新,就同步更新IConfiguration例項的值。
環境設定
IIS
web.config配置環境變數
<?xml version="1.0" encoding="utf-8"?> <configuration> <system.webServer> <handlers> <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModule" resourceType="Unspecified" /> </handlers> <aspNetCore processPath="dotnet" arguments=".\Demo.dll" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout"> <environmentVariables> <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Test" /> </environmentVariables> </aspNetCore> </system.webServer> </configuration>
Visual Studio Code
launch.json中配置ASPNETCORE_ENVIRONMENT
{ "version": "0.1.0","configurations": [ { "name": ".NET Core Launch (web)","type": "coreclr","env": { "ASPNETCORE_ENVIRONMENT": "Development" } } ] }
Visual Studio IDE
Properties\launchSettings.json
"profiles": { "IIS Express": { "commandName": "IISExpress","launchBrowser": true,"environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Test" } },}
到此這篇關於ASP.NET Core 配置和使用環境變數的實現的文章就介紹到這了,更多相關ASP.NET Core 配置和環境變數內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!