Регистрация времени выполнения – Конвертация HTML – С#

В этой статье вы найдете пример использования пользовательских обработчиков сообщений для конвертации HTML из ZIP-архива в PDF и регистрации времени выполнения этого преобразования.

Иногда для оптимизации производительности может потребоваться узнать время выполнения веб-запроса. Например, вы хотите знать, сколько времени уходит на преобразование HTML из ZIP-архива в PDF.

Конвертировать HTML из ZIP-архива в PDF – регистрация времени выполнения

Создание обработчика сообщений для пользовательской реализации схемы

Давайте создадим собственный обработчик, который вы можете использовать для реализации пользовательской схемы (протокола). Сделайте следующие шаги:

1. Используйте необходимое пространство имен, которым является Aspose.Html.Net.
2. Определите свой собственный класс CustomSchemaMessageHandler, который будет производным от класса MessageHandler.
3. Инициализируйте экземпляр класса CustomSchemaMessageHandler и определите для него свойство Filter.
4. Создайте класс CustomSchemaMessageFilter, производный от класса MessageFilter.
5. Переопределите метод Match() класса MessageFilter для реализации пользовательского поведения обработчика сообщений.

В следующем фрагменте кода показано, как создать класс CustomSchemaMessageHandler:

using Aspose.Html.Net;
...

    // Define the CustomSchemaMessageHandler class that is derived from the MessageHandler class
    abstract class CustomSchemaMessageHandler : MessageHandler
    {
        protected CustomSchemaMessageHandler(string schema)
        {
            Filters.Add(new CustomSchemaMessageFilter(schema));
        }
    }

    // Define the CustomSchemaMessageFilter class that is derived from the MessageFilter class
    class CustomSchemaMessageFilter : MessageFilter
    {
        private readonly string schema;
        public CustomSchemaMessageFilter(string schema)
        {
            this.schema = schema;
        }

    	// Override the Match() method
    	public override bool Match(INetworkOperationContext context)
        {
            return string.Equals(schema, context.Request.RequestUri.Protocol.TrimEnd(':'));
        }
    }

Конструктор CustomSchemaMessageHandler(schema) создает экземпляр объекта CustomSchemaMessageHandler и принимает схему в качестве параметра. Метод Add() добавляет объект CustomSchemaMessageFilter в конец коллекции. Метод Match() проверяет, удовлетворяет ли контекст критериям фильтрации.

Создание ZipFileSchemaMessageHandler для работы с ZIP-архивами

В следующем фрагменте кода показано, как создать класс ZipFileSchemaMessageHandler для работы с ZIP-архивами:

using System.IO;
using System.Linq;
using System.Net;
using Aspose.Html;
using Aspose.Html.Net;
using Aspose.Html.Services;
using Aspose.Zip;
...

	// Define the ZipFileSchemaMessageHandler class that is derived from the CustomSchemaMessageHandler class
	class ZipFileSchemaMessageHandler : CustomSchemaMessageHandler
	{
	    private readonly Archive archive;

	    public ZipFileSchemaMessageHandler(Archive archive) : base("zip-file")
	    {
	        this.archive = archive;
	    }

	    // Override the Invoke() method
	    public override void Invoke(INetworkOperationContext context)
	    {
	        var pathInsideArchive = context.Request.RequestUri.Pathname.TrimStart('/').Replace("\\", "/");
	        var stream = GetFile(pathInsideArchive);

	        if (stream != null)
	        {
	            // Checking: if a resource is found in the archive, then return it as a Response
	            var response = new ResponseMessage(HttpStatusCode.OK);
	            response.Content = new StreamContent(stream);
	            response.Headers.ContentType.MediaType = MimeType.FromFileExtension(context.Request.RequestUri.Pathname);
	            context.Response = response;
	        }
	        else
	        {
	            context.Response = new ResponseMessage(HttpStatusCode.NotFound);
	        }
	
	        // Invoke the next message handler in the chain
	        Next(context);
	    }

	    Stream GetFile(string path)
	    {
	        var result = archive
	            .Entries
	            .FirstOrDefault(x => x.Name == path);
	        return result?.Open();
	    }
	}
 

В приведенном выше примере реализован поиск ресурса (zip-архива) по его URI. Если ресурс найден, метод FromFileExtension() возвращает MimeType ресурса.

Обработчик сообщений для регистрации времени выполнения веб-запроса

В следующем фрагменте кода показано, как создать StartRequestDurationLoggingMessageHandler и StopRequestDurationLoggingMessageHandler для регистрации времени, затраченного на выполнение веб-запроса.

