C# Cancellationtoken (개발자를 위한 작동 방식)

어떻게 작동하나요?

본질적으로, CancellationToken은 작업이나 메서드에 전달되며, 주기적으로 취소 요청이 있는지를 확인합니다. 그렇게 되면, 작업이 우아하게 종료되어 자원을 해제하고 응용 프로그램의 응답성을 향상시킬 수 있습니다. 이는 복잡한 문서가 생성하는 데 시간이 걸릴 수 있는 PDF 생성과 같은 경우에 특히 유용합니다.

CancellationTokens을 사용하면 시스템 리소스 낭비 및 사용자 경험 저하와 같은 불필요하게 오래 실행되는 작업의 잠재적 단점을 피할 수 있습니다.

내부 취소 토큰

C#에서 내부 취소 토큰은 외부 소스에서 전달되는 것이 아니라 특정 클래스나 메서드 내에서 생성되고 관리되는 취소 토큰을 의미합니다. 이렇게 하면 단일 구성요소의 범위 내에서 작업 취소를 더 세밀하게 제어할 수 있어 내부에서 시작되는 취소 요청을 모니터하고 응답할 수 있습니다.

내부 취소 토큰을 사용하는 것은 취소 로직을 클래스 소비자에게 노출하지 않고 캡슐화하려는 시나리오에서 특히 유용하여 깔끔한 인터페이스를 유지할 수 있습니다. 이 접근 방식은 코드 모듈성을 향상시킬 수 있으며, 여전히 광범위한 CancellationToken 프레임워크가 제공하는 유연성을 활용하면서 복잡한 비동기 워크플로 관리가 더 쉬워집니다.

1. 불필요한 부하 방지

사용자가 요청한 PDF가 더 이상 필요하지 않은 경우 해당 프로세스를 지속할 이유가 없습니다. CancellationToken을 활용하면 PDF 생성 작업을 중단하여 서버에 대한 과도한 부하를 방지하고 전체 애플리케이션 성능을 개선할 수 있습니다.

2. 사용자 경험 향상

데스크톱 애플리케이션에서 PDF 생성은 UI 스레드에서 발생할 수 있으며, 작업이 오랜 시간 실행되면 사용자 인터페이스가 잠길 수 있습니다. CancellationToken을 통합하면 사용자는 작업을 취소하고 애플리케이션의 응답성을 유지할 수 있습니다.

3. 확장성 향상

여러 사용자가 동시에 PDF를 생성하는 웹 애플리케이션에서는 확장성이 중요합니다. CancellationToken을 사용하면 불필요한 작업을 안전하게 취소하여 다른 요청을 효율적으로 처리할 수 있도록 리소스를 확보할 수 있습니다.

단계 1: 프로젝트에서 IronPDF 설정하기

IronPDF를 사용하기 시작하려면 먼저 설치해야 합니다. 이미 설치되어 있는 경우 다음 섹션으로 건너뛸 수 있습니다; 그렇지 않다면, 다음 단계는 IronPDF 라이브러리를 설치하는 방법을 다룹니다.

NuGet 패키지 관리자 콘솔을 통해

NuGet 패키지 관리자 콘솔을 사용하여 IronPDF를 설치하려면, Visual Studio를 열고 패키지 관리자 콘솔로 이동합니다. 그런 다음 다음 명령을 실행합니다:

Install-Package IronPdf

솔루션용 NuGet 패키지 관리자를 통해

Visual Studio를 열고 "도구 -> NuGet 패키지 관리자 -> 솔루션용 NuGet 패키지 관리"로 이동하여 IronPDF를 검색합니다. 여기서 프로젝트를 선택하고 "설치" 버튼을 클릭하면 IronPDF가 프로젝트에 추가됩니다.

IronPDF를 설치한 후, 코드 상단에 올바른 using 문만 추가하면 IronPDF를 사용할 수 있습니다:

using IronPdf;

using IronPdf;

Imports IronPdf

단계 2: 비동기 PDF 생성 방법에서 취소 토큰 사용하기

이제 실제 구현으로 들어가 보겠습니다. 이 예제에서는 IronPDF를 사용하여 HTML에서 간단한 PDF를 생성할 것이며, 필요시 작업을 취소할 수 있는 CancellationToken을 사용할 것입니다.

using IronPdf;
using System;
using System.Threading;
using System.Threading.Tasks;

