.NET Core Kestrel 호스팅 - 비주얼 스튜디오의 Kestrel/IIS Express 프로파일 설정
지난 글에서,
.NET Core 콘솔 프로젝트에서 Kestrel 호스팅 방법
; https://www.sysnet.pe.kr/2/0/12496
기본적인 Kestrel 호스팅을 다뤘는데요. 비록 저 코드가 Kestrel 호스팅 코드이긴 하지만 만약 비주얼 스튜디오 내에서 개발한다면 다소 혼란을 겪을 여지가 있습니다.
예를 들기 위해 호스팅 포트를 다음과 같이 코드로 변경한 후,
// .NET Core 3.1 Console 프로젝트
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.ConfigureKestrel(options =>
{
options.Listen(IPAddress.Loopback, 15500);
});
webBuilder.UseStartup<Startup>();
});
}
비주얼 스튜디오에서 F5로 디버깅(또는 Ctrl + F5로 실행)을 하면 "http://localhost:15500"으로 접속할 수가 없습니다. 하지만, 프로젝트 속성 창의 "Debug"에서 확인할 수 있는 "App URL"로 입력하면,
즉, (위의 예제에서는 15000으로 설정했으므로) "http://localhost:15000"으로 접속해야만 정상적으로 실행이 됩니다. 왜냐하면, webBuilder.ConfigureKestrel에 전달한 Action 함수가 실제로는 실행이 안 되었기 때문입니다. (BP를 걸고 실행해 보면 알 수 있습니다.)
그런데, 빌드한 결과물인 ConsoleApp1.exe를 직접 실행해 보면 다음과 같은 결과가 나옵니다.
info: Microsoft.Hosting.Lifetime[0]
Now listening on: http://127.0.0.1:15500
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
Content root path: C:\temp\ConsoleApp1\ConsoleApp1\bin\Debug\netcoreapp3.1
보는 바와 같이 이번에는 options.Listen 메서드가 실행된 환경을 반영합니다. 도대체 왜 이런 결과가 나오는 걸까요? ^^
이유는 간단합니다. 비주얼 스튜디오는 ASP.NET Core 프로젝트를 호스팅하는 방법으로 IIS Express를 기본적으로 사용하도록 설정하기 때문입니다. 그리고 이러한 호스팅 환경에 대한 선택을 사용자가 할 수 있도록 하는데, 비주얼 스튜디오의 메뉴 하위에 있는 아래의 프로파일 설정이 그것입니다.
(대개의 경우) 기본값이 "IIS Express"로 되어 있어 ASP.NET Core 프로젝트를 실행해도 Kestrel 관련 호스팅 코드는 실행하지 않고 (프로젝트 속성 창에 있는 정보가 반영된) applicationhost.config에 있는 정보를 바탕으로 IIS Express 호스팅 환경이 구성됩니다. 따라서, 만약 이번 글에서처럼 포트를 변경하거나
localhost 이외의 주소로 접근하도록 바꾸고 싶다면 applicationhost.config에서 변경해야 합니다. (applicationhost.config의 경로는
process explorer 등을 통해 IISExpress.exe의 명령행을 확인해 보면 됩니다. 비주얼 스튜디오는 이 파일의 일부 설정을
launchSettings.json으로부터 자동으로 병합해 줍니다.)
그리고, 만약 webBuilder.ConfigureKestrel에 있는 코드를 반영하고 싶다면 비주얼 스튜디오의 실행 프로파일 설정을 "IIS Express"가 아닌 프로젝트 이름(위의 그림에서는 "ConsoleApp1")에 해당하는 것으로 직접 바꿔야 합니다.
참고로, ConfigureKestrel에 넘긴 Action 함수는
UseKestrel 메서드가 호출되어야 실행됩니다. 이에 대해, 아래의 문서를 보면,
Kestrel web server implementation in ASP.NET Core
; https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel
(Kestrel에서 호스팅되는 경우에는) 자동으로
ConfigureWebHostDefaults 메서드가 UseKestrel을 호출한다고 합니다. (달리 말하면, 비주얼 스튜디오의 경우 "IIS Express" 프로파일 설정인 경우에는 ConfigureWebHostDefaults 메서드 내에서 UseKestrel을 호출하지 않습니다.)
만약 "IIS Express" 프로파일 상태에서 강제로 UseKestrel을 호출한다면,
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.ConfigureKestrel(options =>
{
options.Listen(IPAddress.Loopback, 15500);
});
webBuilder.UseKestrel();
webBuilder.UseStartup<Startup>();
});
ConfigureKestrel에 전달한 Action 함수가 실행은 되지만 이후 곧바로 다음과 같은 예외가 발생합니다.
System.InvalidOperationException
HResult=0x80131509
Message=Application is running inside IIS process but is not configured to use IIS server.
Source=Microsoft.AspNetCore.Server.IIS
StackTrace:
at Microsoft.AspNetCore.Server.IIS.Core.IISServerSetupFilter.<>c__DisplayClass2_0.<Configure>b__0(IApplicationBuilder app) in /_/src/Servers/IIS/IIS/src/Core/IISServerSetupFilter.cs:line 30
at Microsoft.AspNetCore.HostFilteringStartupFilter.<>c__DisplayClass0_0.<Configure>b__0(IApplicationBuilder app) in /_/src/DefaultBuilder/src/HostFilteringStartupFilter.cs:line 18
at Microsoft.AspNetCore.Hosting.GenericWebHostService.<StartAsync>d__31.MoveNext() in /_/src/Hosting/Hosting/src/GenericHost/GenericWebHostedService.cs:line 104
...[생략]...
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(IHost host) in /_/src/Hosting/Abstractions/src/HostingAbstractionsHostExtensions.cs:line 50
at Program.Main(String[] args) in C:\temp\ConsoleApp1\ConsoleApp1\Program.cs:line 12
This exception was originally thrown at this call stack:
Microsoft.AspNetCore.Server.IIS.Core.IISServerSetupFilter.Configure.AnonymousMethod__0(Microsoft.AspNetCore.Builder.IApplicationBuilder) in IISServerSetupFilter.cs
Microsoft.AspNetCore.HostFilteringStartupFilter.Configure.AnonymousMethod__0(Microsoft.AspNetCore.Builder.IApplicationBuilder) in HostFilteringStartupFilter.cs
Microsoft.AspNetCore.Hosting.GenericWebHostService.StartAsync(System.Threading.CancellationToken) in GenericWebHostedService.cs
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() in ExceptionDispatchInfo.cs
System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(System.Threading.Tasks.Task) in TaskAwaiter.cs
System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(System.Threading.Tasks.Task) in TaskAwaiter.cs
System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult() in TaskAwaiter.cs
Microsoft.Extensions.Hosting.Internal.Host.StartAsync(System.Threading.CancellationToken) in Host.cs
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() in ExceptionDispatchInfo.cs
System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(System.Threading.Tasks.Task) in TaskAwaiter.cs
...
[Call Stack Truncated]
정리해 보면, 여러분들의 ASP.NET Core 프로젝트는 자체 내장한 Kestrel을 통해서도, 혹은 외부의 IIS(및 IIS Express) 또는 기타 웹 서버들을 통해서도 호스팅이 가능하며 그에 따라 일부 환경 설정 관련한 코드의 실행 유무가 결정됩니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]