您好,登录后才能下订单哦!
本篇文章给大家分享的是有关如何在ASP.NET Core项目中对URLs进行监听,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。
ASP.NET 是开源,跨平台,高性能,轻量级的 Web 应用构建框架,常用于通过 HTML、CSS、JavaScript 以及服务器脚本来构建网页和网站。
默认情况下,ASP. NET Core应用会监听一下2个Url:
http://localhost: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的主机名(例如http://localhost:5000
). 这种URL的格式是{scheme}://{loopbackAddress}:{port}
在你机器上可用的指定IP地址(例如http://192.168.8.31:5005
), 这种URL的格式是{scheme}://{IPAddress}:{port}
针对给定端口,使用"任何"IP地址(例如http://*:6264
), 这种URL的格式是{scheme}://*:{port}
在以上说明的几种格式中,端口号也可以是选填的, 如果你忽略它,系统会使用默认端口(http使用80端口,https使用443端口)。
使用哪一种格式的URLs取决于你的部署方式。例如,如果你你将多个应用托管在同一台“裸机”中,你可能需要显示指定IP地址。但是如果你使用了容器托管,那么你可以使用localhost
作为地址。
注意,针对"任何"IP地址的格式 - 你不一定必须使用*
,你可以使用任何字符,只要不是IP地址或者localhost
, 这意味着你可以使用http://*
, http://+
, http://mydomain
, http://example.org
. 以上所有字符串都具有相同的行为,可以监听任何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 http://localhost:5001
使用powershell
$Env: ASPNETCORE_URLS = http://localhost:5001
或者使用bash命令
export ASPNETCORE_URLS=http://localhost:5001;https://localhost:5002
从以上例子中不难发现,如果想要配置多个地址,只需要用分号间隔即可。
命令行参数
另外一种设置主机配置的方式是使用命令行参数。如果同时配置了环境变量和命令行参数,命令行参数的值会覆盖环境变量配置的值。这里我们可以使用--urls
参数来配置URLS
dotnet run --urls http://localhost:5100
和之前的例子一样,这里你可以使用分号间隔配置多个URLs
dotnet run --urls http://localhost:5100;https://localhost:5101
在生产环境中,配置URLS的最常用方式是使用环境变量或者命令行参数,但是在本地开发环境中,可能就有点笨重了,这时候使用launchSetting.json
来配置URLS可能更简单一点。
launchSettings.json
大部分.NET Core项目模板中都包含了一个名为launchSetting.json
的文件, 这个文件通常放在Properties
文件夹中。这个文件中包含了启动ASP.NET Core项目的各种配置。一个典型的launchSetting.json
文件中包含了两部分定义,一部分是命令行启动项目时的配置,一部分是使用IIS Express启动项目时的配置。具体使用哪一部分是由Visual Studio中的"Debug"下拉列表控制的:
在launchSettings.json
文件中,我们使用applicationUrl
属性就可以配置应用绑定的URLs - 在如下的例子中,你可以看到在iisSettings
节点下有一个配置,在TestApp
节点下有一个配置。
{ "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" } } } }
你不需要特别指定使用这个文件 - dotnet run
命令会自动加载它。
launchSettings.json
文件中也提供了额外的环境变量配置参数environmentVariables
,在上面的例子中你就可以发现它们。
当你从命令行使用dotnet run
命令启动你的应用时,你的应用会从"Project"命令下的applicationUrl
参数中加载配置https://localhost:5001;http://localhost:5000
,当你使用IISExpress
命令启动项目的时候,你的应用会从iisSettings.iisExpress
节点的applicationUrl
参数中加载配置http://localhost:38327
当你做本地开发的时候,这个文件是配置环境最简单的方式。事实上,如果你不想使用launchSettings.json
文件,你需要特别配置。
dotnet run --no-launch-profile
以上命令会跳过launchSettings.json
文件的加载,并使用主机环境变量配置来决定绑定的URLs。
到目前为止,所有的实现方案都是间接为Kestrel
服务器配置URLs, 但是实际上你还可以直接配置。
KestrelServerOptions.Listen()
几乎所有的ASP.NET Core应用默认都会使用Kestrel
服务器。如果你想的话,你可以手动配置Kestrel
服务器节点,或者使用IConfiguration
配置KestrelServerOptions
。
我从来没有这样做过,这里有非常多的配置项,因此在大多数情况下,我建议参考文档。例如,你可以使用Listen()
函数显式配置KestrelServerOptions
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
服务器设置了多个监听地址。在上面的例子中,使用了硬编码,但是实际上可以改用IConfiguration
绑定。当你使用以上方式为Kestrel
服务器配置URLs时,如果你还是用了其他方式对URLs进行了配置,那么它覆盖其他方式的配置。如果发生这种情况,你会在程序日志中看到如下警告:
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
对我个人而言,我没有遇到过使用这方式为Kestrel
服务器配置URLs的场景, 但是当你需要的时候,你就可以完全控制Kestrel
服务器配置。
以上就是如何在ASP.NET Core项目中对URLs进行监听,小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注亿速云行业资讯频道。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。