Aspose.HTML for .NET 24.2 – Сохранение HTML в поток

Aspose.HTML for .NET 24.2

В версии 24.2 интерфейс IOutputStorage объявлен устаревшим, но он будет продолжать работать до выхода версии 24.5. Если вы используете более ранние версии Aspose.HTML for .NET, мы рекомендуем вам обновиться и перейти на новую версию, поскольку версия 24.5 удалит этот устаревший интерфейс.

Deprecated	New
IOutputStorage Interface	ResourceHandler Class

HTML-документ может содержать различные ресурсы, такие как CSS, внешние изображения и файлы. В статье мы рассмотрим случаи сохранения HTML-документов с ресурсами в Zip-архив и поток памяти. Aspose.HTML for .NET продолжает развивать и совершенствовать способы сохранения HTML-кодов со всеми связанными файлами. Здесь мы рассмотрим примеры сохранения файлов с использованием устаревших классов и предложим продвинутые решения по реализации новых классов.

Класс ResourceHandler против интерфейса IOutputStorage

Класс ResourceHandler позволяет разработчикам реализовать метод HandleResource(), в котором вы можете самостоятельно создать поток и выпустить его там, где вам это нужно. Новый метод добавляет возможность видеть Resource и обрабатывать дополнительную информацию о нем. Таким образом, приняв класс ResourceHandler, разработчики могут получить выгоду от более оптимизированного и выразительного подхода к управлению ресурсами, что приводит к более чистому, удобному в обслуживании и гибкому коду при сохранении HTML-документов.

Сохранить HTML в ZIP-архив

Здесь мы рассмотрим один и тот же пример сохранения файла with-resources.html в Zip-архив с использованием устаревшего интерфейса IOutputStorage и нового класса ResourceHandler.

Использование IOutputStorage – 24.1.0 и более ранние версии

Интерфейс IOutputStorage был базовым интерфейсом, который поддерживал создание потоков вывода и управление ими. Вы можете реализовать интерфейс IOutputStorage, создав класс ZipStorage для сохранения HTML с ресурсами в Zip-архив:

using System.IO;
using Aspose.Html;
using Aspose.Html.Saving;
using System.IO.Compression;
...

	// Prepare a path to a source HTML file 
    string inputPath = Path.Combine(DataDir, "with-resources.html");;
    
    var dir = Directory.GetCurrentDirectory();

    // Prepare a full path to an output Zip storage
    string customArchivePath = Path.Combine(dir, "./../../../../tests-out/old/archive.zip");

    // Load the HTML document 
    using (var doc = new HTMLDocument(inputPath))
    {
        // Initialize an instance of the ZipStorage class
        using (var zipSrorage = new ZipStorage(customArchivePath))
        {
            // Save HTML with resources to a Zip archive
            doc.Save(zipSrorage);
        }
    }

В следующем фрагменте кода показана реализация IOutputStorage в классе ZipStorage для демонстрации сохранения HTML-документа с ресурсами в Zip-архив:

    internal class ZipStorage : IOutputStorage, IDisposable
    {
        private FileStream zipStream;
        private ZipArchive archive;
        private int streamsCounter;
        private bool initialized;

        public ZipStorage(string name)
        {
            DisposeArchive();
            zipStream = new FileStream(name, FileMode.Create);
            archive = new ZipArchive(zipStream, ZipArchiveMode.Update);
            initialized = false;
        }

        public OutputStream CreateStream(OutputStreamContext context)
        {
            var zipUri = (streamsCounter++ == 0 ? Path.GetFileName(context.Uri) :
                Path.Combine(Path.GetFileName(Path.GetDirectoryName(context.Uri)), Path.GetFileName(context.Uri)));
            var samplePrefix = String.Empty;
            if (initialized)
                samplePrefix = "my_";
            else
                initialized = true;

            var newStream = archive.CreateEntry(samplePrefix + zipUri).Open();
            var outputStream = new OutputStream(newStream, "file:///" + samplePrefix + zipUri);
            return outputStream;
        }

        public void ReleaseStream(OutputStream stream)
        {
            stream.Flush();
            stream.Close();
        }

        private void DisposeArchive()
        {
            if (archive != null)
            {
                archive.Dispose();
                archive = null;
            }
            if (zipStream != null)
            {
                zipStream.Dispose();
                zipStream = null;
            }
            streamsCounter = 0;
        }

        public void Dispose()
        {
            DisposeArchive();
        }
    }

