Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

.NET Core/5+ - 에러 로깅을 위한 Middleware가 동작하지 않는 경우

실습을 해볼까요? ^^ .NET 6/기본 웹 애플리케이션 API 프로젝트를 만든 후, 코드에 예외를 발생하는 상황을 만들어둡니다.

// WeatherForecastController.cs
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
    if (HttpContext.Request.Query.TryGetValue("test", out _) == true)
    {
        throw new ApplicationException("test is not null");
    }

    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

당연히 이 상황에서는 "http://localhost:5202/weatherforecast?test=1" 요청을 전송하면 예외가 발생할 것입니다. 자, 그럼 이 예외를 전역적으로 한 곳에서 처리하기 위해 Middleware를 하나 만들어보겠습니다.

public class ErrorLoggingMiddleware
{
    private readonly RequestDelegate _next;

    public ErrorLoggingMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception e)
        {
            System.Diagnostics.Debug.WriteLine($"The following error happened: {e.Message}");
        }
    }
}

그리고 이것을 .NET Core/5+ Pipeline에 등록해 주면,

// Program.cs

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);

    // Add services to the container.

    builder.Services.AddControllers();

    var app = builder.Build();

    // Configure the HTTP request pipeline.
    app.UseMiddleware<ErrorLoggingMiddleware>();

    app.UseAuthorization();


    app.MapControllers();

    app.Run();
}

이후 "http://localhost:5202/weatherforecast?test=1" 요청에 대해 ErrorLoggingMiddleware.Invoke 내에서 try/catch에 걸려 System.Diagnostics.Debug.WriteLine 코드가 동작하는 것을 확인할 수 있습니다.




그런데, ErrorLoggingMiddleware가 동작하지 않을 수도 있습니다. 왜냐하면 Web API를 처리하는 또 다른 Middleware가 등록돼 중간에서 예외를 가로챌 수 있기 때문입니다. 그리고 그러한 가장 대표적인 예가 ASP.NET Core에서 제공하는 "DeveloperExceptionPageMiddleware"입니다. 그래서 이것을 우리가 만든 Middleware 다음에 등록하면,

// ...[생략]..

// Configure the HTTP request pipeline.
app.UseMiddleware<ErrorLoggingMiddleware>();
app.UseDeveloperExceptionPage();

// ...[생략]..

Web API에서 발생한 예외를 DeveloperExceptionPageMiddleware에서 먼저 catch하게 되고 이전에 등록된 Middleware에서는 예외 처리가 안 되는 것입니다. 따라서 이런 경우 우리가 만든 ErrorLoggingMiddleware에서 예외를 받고 싶다면 UseDeveloperExceptionPage 호출을 제거해야 합니다.

이런 이유로 인해, 사실 예외 로깅을 위한 Middleware는 예외를 먹을 것이 아니라, 다시 throw하는 것이 더 바람직합니다.

public class ErrorLoggingMiddleware
{
    // ...[생략]...

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception e)
        {
            System.Diagnostics.Debug.WriteLine($"The following error happened: {e.Message}");
            throw;
        }
    }
}

저렇게 해주면, 우리가 만든 ErrorLoggingMiddleware는 UseDeveloperExceptionPage(또는, 예외 처리를 목적으로 하는 다른 Middleware)의 호출 위치에 상관없이 DeveloperExceptionPageMiddleware의 동작에는 영향을 주지 않습니다.




참고로, DeveloperExceptionPageMiddleware가 예외를 먹는 것이 잘못된 동작은 아닙니다. 왜냐하면 그 페이지는 예외 상황을 HTML로 구성해 내려주는 역할을 하기 때문에 거기서 다시 예외를 발생하게 되면 그러한 동작을 할 수 없게 됩니다.

더군다나, 이런 부분이 문제가 되지 않는 또 다른 이유는, 어차피 실 서비스에서는 DeveloperExceptionPageMiddleware를 사용하지 않기 때문에,

if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler("/Home/Error");
}