public class PdfGenerator
{
    public async Task GeneratePdfWithCancellation(CancellationToken token)
    {
        var Renderer = new ChromePdfRenderer();
        try
        {
            // Check for cancellation before starting
            token.ThrowIfCancellationRequested();

            // Simulating a long task that can be checked for cancellation periodically
            for (int i = 0; i < 10; i++)
            {
                // Simulating a piece of work (this could be part of a larger HTML rendering)
                await Task.Delay(500); // Simulate chunk processing

                // Periodically check for cancellation in long-running operations
                if (token.IsCancellationRequested)
                {
                    Console.WriteLine("Cancellation requested. Throwing exception.");
                    token.ThrowIfCancellationRequested();  // This will trigger an OperationCanceledException
                }
            }

            // Simulate PDF creation after the long process
            var pdf = await Renderer.RenderHtmlAsPdfAsync("<h1>Hello, PDF!</h1>");

            // Save the PDF after ensuring no cancellation occurred
            pdf.SaveAs("output.pdf");
            Console.WriteLine("PDF generated successfully.");
        }
        catch (OperationCanceledException)
        {
            // Handle task cancellation
            Console.WriteLine("PDF generation was canceled.");
        }
        catch (Exception ex)
        {
            // Handle other exceptions
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

public class Program
{
    public static async Task Main(string[] args)
    {
        // Create a CancellationTokenSource
        var cancellationTokenSource = new CancellationTokenSource();

        // Create our cancellation token
        var token = cancellationTokenSource.Token;

        // Start the PDF generation task
        var pdfGenerator = new PdfGenerator();
        Task pdfTask = pdfGenerator.GeneratePdfWithCancellation(token);

        // Simulate a cancellation scenario
        Console.WriteLine("Press any key to cancel PDF generation...");
        Console.ReadKey();

        // Cancel the task by calling Cancel() on the CancellationTokenSource
        cancellationTokenSource.Cancel();

        try
        {
            // Await the task to handle any exceptions, such as cancellation
            await pdfTask;
        }
        catch (OperationCanceledException)
        {
            // Confirm the cancellation
            Console.WriteLine("The PDF generation was canceled.");
        }
        finally
        {
            cancellationTokenSource.Dispose();
        }

        Console.WriteLine("Program finished.");
    }
}

using IronPdf;
using System;
using System.Threading;
using System.Threading.Tasks;

public class PdfGenerator
{
    public async Task GeneratePdfWithCancellation(CancellationToken token)
    {
        var Renderer = new ChromePdfRenderer();
        try
        {
            // Check for cancellation before starting
            token.ThrowIfCancellationRequested();

            // Simulating a long task that can be checked for cancellation periodically
            for (int i = 0; i < 10; i++)
            {
                // Simulating a piece of work (this could be part of a larger HTML rendering)
                await Task.Delay(500); // Simulate chunk processing

                // Periodically check for cancellation in long-running operations
                if (token.IsCancellationRequested)
                {
                    Console.WriteLine("Cancellation requested. Throwing exception.");
                    token.ThrowIfCancellationRequested();  // This will trigger an OperationCanceledException
                }
            }

            // Simulate PDF creation after the long process
            var pdf = await Renderer.RenderHtmlAsPdfAsync("<h1>Hello, PDF!</h1>");

            // Save the PDF after ensuring no cancellation occurred
            pdf.SaveAs("output.pdf");
            Console.WriteLine("PDF generated successfully.");
        }
        catch (OperationCanceledException)
        {
            // Handle task cancellation
            Console.WriteLine("PDF generation was canceled.");
        }
        catch (Exception ex)
        {
            // Handle other exceptions
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

public class Program
{
    public static async Task Main(string[] args)
    {
        // Create a CancellationTokenSource
        var cancellationTokenSource = new CancellationTokenSource();

        // Create our cancellation token
        var token = cancellationTokenSource.Token;

        // Start the PDF generation task
        var pdfGenerator = new PdfGenerator();
        Task pdfTask = pdfGenerator.GeneratePdfWithCancellation(token);

        // Simulate a cancellation scenario
        Console.WriteLine("Press any key to cancel PDF generation...");
        Console.ReadKey();

        // Cancel the task by calling Cancel() on the CancellationTokenSource
        cancellationTokenSource.Cancel();

        try
        {
            // Await the task to handle any exceptions, such as cancellation
            await pdfTask;
        }
        catch (OperationCanceledException)
        {
            // Confirm the cancellation
            Console.WriteLine("The PDF generation was canceled.");
        }
        finally
        {
            cancellationTokenSource.Dispose();
        }

        Console.WriteLine("Program finished.");
    }
}

Imports IronPdf
Imports System
Imports System.Threading
Imports System.Threading.Tasks

Public Class PdfGenerator
	Public Async Function GeneratePdfWithCancellation(ByVal token As CancellationToken) As Task
		Dim Renderer = New ChromePdfRenderer()
		Try
			' Check for cancellation before starting
			token.ThrowIfCancellationRequested()

			' Simulating a long task that can be checked for cancellation periodically
			For i As Integer = 0 To 9
				' Simulating a piece of work (this could be part of a larger HTML rendering)
				Await Task.Delay(500) ' Simulate chunk processing

				' Periodically check for cancellation in long-running operations
				If token.IsCancellationRequested Then
					Console.WriteLine("Cancellation requested. Throwing exception.")
					token.ThrowIfCancellationRequested() ' This will trigger an OperationCanceledException
				End If
			Next i

			' Simulate PDF creation after the long process
			Dim pdf = Await Renderer.RenderHtmlAsPdfAsync("<h1>Hello, PDF!</h1>")

			' Save the PDF after ensuring no cancellation occurred
			pdf.SaveAs("output.pdf")
			Console.WriteLine("PDF generated successfully.")
		Catch e1 As OperationCanceledException
			' Handle task cancellation
			Console.WriteLine("PDF generation was canceled.")
		Catch ex As Exception
			' Handle other exceptions
			Console.WriteLine($"An error occurred: {ex.Message}")
		End Try
	End Function
End Class

Public Class Program
	Public Shared Async Function Main(ByVal args() As String) As Task
		' Create a CancellationTokenSource
		Dim cancellationTokenSource As New CancellationTokenSource()

		' Create our cancellation token
		Dim token = cancellationTokenSource.Token

		' Start the PDF generation task
		Dim pdfGenerator As New PdfGenerator()
		Dim pdfTask As Task = pdfGenerator.GeneratePdfWithCancellation(token)

		' Simulate a cancellation scenario
		Console.WriteLine("Press any key to cancel PDF generation...")
		Console.ReadKey()

		' Cancel the task by calling Cancel() on the CancellationTokenSource
		cancellationTokenSource.Cancel()

		Try
			' Await the task to handle any exceptions, such as cancellation
			Await pdfTask
		Catch e1 As OperationCanceledException
			' Confirm the cancellation
			Console.WriteLine("The PDF generation was canceled.")
		Finally
			cancellationTokenSource.Dispose()
		End Try

		Console.WriteLine("Program finished.")
	End Function
End Class

콘솔 출력

PDF 출력

이 예제에서는 IronPDF를 사용하여 오랜 시간 실행되는 PDF 생성 작업을 취소하기 위한 CancellationToken을 C# 프로그램에서 사용하는 방법을 보여줍니다. 코드는 두 부분으로 구성되어 있습니다: PDF 생성 프로세스 (PdfGenerator 클래스)와 메인 프로그램 로직 (Program 클래스).

• 클래스 PdfGenerator: 이 클래스는 CancellationToken을 통한 취소를 지원하면서 PDF 파일을 생성하는 시뮬레이션 메서드를 포함합니다.
• 우리는 main 메서드에서 CancellationTokenSource()를 사용하여 취소 토큰 소스를 생성하고, CancellationTokenSource의 Token 속성을 전달하여 우리 토큰 객체를 생성합니다.
• IronPDF 라이브러리의 ChromePdfRenderer는 HTML 콘텐츠를 PDF 문서로 렌더링하는 데 사용됩니다.
• GeneratePdfWithCancellation 메소드는 비동기(async)이며, Task를 반환합니다. 이 메소드는 작업 취소 요청을 통한 취소 처리를 위해 CancellationToken (token)을 수락합니다.
• CancellationToken을 사용하면 오랜 시간 실행되는 작업을 안전하게 취소할 수 있습니다. 그러나 취소는 협력적이며, 자체적으로 주기적으로 토큰 상태를 체크해야 합니다.
• 이 코드에서는 주기적인 취소 검사를 통해 긴 작업을 시뮬레이트합니다. 중요한 점은 PDF 생성 프로세스 동안 취소를 수동으로 확인(token.IsCancellationRequested)하여 토큰이 전달되면 취소 메소드를 실행할 준비가 되어 있다는 것입니다.
• 사용자가 프로그램 취소를 위한 키를 누르면 작업은 원활하게 중단되고 OperationCanceledException이 발생하여 PDF 생성이 적절하고 시기 적절하게 완료되지 않도록 합니다.
• 취소가 발생하지 않은 경우 생성된 PDF는 "output.pdf"로 저장되어 프로그램이 전체 작업 프로세스를 실행하는 것을 방지합니다.

1. 웹 애플리케이션

웹 애플리케이션에서는 사용자가 보고서 생성과 같은 PDF 형식의 작업을 자주 시작합니다. 그러나 사용자가 페이지를 벗어나거나 브라우저를 닫으면 시스템은 이를 감지하고 CancellationToken을 사용하여 PDF 생성 프로세스를 중단할 수 있습니다.

HttpContext.Response.RegisterForDispose(CancellationTokenSource);

HttpContext.Response.RegisterForDispose(CancellationTokenSource);

HttpContext.Response.RegisterForDispose(CancellationTokenSource)

이 간단한 구현은 필요하지 않은 작업에 자원을 할당하지 않음으로써 웹 서버가 더 효과적으로 확장할 수 있도록 합니다.

2. 장기 실행 보고서

보고 애플리케이션에서 사용자는 대규모 데이터 세트를 PDF로 내보내도록 요청할 수 있습니다. 사용자가 마음을 바꾸거나 잘못된 쿼리를 입력한 경우, CancellationToken을 통해 작업을 중간에 취소하여 자원의 낭비를 방지할 수 있습니다.

3. 백그라운드 서비스

백그라운드 서비스나 마이크로서비스에서 대규모 PDF 배치 생성과 같은 시간이 많이 소요되는 작업은 CancellationToken을 사용하여 더 효율적으로 관리할 수 있습니다. 서비스가 종료되거나 축소될 때 진행 중인 작업을 깔끔하게 취소하여 데이터 손실이나 손상을 방지합니다.