Использование нового класса ResourceHandler – начиная с версии 24.2.

Класс ResourceHandler предназначен для реализации пользователями. В следующем примере C# показано, как сохранить документ HTML с ресурсами в Zip-архив с помощью класса ZipResourceHandler:

using System.IO;
using Aspose.Html;
using Aspose.Html.Saving;
using Aspose.Html.Saving.ResourceHandlers;
using System.IO.Compression;
...

    // Prepare a path to a source HTML file 
    string inputPath = Path.Combine(DataDir, "with-resources.html");

    var dir = Directory.GetCurrentDirectory();

    // Prepare a full path to an output zip storage
    string customArchivePath = Path.Combine(dir, "./../../../../tests-out/new/archive.zip");

    // Load the HTML document
    using (var doc = new HTMLDocument(inputPath))
    {
        // Initialize an instance of the ZipResourceHandler class
        using (var resourceHandler = new ZipResourceHandler(customArchivePath))
        {
            // Save HTML with resources to a Zip archive
            doc.Save(resourceHandler);
        }
    }

В следующем фрагменте кода показана реализация ResourceHandler в классе ZipResourceHandler для демонстрации сохранения HTML-документа с ресурсами в Zip-архив. Метод HandleResource() отвечает за обработку каждого ресурса в процессе сохранения при создании Zip-архива:

    internal class ZipResourceHandler : ResourceHandler, IDisposable
    {
        private FileStream zipStream;
        private ZipArchive archive;
        private int streamsCounter;
        private bool initialized;

        public ZipResourceHandler(string name)
        {
            DisposeArchive();
            zipStream = new FileStream(name, FileMode.Create);
            archive = new ZipArchive(zipStream, ZipArchiveMode.Update);
            initialized = false;
        }

        public override void HandleResource(Resource resource, ResourceHandlingContext context)
        {
            var zipUri = (streamsCounter++ == 0
                ? Path.GetFileName(resource.OriginalUrl.Href)
                : Path.Combine(Path.GetFileName(Path.GetDirectoryName(resource.OriginalUrl.Href)),
                    Path.GetFileName(resource.OriginalUrl.Href)));
            var samplePrefix = String.Empty;
            if (initialized)
                samplePrefix = "my_";
            else
                initialized = true;

            using (var newStream = archive.CreateEntry(samplePrefix + zipUri).Open())
            {
                resource.WithOutputUrl(new Url("file:///" + samplePrefix + zipUri)).Save(newStream, context);
            }
        }

        private void DisposeArchive()
        {
            if (archive != null)
            {
                archive.Dispose();
                archive = null;
            }

            if (zipStream != null)
            {
                zipStream.Dispose();
                zipStream = null;
            }

            streamsCounter = 0;
        }

        public void Dispose()
        {
            DisposeArchive();
        }
    }

Сохранение HTML в потоки памяти

Давайте рассмотрим пример C# сохранения HTML-файла со связанными ресурсами в поток памяти с использованием устаревшего интерфейса IOutputStorage и нового класса ResourceHandler. Исходный документ with-resources.html и связанные с ним файлы находятся в одном каталоге.

Использование IOutputStorage – 24.1.0 и более ранние версии

Реализация интерфейса IOutputStorage позволяла сохранять HTML в потоки памяти:

using System.IO;
using Aspose.Html;
using Aspose.Html.Saving;
using System.Collections.Generic;
...

    // Prepare a path to a source HTML file
    string inputPath = Path.Combine(DataDir, "with-resources.html");

    // Initialaze an HTML document
    using (var doc = new HTMLDocument(inputPath))
    {
        // Create an instance of the MemoryOutputStorage class and save HTML to memory
        var memoryStorage = new MemoryOutputStorage();
        doc.Save(memoryStorage);
	    memoryStorage.PrintInfo();
    }