using System;
using System.Collections.Concurrent;
using System.Diagnostics;
using Aspose.Html;
using Aspose.Html.Net;
...

	// Define the RequestDurationLoggingMessageHandler class that is derived from the MessageHandler class
	abstract class RequestDurationLoggingMessageHandler : MessageHandler
	{
	    private static ConcurrentDictionary<Url, Stopwatch> requests = new ConcurrentDictionary<Url, Stopwatch>();

	    protected void StartTimer(Url url)
	    {
	        requests.TryAdd(url, Stopwatch.StartNew());
	    }

	    protected TimeSpan StopTimer(Url url)
	    {
	        var timer = requests[url];
	        timer.Stop();
	        return timer.Elapsed;
	    }
	}

	// Create StartRequestDurationLoggingMessageHandler that starts the timer
	class StartRequestDurationLoggingMessageHandler : RequestDurationLoggingMessageHandler
	{
	    // Override the Invoke() method
	    public override void Invoke(INetworkOperationContext context)
	    {
	        // Start the stopwatch
	        StartTimer(context.Request.RequestUri);

	        // Invoke the next message handler in the chain
	        Next(context);
	    }
	}

	// StopRequestDurationLoggingMessageHandler stops the timer
	class StopRequestDurationLoggingMessageHandler : RequestDurationLoggingMessageHandler
	{
	    // Override the Invoke() method
	    public override void Invoke(INetworkOperationContext context)
	    {
	        // Stop the stopwatch
	        var duration = StopTimer(context.Request.RequestUri);

	        // Print the result
	        Console.WriteLine($"Elapsed: {duration:g}, resource: {context.Request.RequestUri.Pathname}");

	        // Invoke the next message handler in the chain
	        Next(context);
	    }
	}

Добавление обработчиков сообщений в конвейер

Ключевой концепцией работы обработчиков сообщений является объединение их в цепочку. Мы создали несколько обработчиков сообщений и должны добавить их в конвейер в определенном порядке, чтобы реализовать пример регистрации времени преобразования HTML из ZIP-архива в PDF. Выполним следующие шаги:

1. Создайте экземпляр класса Configuration.
2. Реализуйте пользовательскую схему ZIP. Используйте метод Add(), чтобы добавить ZipFileSchemaMessageHandler в конец конвейера.
3. Выполните регистрацию продолжительности. Используйте метод Insert(), чтобы добавить StartRequestDurationLoggingMessageHandler первым в конвейер, и метод Add(), чтобы добавить StopRequestDurationLoggingMessageHandler в конец конвейера.
4. Инициализировать документ HTML с указанной конфигурацией.
5. Создайте PDF-устройство и преобразуйте HTML в PDF.

using Aspose.Html;
using Aspose.Html.Net;
using Aspose.Html.Rendering.Pdf;
using Aspose.Html.Services;
using Aspose.Zip;
...

​    // Prepare path to a source zip file
​    string documentPath = Path.Combine(DataDir, "test.zip");

    // Prepare path for converted file saving
    string savePath = Path.Combine(OutputDir, "zip-to-pdf-duration.pdf");

    // Create an instance of the Configuration class
    using var configuration = new Configuration();
    var service = configuration.GetService<INetworkService>();
    var handlers = service.MessageHandlers;

    // Custom Schema: ZIP. Add ZipFileSchemaMessageHandler to the end of the pipeline
    handlers.Add(new ZipFileSchemaMessageHandler(new Archive(documentPath)));

    // Duration Logging. Add the StartRequestDurationLoggingMessageHandler at the first place in the pipeline
    handlers.Insert(0, new StartRequestDurationLoggingMessageHandler());

    // Add the StopRequestDurationLoggingMessageHandler to the end of the pipeline
    handlers.Add(new StopRequestDurationLoggingMessageHandler());

    // Initialize an HTML document with specified configuration
    using var document = new HTMLDocument("zip-file:///test.html", configuration);

    // Create the PDF Device
    using var device = new PdfDevice(savePath);

    // Render ZIP to PDF
    document.RenderTo(device);

Конструктор Configuration() создает экземпляр класса Configuration. После создания конфигурации вызываются методы GetService(), MessageHandlers.Add() и MessageHandlers.Insert(). Методы Insert() и Add() добавляют пользовательские обработчики сообщений в коллекцию существующих обработчиков сообщений. На рисунке показана цепочка обработчиков сообщений для этого примера:

Примечание. Конструктор HTMLDocument(address, configuration) принимает абсолютный путь к ZIP-архиву. Но все связанные ресурсы имеют относительные пути в документе HTML и в коде примера.

Вы можете скачать полные примеры и файлы данных с GitHub.