在生产环境中,配置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;:5000", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } }
你不需要特别指定使用这个文件 - dotnet run命令会自动加载它。
launchSettings.json文件中也提供了额外的环境变量配置参数environmentVariables,在上面的例子中你就可以发现它们。
当你从命令行使用dotnet run命令启动你的应用时,你的应用会从"Project"命令下的applicationUrl参数中加载配置https://localhost:5001;:5000,当你使用IISExpress命令启动项目的时候,你的应用会从iisSettings.iisExpress节点的applicationUrl参数中加载配置: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: :5002
info: Microsoft.Hosting.Lifetime[0]
Now listening on: [::]:5003
对我个人而言,我没有遇到过使用这方式为Kestrel服务器配置URLs的场景, 但是当你需要的时候,你就可以完全控制Kestrel服务器配置。
总结
在本篇博文中,我展示了通过五种不同的方式,来设置应用程序的监听URLs. UseUrls()是最简单的,但是基本上不太适合在生产环境中使用。 通过命令行参数--urls以及ASPNETCORE_/DOTNET环境变量是生产环境的常用方式。在开发环境中,launchSetting.json文件是最有用的配置方式。如果你需要细粒度的配置,你可以直接使用Kestrel服务器自带的配置选项。