После запуска примера будет напечатано сообщение о хранении в памяти:

uri:memory:///with-resources.html, length:256
uri:memory:///photo1.png, length:57438

В следующем фрагменте кода показана реализация IOutputStorage в классе MemoryOutputStorage для демонстрации сохранения HTML-документа в потоках памяти:

    internal class MemoryOutputStorage : IOutputStorage
    {
        public List<Tuple<OutputStream, string>> Streams;

        public MemoryOutputStorage()
        {
            Streams = new List<Tuple<OutputStream, string>>();
        }

        public OutputStream CreateStream(OutputStreamContext context)
        {
            var normalizedPath = new Url(context.Uri).Pathname;
            var uri = new Url(Path.GetFileName(normalizedPath), "memory:///").Href;
            var outputStream = new OutputStream(new MemoryStream(), uri);
            Streams.Add(Tuple.Create(outputStream, uri));
            return outputStream;
        }

        public void ReleaseStream(OutputStream stream)
        {
            stream.Flush();
        }

        public void PrintInfo()
        {
            foreach (var stream in Streams)
                Console.WriteLine($"uri:{stream.Item2}, length:{stream.Item1.Length}");
        }
    }

Использование нового класса ResourceHandler – начиная с версии 24.2.

В следующем фрагменте кода показана реализация ResourceHandler в классе MemoryResourceHandler для демонстрации сохранения HTML-документа в потоках памяти:

using System.IO;
using Aspose.Html;
using Aspose.Html.Saving;
using Aspose.Html.Saving.ResourceHandlers;
using System.Collections.Generic;
...

    // Prepare a path to a source HTML file 
    string inputPath = Path.Combine(DataDir, "with-resources.html");
    
    // Load the HTML document
    using (var doc = new HTMLDocument(inputPath))
    {
        // Create an instance of the MemoryResourceHandler class and save HTML to memory
        var resourceHandler = new MemoryResourceHandler();
        doc.Save(resourceHandler);
        resourceHandler.PrintInfo();
    }

Вместо методов CreateStream() и ReleaseStream(), реализованных в классе MemoryOutputStorage интерфейса IOutputStorage, теперь существует один метод HandleResource(), реализованный в классе MemoryResourceHandler интерфейса ResourceHandler, в котором вы можете сами создать поток и выпустить его туда, где вам это нужно. Новый метод добавляет возможность видеть Resource и обрабатывать дополнительную информацию о нем:

    internal class MemoryResourceHandler : ResourceHandler
    {
        public List<Tuple<Stream, Resource>> Streams;

        public MemoryResourceHandler()
        {
            Streams = new List<Tuple<Stream, Resource>>();
        }

        public override void HandleResource(Resource resource, ResourceHandlingContext context)
        {
            var outputStream = new MemoryStream();
            Streams.Add(Tuple.Create<Stream, Resource>(outputStream, resource));
            resource
                .WithOutputUrl(new Url(Path.GetFileName(resource.OriginalUrl.Pathname), "memory:///"))
                .Save(outputStream, context);
        }

        public void PrintInfo()
        {
            foreach (var stream in Streams)
                Console.WriteLine($"uri:{stream.Item2.OutputUrl}, length:{stream.Item1.Length}");
        }
    }

Как видите, новый подход напрямую работает с объектами Resource, устраняя необходимость в дополнительных классах, таких как OutputStream. Это упрощает код и делает взаимодействие с ресурсами более явным и понятным. Таким образом, базовый класс ResourceHandler предлагает более упрощенный и выразительный способ обработки ресурсов при сохранении HTML-документов в потоки памяти.

После запуска примера будет напечатано сообщение о хранении в памяти:

uri:memory:///with-resources.html, length:256
uri:memory:///photo1.png, length:57438

Aspose.HTML предлагает бесплатные Приложения HTML, которые представляют собой онлайн-коллекцию бесплатных конвертеров, слияний, инструментов SEO, генераторов HTML-кода, инструментов URL и многого другого. Приложения работают в любой операционной системе с веб-браузером и не требуют установки дополнительного программного обеспечения. Это быстрый и простой способ эффективно и результативно решить ваши задачи, связанные с HTML документами.