Interrompre l'opération de sauvegarde suspendue

Malheureusement, il existe des situations où l’application se bloque lors de la sauvegarde de documents et cesse de répondre. Cette fonctionnalité vous permet d’annuler gracieusement les opérations de longue durée, telles que la sauvegarde de documents PDF volumineux ou complexes, empêchant ainsi les gels de l’application et améliorant la réactivité. Vous trouverez les informations pertinentes pour intégrer cette fonctionnalité dans vos applications. Notez que cette approche garantit que votre application reste réactive même pendant des opérations gourmandes en ressources.

La classe ‘InterruptMonitor’ fournit la capacité d’interrompre le processus de sauvegarde de documents s’il prend trop de temps. (https://reference.aspose.com/pdf/fr/net/aspose.pdf.multithreading/interruptmonitor/).

Le code suivant fonctionne également avec la bibliothèque Aspose.PDF.Drawing.

Utilisation d’InterruptMonitor

Soulignons que l’implémentation implique plusieurs étapes clés :

1. Création d’InterruptMonitor : Instanciez un objet InterruptMonitor. Cet objet agit comme un signal pour l’interruption de thread.

2. Attribution de ThreadLocalInstance : Avant de commencer l’opération Aspose.PDF de longue durée, attribuez l’instance InterruptMonitor à InterruptMonitor.ThreadLocalInstance pour le thread actuel. Cela lie le moniteur au thread.

3. Exécution du Thread : Exécutez le code contenant l’opération Aspose.PDF (par exemple, Document.Save()) dans un thread séparé.

4. Signal d’Interruption : À un moment approprié (par exemple, après un délai d’attente ou une action de l’utilisateur), appelez monitor.Interrupt(). Cela signale au thread de se terminer.

5. Gestion des Exceptions : La méthode Document.Save() lance une OperationCanceledException si elle est interrompue. Gérez cette exception à l’aide d’un bloc try-catch. N’oubliez pas qu’une gestion appropriée des exceptions est cruciale pour la stabilité de l’application.

Le code suivant vous montre comment utiliser InterruptMonitor dans le traitement PDF.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET
private static void InterruptMonitorExample()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Text();
    // Path to a large text file 
    var longTextFile = dataDir + "LongTextFile.txt";
    var outputFile = dataDir + "interrupt_output.pdf";
    var longText = File.ReadAllText(longTextFile);

    // Create an InterruptMonitor instance
    using (var monitor = new InterruptMonitor())
    {
        // Create a RowSpanWorker instance, passing the monitor
        var worker = new RowSpanWorker(outputFile, monitor, longText);

        // Start the worker thread
        var thread = new Thread(worker.Work);
        thread.Start();

        // Simulate a timeout (adjust as needed)
        Thread.Sleep(500);

        // Interrupt the thread
        monitor.Interrupt();

        // Wait for the thread to finish
        thread.Join();
    }
}

// Helper class to demonstrate how to handle PDF generation with interruption support
private class RowSpanWorker
{
    private readonly string outputPath;
    private readonly string longText;
    private readonly Aspose.Pdf.Multithreading.InterruptMonitor monitor;

    public RowSpanWorker(string outputPath, Aspose.Pdf.Multithreading.InterruptMonitor monitor, string longText)
    {
        this.outputPath = outputPath;
        this.monitor = monitor;
        this.longText = longText;
    }

    public void Work()
    {
        // Create PDF document
        using (var document  = new Aspose.Pdf.Document())
        {
            // Assign the InterruptMonitor to the current thread
            Aspose.Pdf.Multithreading.InterruptMonitor.ThreadLocalInstance = this.monitor;
            var page = document.Pages.Add();

            var table = new Aspose.Pdf.Table
            {
                DefaultCellBorder = new Aspose.Pdf.BorderInfo(Aspose.Pdf.BorderSide.All, 0.1F)
            };

            var row0 = table.Rows.Add();

            // Add a cell spanning multiple rows with long text
            var cell00 = row0.Cells.Add(this.longText);
            cell00.RowSpan = 2;
            cell00.IsWordWrapped = true;
            row0.Cells.Add("Ipsum Ipsum Ipsum");
            row0.Cells.Add("Dolor Dolor Dolor");

            var row1 = table.Rows.Add();
            row1.Cells.Add("Ipsum Dolor");
            row1.Cells.Add("Dolor Dolor");

            page.Paragraphs.Add(table);

            try
            {
                // Save the document (this operation can be interrupted)
                document.Save(this.outputPath);
            }
            catch (OperationCanceledException ex)
            {
                Console.WriteLine($"Operation cancelled: {ex.Message}");
            }
        }
    }
}

.NET 8

private static void InterruptMonitorExample()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Text();

    // Construct a long text string to simulate a long process
    var longTextFile = Path.Combine(dataDir, "LongTextFile.txt");
    var outputFile = Path.Combine(dataDir, "interrupt_output.pdf");
    var longText = File.ReadAllText(longTextFile);

    // Create an InterruptMonitor instance
    using Aspose.Pdf.Multithreading.InterruptMonitor monitor = new();

    // Create a RowSpanWorker instance, passing the monitor
    var worker = new RowSpanWorker(outputFile, monitor, longText);

    // Start the worker thread
    var thread = new Thread(worker.Work);
    thread.Start();

    // Simulate a timeout (adjust as needed)
    Thread.Sleep(500);

    // Interrupt the thread
    monitor.Interrupt();

    // Wait for the thread to finish
    thread.Join();    
}

// Helper class to demonstrate how to handle PDF generation with interruption support
public class RowSpanWorker
{
    private readonly string _outputFile;
    private readonly InterruptMonitor _monitor;
    private readonly string _longText;

    public RowSpanWorker(string outputFile, Aspose.Pdf.Multithreading.InterruptMonitor monitor, string longText)
    {
        _outputFile = outputFile;
        _monitor = monitor;
        _longText = longText;
    }

    public void Work()
    {
        // Create PDF document
        using Aspose.Pdf.Document document = new();

        // Assign the InterruptMonitor to the current thread
        Aspose.Pdf.Multithreading.InterruptMonitor.ThreadLocalInstance = this._monitor;
        var page = document.Pages.Add();

        var table = new Aspose.Pdf.Table
        {
            DefaultCellBorder = new Aspose.Pdf.BorderInfo(Aspose.Pdf.BorderSide.All, 0.1F)
        };

        var row0 = table.Rows.Add();

        // Add a cell spanning multiple rows with long text
        var cell00 = row0.Cells.Add(this._longText);
        cell00.RowSpan = 2;
        cell00.IsWordWrapped = true;
        row0.Cells.Add("Ipsum Ipsum Ipsum Ipsum Ipsum Ipsum ");
        row0.Cells.Add("Dolor Dolor Dolor Dolor Dolor Dolor ");

        var row1 = table.Rows.Add();
        row1.Cells.Add("IpsumDolor Dolor Dolor Dolor Dolor ");
        row1.Cells.Add("DolorDolor Dolor Dolor Dolor Dolor ");

        page.Paragraphs.Add(table);
        try
        {
            // Save() operation supports interruption 
            document.Save(this._outputFile);
        }
        catch (OperationCanceledException ex)
        {
            // Print operation cancel exception's message to console 
            Console.WriteLine(ex.Message);
        }
    }
}