详解ASP.NET Core中配置监听URLs的五种方式

默认情况下,ASP. NET Core应用会监听一下2个Url:

:5000

https://localhost:5001

在本篇博文中,我将展示如何使用五种不同的方式改变应用监听的URLs。

ASP.NET Core项目启动时,有多种配置监听Url的方式,在我之前的一篇博客中,已经展示了在ASP.NET Core 1.0中如何应用不同的方式配置,在ASP.NET Core 3.x中,大部分方式还是一样的。

UseUrls() - 在Program.cs配置程序监听的URLs

环境变量 - 使用DOTNET_URLS或者ASPNETCORE_URLS配置URLs

命令行参数 - 当使用命令行启动应用时,使用--urls参数指定URLs

使用launchSettings.json - 使用applicationUrl属性来配置URLs

KestrelServerOptions.Listen() - 使用Listen()方法手动配置Kestral服务器监听的地址

下面我来详细说明一下每个一种方式。

哪些Url可以使用?

在本篇我描述是你可以绑定的"URLs", 但是你不能使用所有的URLs. 这里有三种你可以绑定的URLs

IPV4和IPV6的主机名(例如:5000). 这种URL的格式是{scheme}://{loopbackAddress}:{port}

在你机器上可用的指定IP地址(例如:5005), 这种URL的格式是{scheme}://{IPAddress}:{port}针对给定端口,使用"任何"IP地址(例如*:6264), 这种URL的格式是{scheme}://*:{port}

在以上说明的几种格式中,端口号也可以是选填的, 如果你忽略它,系统会使用默认端口(http使用80端口,https使用443端口)。

使用哪一种格式的URLs取决于你的部署方式。例如,如果你你将多个应用托管在同一台“裸机”中,你可能需要显示指定IP地址。但是如果你使用了容器托管,那么你可以使用localhost作为地址。

注意,针对"任何"IP地址的格式 - 你不一定必须使用*,你可以使用任何字符,只要不是IP地址或者localhost, 这意味着你可以使用*, +, , . 以上所有字符串都具有相同的行为,可以监听任何IP地址。如果你想仅处理来自单一主机名的请求,你需要额外配置主机过滤。

现在你已经了解了你需要监听的URLs类型,接下来你就需要告诉你的应用如何使用它们。我这里我将展示五种可能使用到方式。

UseUrls()

首先,最简单的方式,当配置IWebHostBuilder时,你可以使用UseUrls()方法硬编码绑定的URLs。

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"); }); }

硬编码一个URLs从来都不是一个干净可扩展解决方案的选择,所以这种方式通常只会用来做Demo.

幸运的是,你也可以从外部配置文件、环境变量或者命令行参数中加载URLs配置。

环境变量

.NET Core中允许使用两种配置方式

应用程序级配置是你通常在应用程序中使用的配置,它是用appSettings.json配置文件和环境变量中加载的。

主机配置用于配置应用程序的基础配置,例如主机环境和主机URLs

当我们在考虑如何配置应用URLs时,主机配置是让我们感兴趣的一种。默认主机配置的值来自三个不同的地方。

以DOTNET_开头的环境变量。

命令行参数

以ASPNETCORE_开头的环境变量。这种方式仅限ASP.NET Core应用,基于通用主机的worker service是不适用的。

如果你没有手动复写过UseUrls()方法,ASP.NET Core会使用系统配置的中URLS键的值。基于描述,你可以使用一下两种方式配置URLs

DOTNET_URLS

ASPNETCORE_URLS

如果你同时使用2种环境变量,系统会优先使用ASPNETCORE_URLS中定义的参数

你可以根据你的开发环境使用一些通用方式配置环境变量。例如,使用命令行

setx ASPNETCORE_URLS :5001

使用powershell

$Env: ASPNETCORE_URLS = :5001

或者使用bash命令

export ASPNETCORE_URLS=:5001;https://localhost:5002

从以上例子中不难发现,如果想要配置多个地址,只需要用分号间隔即可。

命令行参数

另外一种设置主机配置的方式是使用命令行参数。如果同时配置了环境变量和命令行参数,命令行参数的值会覆盖环境变量配置的值。这里我们可以使用--urls参数来配置URLS

dotnet run --urls :5100

和之前的例子一样,这里你可以使用分号间隔配置多个URLs

dotnet run --urls :5100;https://localhost:5101

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wysxsf.html