默認(rèn)情況下,ASP. NET Core應(yīng)用會(huì)監(jiān)聽(tīng)一下2個(gè)Url:
- http://localhost:5000
- https://localhost:5001
在本篇博文中,我將展示如何使用五種不同的方式改變應(yīng)用監(jiān)聽(tīng)的URLs。
在ASP.NET Core項(xiàng)目啟動(dòng)時(shí),有多種配置監(jiān)聽(tīng)Url的方式,在我之前的一篇博客中,已經(jīng)展示了在ASP.NET Core 1.0中如何應(yīng)用不同的方式配置,在ASP.NET Core 3.x中,大部分方式還是一樣的。
- UseUrls() - 在Program.cs配置程序監(jiān)聽(tīng)的URLs
- 環(huán)境變量 - 使用DOTNET_URLS或者ASPNETCORE_URLS配置URLs
- 命令行參數(shù) - 當(dāng)使用命令行啟動(dòng)應(yīng)用時(shí),使用--urls參數(shù)指定URLs
- 使用launchSettings.json - 使用applicationUrl屬性來(lái)配置URLs
- KestrelServerOptions.Listen() - 使用Listen()方法手動(dòng)配置Kestral服務(wù)器監(jiān)聽(tīng)的地址
下面我來(lái)詳細(xì)說(shuō)明一下每個(gè)一種方式。
哪些Url可以使用?
在本篇我描述是你可以綁定的"URLs", 但是你不能使用所有的URLs. 這里有三種你可以綁定的URLs
IPV4和IPV6的主機(jī)名(例如http://localhost:5000
). 這種URL的格式是{scheme}://{loopbackAddress}:{port}
在你機(jī)器上可用的指定IP地址(例如http://192.168.8.31:5005
), 這種URL的格式是{scheme}://{IPAddress}:{port}
針對(duì)給定端口,使用"任何"IP地址(例如http://*:6264
), 這種URL的格式是{scheme}://*:{port}
在以上說(shuō)明的幾種格式中,端口號(hào)也可以是選填的, 如果你忽略它,系統(tǒng)會(huì)使用默認(rèn)端口(http使用80端口,https使用443端口)。
使用哪一種格式的URLs取決于你的部署方式。例如,如果你你將多個(gè)應(yīng)用托管在同一臺(tái)“裸機(jī)”中,你可能需要顯示指定IP地址。但是如果你使用了容器托管,那么你可以使用localhost
作為地址。
注意,針對(duì)"任何"IP地址的格式 - 你不一定必須使用*
,你可以使用任何字符,只要不是IP地址或者localhost
, 這意味著你可以使用http://*
, http://+
, http://mydomain
, http://example.org
. 以上所有字符串都具有相同的行為,可以監(jiān)聽(tīng)任何IP地址。如果你想僅處理來(lái)自單一主機(jī)名的請(qǐng)求,你需要額外配置主機(jī)過(guò)濾。
現(xiàn)在你已經(jīng)了解了你需要監(jiān)聽(tīng)的URLs類(lèi)型,接下來(lái)你就需要告訴你的應(yīng)用如何使用它們。我這里我將展示五種可能使用到方式。
UseUrls()
首先,最簡(jiǎn)單的方式,當(dāng)配置IWebHostBuilder
時(shí),你可以使用UseUrls()
方法硬編碼綁定的URLs。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
public class Program { public static void Main( string [] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder( string [] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); webBuilder.UseUrls( "http://localhost:5003" , "https://localhost:5004" ); }); } |
硬編碼一個(gè)URLs從來(lái)都不是一個(gè)干凈可擴(kuò)展解決方案的選擇,所以這種方式通常只會(huì)用來(lái)做Demo.
幸運(yùn)的是,你也可以從外部配置文件、環(huán)境變量或者命令行參數(shù)中加載URLs配置。
環(huán)境變量
.NET Core中允許使用兩種配置方式
-
應(yīng)用程序級(jí)配置是你通常在應(yīng)用程序中使用的配置,它是用
appSettings.json
配置文件和環(huán)境變量中加載的。 - 主機(jī)配置用于配置應(yīng)用程序的基礎(chǔ)配置,例如主機(jī)環(huán)境和主機(jī)URLs
當(dāng)我們?cè)诳紤]如何配置應(yīng)用URLs時(shí),主機(jī)配置是讓我們感興趣的一種。默認(rèn)主機(jī)配置的值來(lái)自三個(gè)不同的地方。
-
以
DOTNET_
開(kāi)頭的環(huán)境變量。 - 命令行參數(shù)
-
以
ASPNETCORE_
開(kāi)頭的環(huán)境變量。這種方式僅限ASP.NET Core應(yīng)用,基于通用主機(jī)的worker service是不適用的。
如果你沒(méi)有手動(dòng)復(fù)寫(xiě)過(guò)UseUrls()
方法,ASP.NET Core會(huì)使用系統(tǒng)配置的中URLS
鍵的值?;诿枋觯憧梢允褂靡幌聝煞N方式配置URLs
-
DOTNET_URLS
-
ASPNETCORE_URLS
如果你同時(shí)使用2種環(huán)境變量,系統(tǒng)會(huì)優(yōu)先使用ASPNETCORE_URLS
中定義的參數(shù)
你可以根據(jù)你的開(kāi)發(fā)環(huán)境使用一些通用方式配置環(huán)境變量。例如,使用命令行
1
|
setx ASPNETCORE_URLS <a href="http://localhost:5001/" rel="external nofollow">http://localhost:5001</a> |
使用powershell
1
|
$Env : ASPNETCORE_URLS = <a href= "http://localhost:5001/" rel= "external nofollow" >http://localhost:5001</a> |
或者使用bash命令
1
|
export ASPNETCORE_URLS=<a href= "http://localhost:5001;https://localhost:5002" rel= "external nofollow" >http: //localhost :5001;https: //localhost :5002< /a > |
從以上例子中不難發(fā)現(xiàn),如果想要配置多個(gè)地址,只需要用分號(hào)間隔即可。
命令行參數(shù)
另外一種設(shè)置主機(jī)配置的方式是使用命令行參數(shù)。如果同時(shí)配置了環(huán)境變量和命令行參數(shù),命令行參數(shù)的值會(huì)覆蓋環(huán)境變量配置的值。這里我們可以使用--urls
參數(shù)來(lái)配置URLS
1
|
dotnet run --urls <a href= "http://localhost:5100" rel= "external nofollow" >http://localhost:5100</a> |
和之前的例子一樣,這里你可以使用分號(hào)間隔配置多個(gè)URLs
1
|
dotnet run --urls <a href= "http://localhost:5100;https://localhost:5101" rel= "external nofollow" >http://localhost:5100;https://localhost:5101</a> |
在生產(chǎn)環(huán)境中,配置URLS的最常用方式是使用環(huán)境變量或者命令行參數(shù),但是在本地開(kāi)發(fā)環(huán)境中,可能就有點(diǎn)笨重了,這時(shí)候使用launchSetting.json
來(lái)配置URLS可能更簡(jiǎn)單一點(diǎn)。
launchSettings.json
大部分.NET Core項(xiàng)目模板中都包含了一個(gè)名為launchSetting.json
的文件, 這個(gè)文件通常放在Properties
文件夾中。這個(gè)文件中包含了啟動(dòng)ASP.NET Core項(xiàng)目的各種配置。一個(gè)典型的launchSetting.json
文件中包含了兩部分定義,一部分是命令行啟動(dòng)項(xiàng)目時(shí)的配置,一部分是使用IIS Express啟動(dòng)項(xiàng)目時(shí)的配置。具體使用哪一部分是由Visual Studio中的"Debug"下拉列表控制的:
在launchSettings.json
文件中,我們使用applicationUrl
屬性就可以配置應(yīng)用綁定的URLs - 在如下的例子中,你可以看到在iisSettings
節(jié)點(diǎn)下有一個(gè)配置,在TestApp
節(jié)點(diǎn)下有一個(gè)配置。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
{ "iisSettings" : { "windowsAuthentication" : false , "anonymousAuthentication" : true , "iisExpress" : { "applicationUrl" : "http://localhost:38327" , "sslPort" : 44310 } }, "profiles" : { "IIS Express" : { "commandName" : "IISExpress" , "launchBrowser" : true , "environmentVariables" : { "ASPNETCORE_ENVIRONMENT" : "Development" } }, "TestApp" : { "commandName" : "Project" , "launchBrowser" : true , "applicationUrl" : "https://localhost:5001;http://localhost:5000" , "environmentVariables" : { "ASPNETCORE_ENVIRONMENT" : "Development" } } } } |
你不需要特別指定使用這個(gè)文件 - dotnet run
命令會(huì)自動(dòng)加載它。
launchSettings.json
文件中也提供了額外的環(huán)境變量配置參數(shù)environmentVariables
,在上面的例子中你就可以發(fā)現(xiàn)它們。
當(dāng)你從命令行使用dotnet run
命令啟動(dòng)你的應(yīng)用時(shí),你的應(yīng)用會(huì)從"Project"命令下的applicationUrl
參數(shù)中加載配置https://localhost:5001;http://localhost:5000
,當(dāng)你使用IISExpress
命令啟動(dòng)項(xiàng)目的時(shí)候,你的應(yīng)用會(huì)從iisSettings.iisExpress
節(jié)點(diǎn)的applicationUrl
參數(shù)中加載配置http://localhost:38327
當(dāng)你做本地開(kāi)發(fā)的時(shí)候,這個(gè)文件是配置環(huán)境最簡(jiǎn)單的方式。事實(shí)上,如果你不想使用launchSettings.json
文件,你需要特別配置。
1
|
dotnet run --no-launch-profile |
以上命令會(huì)跳過(guò)launchSettings.json
文件的加載,并使用主機(jī)環(huán)境變量配置來(lái)決定綁定的URLs。
到目前為止,所有的實(shí)現(xiàn)方案都是間接為Kestrel
服務(wù)器配置URLs, 但是實(shí)際上你還可以直接配置。
KestrelServerOptions.Listen()
幾乎所有的ASP.NET Core應(yīng)用默認(rèn)都會(huì)使用Kestrel
服務(wù)器。如果你想的話,你可以手動(dòng)配置Kestrel
服務(wù)器節(jié)點(diǎn),或者使用IConfiguration
配置KestrelServerOptions
。
我從來(lái)沒(méi)有這樣做過(guò),這里有非常多的配置項(xiàng),因此在大多數(shù)情況下,我建議參考文檔。例如,你可以使用Listen()
函數(shù)顯式配置KestrelServerOptions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
public class Program { public static void Main( string [] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder( string [] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); webBuilder.UseKestrel(opts => { // Bind directly to a socket handle or Unix socket // opts.ListenHandle(123554); // opts.ListenUnixSocket("/tmp/kestrel-test.sock"); opts.Listen(IPAddress.Loopback, port: 5002); opts.ListenAnyIP(5003); opts.ListenLocalhost(5004, opts => opts.UseHttps()); opts.ListenLocalhost(5005, opts => opts.UseHttps()); }); }); } |
以上配置為Kestrel
服務(wù)器設(shè)置了多個(gè)監(jiān)聽(tīng)地址。在上面的例子中,使用了硬編碼,但是實(shí)際上可以改用IConfiguration
綁定。當(dāng)你使用以上方式為Kestrel
服務(wù)器配置URLs時(shí),如果你還是用了其他方式對(duì)URLs進(jìn)行了配置,那么它覆蓋其他方式的配置。如果發(fā)生這種情況,你會(huì)在程序日志中看到如下警告:
warn: Microsoft.AspNetCore.Server.Kestrel[0]
Overriding address(es) 'http://localhost:5007'. Binding to endpoints defined in UseKestrel() instead.
info: Microsoft.Hosting.Lifetime[0]
Now listening on: http://127.0.0.1:5002
info: Microsoft.Hosting.Lifetime[0]
Now listening on: http://[::]:5003
對(duì)我個(gè)人而言,我沒(méi)有遇到過(guò)使用這方式為Kestrel
服務(wù)器配置URLs的場(chǎng)景, 但是當(dāng)你需要的時(shí)候,你就可以完全控制Kestrel
服務(wù)器配置。
總結(jié)
在本篇博文中,我展示了通過(guò)五種不同的方式,來(lái)設(shè)置應(yīng)用程序的監(jiān)聽(tīng)URLs. UseUrls()
是最簡(jiǎn)單的,但是基本上不太適合在生產(chǎn)環(huán)境中使用。 通過(guò)命令行參數(shù)--urls
以及ASPNETCORE_
/DOTNET
環(huán)境變量是生產(chǎn)環(huán)境的常用方式。在開(kāi)發(fā)環(huán)境中,launchSetting.json
文件是最有用的配置方式。如果你需要細(xì)粒度的配置,你可以直接使用Kestrel
服務(wù)器自帶的配置選項(xiàng)。
到此這篇關(guān)于詳解ASP.NET Core中配置監(jiān)聽(tīng)URLs的五種方式的文章就介紹到這了,更多相關(guān)ASP.NET Core監(jiān)聽(tīng)URLs內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家!
原文: 5 ways to set the URLs for an ASP.NET Core app
作者: Andrew Lock
譯者: Lamond Lu
原文鏈接:https://www.cnblogs.com/lwqlun/p/12727098.html