위에서처럼 UseExceptionHandler로 등록되는 ExceptionHandlerMiddleware는 우리가 만든 Middleware처럼 throw를 다시 하도록 동작합니다.

그래서 UseExceptionHandler인 경우, Middleware 순서에 상관없이 잘 동작합니다.

// 이렇게 해도,
app.UseExceptionHandler("/Home/Error");
app.UseMiddleware();

// 또는 이렇게 해도, ErrorLoggingMiddleware의 try/catch에 예외가 잡힙니다.
app.UseMiddleware();
app.UseExceptionHandler("/Home/Error");

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]







[최초 등록일: ]
[최종 수정일: 9/29/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13186정성태12/6/202235오류 유형: 831. The framework 'Microsoft.AspNetCore.App', version '...' was not found.
13185정성태12/6/202274개발 환경 구성: 653. Windows 환경에서의 Hello World x64 어셈블리 예제 (NASM 버전)
13184정성태12/5/202282개발 환경 구성: 652. ml64.exe와 link.exe x64 실행 환경 구성
13183정성태12/4/202258오류 유형: 830. MASM + CRT 함수를 사용하는 경우 발생하는 컴파일 오류 정리
13182정성태12/4/202291Windows: 217. Windows 환경에서의 Hello World x64 어셈블리 예제 (MASM 버전)
13181정성태12/3/202287Linux: 54. 리눅스/WSL - hello world 어셈블리 코드 x86/x64 (nasm)
13180정성태12/2/202291.NET Framework: 2074. C# - 스택 메모리에 대한 여유 공간 확인하는 방법파일 다운로드1
13179정성태12/2/202259Windows: 216. Windows 11 - 22H2 업데이트 이후 Terminal 대신 cmd 창이 뜨는 경우
13178정성태12/1/2022153Windows: 215. Win32 API 금지된 함수 - IsBadXxxPtr 유의 함수들이 안전하지 않은 이유파일 다운로드1
13177정성태11/30/2022105오류 유형: 829. uwsgi 설치 시 fatal error: Python.h: No such file or directory
13176정성태11/29/202278오류 유형: 828. gunicorn - ModuleNotFoundError: No module named 'flask'
13175정성태11/29/2022110오류 유형: 827. Python - ImportError: cannot import name 'html5lib' from 'pip._vendor'
13174정성태11/28/2022135.NET Framework: 2073. C# - VMMap처럼 스택 메모리의 reserve/guard/commit 상태 출력파일 다운로드1
13173정성태11/27/2022221.NET Framework: 2072. 닷넷 응용 프로그램의 스레드 스택 크기 변경
13172정성태11/25/2022270.NET Framework: 2071. 닷넷에서 ESP/RSP 레지스터 값을 구하는 방법파일 다운로드1
13171정성태11/25/2022226Windows: 214. 윈도우 - 스레드 스택의 "red zone"
13170정성태11/24/2022373Windows: 213. 윈도우 - 싱글 스레드는 컨텍스트 스위칭이 없을까요?
13169정성태11/23/2022385Windows: 212. 윈도우의 Protected Process (Light) 보안 [1]파일 다운로드2
13168정성태11/22/2022343제니퍼 .NET: 31. 제니퍼 닷넷 적용 사례 (9) - DB 서비스에 부하가 걸렸다?!
13167정성태11/21/2022334.NET Framework: 2070. .NET 7 - Console.ReadKey와 리눅스의 터미널 타입
13166정성태11/20/2022261개발 환경 구성: 651. Windows 사용자 경험으로 WSL 환경에 dotnet 런타임/SDK 설치 방법
13165정성태11/18/2022272개발 환경 구성: 650. Azure - "scm" 프로세스와 엮인 서비스 모음
13164정성태11/18/2022430개발 환경 구성: 649. Azure - 비주얼 스튜디오를 이용한 AppService 원격 디버그 방법
13163정성태11/17/2022282개발 환경 구성: 648. 비주얼 스튜디오에서 안드로이드 기기 인식하는 방법
13162정성태11/15/2022671.NET Framework: 2069. .NET 7 - AOT(ahead-of-time) 컴파일
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...