在ASP.NET Core中配置监听端口URLs的五种方法

2021-08-23  乐帮网

netcore

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

http://localhost:5000
https://localhost:5001

在本篇博文中，我总结了五种方式通过设置URLs来实现改变监听端口。

在ASP.NET Core中有多种配置监听Urls的方式，正如在我之前的博客中所述，在ASP.NET Core 1.0中如何应用不同的方式配置Urls，到了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

  • 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地址。如果你想仅处理来自单一主机名的请求，你需要额外配置主机过滤。

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

主机配置是比较有趣的，默认主机配置的值可以来自不同的地方。

  • 以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"下拉列表控制的：

001

在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。
到目前为止，所有的方法都是通过配置指定URLs, 实际上我们可以直接配置Kestrel服务。

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服务器配置。

总结

在本篇博文中，我通过五种不同的方式来设置应用程序的监听URLs. UseUrls()是最简单的，但是基本上不太适合在生产环境中使用。 通过命令行参数--urls以及ASPNETCORE_/DOTNET环境变量是生产环境的常用方式。在开发环境中，launchSetting.json文件是最常见的配置方式。如果你需要的配置，你可以直接使用Kestrel服务器的配置项，同时我们可以把值写在配置文件中。

原文地址：https://andrewlock.net/5-ways-to-set-the-urls-for-an-aspnetcore-app/

公众号二维码

关注我的微信公众号
在公众号里留言交流
投稿邮箱：1052839972@qq.com

庭院深深深几许？杨柳堆烟，帘幕无重数。
玉勒雕鞍游冶处，楼高不见章台路。
雨横风狂三月暮。门掩黄昏，无计留春住。
泪眼问花花不语，乱红飞过秋千去。

欧阳修

付款二维码

如果感觉对您有帮助
欢迎向作者提供捐赠
这将是创作的最大动力

相关文章
  1. .NET依赖注入获取多个服务实现类
  2. 在.Net中使用ZIP格式文件
  3. 使用命令行终止windows的进程
  4. ASP.NET Core中去除http请求的详细日志
  5. 如何向微软报告反馈.Net 或者.Net Core上的Bug
  6. .net6 添加Nlog支持
  7. Unhandled exception rendering component: '<' is an invalid start of a value
  8. .Net Core中installer与 binaries有什么区别？
  9. .Net Core6 必须安装VS2022
  10. ASP .Net 获取网卡MAC物理地址
  11. 大量 Blazor 学习资源
  12. Unable to resolve service Server.Circuits.CircuitRegistry
  13. 单元测试中的 IConfiguration 怎么模拟？
  14. HttpClient扩展方法 PostAsJsonAsync 找不到
  15. ASP .Net Core中获取当前的运行环境（Development/Staging/Production）