Aspose.SVG for .NET 24.3.0 – сохранение SVG в поток

Aspose.SVG for .NET 24.3.0

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

Deprecated	New
IOutputStorage Interface	ResourceHandler Class
LocalFileSystemStorage Class	FileSystemResourceHandler Class

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

Класс ResourceHandler заменяет IOutputStorage интерфейс

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

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

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

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

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

using System.IO;
using Aspose.Svg.IO;
using System.IO.Compression;
...

	// Prepare a path to a source SVG file 
    string inputPath = Path.Combine(DataDir, "with-resources.svg");;
    
    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 SVG document 
    using (var doc = new SVGDocument(inputPath))
    {
        // Initialize an instance of the ZipStorage class
        using (var zipSrorage = new ZipStorage(customArchivePath))
        {
            // Save SVG with resources to a Zip archive
            doc.Save(zipSrorage);
        }
    }

В следующем фрагменте кода показана реализация IOutputStorage в классе ZipStorage для демонстрации сохранения документа SVG с ресурсами в 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.3.0

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

using System.IO;
using Aspose.Svg.IO;
using System.IO.Compression;
...

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

    var dir = Directory.GetCurrentDirectory();

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

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

В следующем фрагменте кода показана реализация ResourceHandler в классе ZipResourceHandler для демонстрации сохранения документа SVG с ресурсами в Zip-архив. Метод HandleResource() класса ZipResourceHandler отвечает за обработку каждого ресурса в процессе сохранения при создании 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();
        }
    }

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

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

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

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

using System.IO;
using Aspose.Svg.IO;
using System.Collections.Generic;
...

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

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

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

uri:memory:///with-resources.svg, length:556
uri:memory:///photo.png, length:57438

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

    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.3.0

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

using System.IO;
using Aspose.Svg.IO;
using System.Collections.Generic;
...

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

    // Initialize an SVG document
    using (var doc = new SVGDocument(inputPath))
    {
        // Create an instance of the MemoryResourceHandler class and save SVG 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 предлагает более упрощенный и выразительный способ обработки ресурсов при сохранении документов SVG в потоки памяти.

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

uri:memory:///with-resources.svg, length:556
uri:memory:///photo.png, length:57438

Класс FileSystemResourceHandler заменяет класс LocalFileSystemStorage

В отличие от класса LocalFileSystemStorage, новый класс FileSystemResourceHandler позволяет не только сохранять SVG-документы и ресурсы в выбранную папку, но и используя методы базового класса ResourceHandler контролировать запись ссылки в родительских файлах на сохраняемые вами файлы.

Сохранить SVG в хранилище локальной файловой системы

Здесь мы рассмотрим тот же пример сохранения файла SVG with-resources.svg в хранилище локальной файловой системы с использованием устаревшего класса LocalFileSystemStorage и нового класса FileSystemResourceHandler.

Использование класса LocalFileSystemStorage – 24.2.0 и более ранние версии

Исходный документ SVG со связанными файлами изображений находится в одном каталоге. Конструктор LocalFileSystemStorage(customOutDir) создает объект, который является хранилищем файловой системы. Метод Save(IOutputStorage) принимает этот объект и сохраняет SVG в выходное хранилище.

using System.IO;
using Aspose.Svg.IO;
...

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

    // Prepare a full path to an output directory 
    string customOutDir = Path.Combine(Directory.GetCurrentDirectory(), "./../../../../tests-out/old/");

    // Load the SVG document from a file
    using (var doc = new SVGDocument(inputPath))
    {
        // Save SVG with resources
        doc.Save(new LocalFileSystemStorage(customOutDir));
    }

Использование класса FileSystemResourceHandler – начиная с версии 24.3.0

Класс FileSystemResourceHandler является реализацией класса ResourceHandler в Aspose.SVG for .NET. Этот класс, специально разработанный для сохранения ресурсов в локальной файловой системе, предоставляет удобное и расширяемое решение для управления ресурсами при сохранении документов SVG. Следующий фрагмент кода демонстрирует использование класса FileSystemResourceHandler:

using System.IO;
using Aspose.Svg.IO;
...

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

    // Prepare a full path to an output directory 
    string customOutDir = Path.Combine(Directory.GetCurrentDirectory(), "./../../../../tests-out/new/");

    // Load the SVG document from a file
    using (var doc = new SVGDocument(inputPath))
    {
        // Save SVG with resources
        doc.Save(new FileSystemResourceHandler(customOutDir));
    }

Конструктор FileSystemResourceHandler(customOutDir) принимает путь, указывающий, где будут сохранены ресурсы, и создает объект FileSystemResourceHandler класса. Метод Save(resourceHandler) принимает этот объект и сохраняет SVG в выходное хранилище.

Вы можете загрузить полные примеры и файлы данных с GitHub. О загрузке с GitHub и запуске примеров вы узнаете из раздела Как запускать примеры.

Вы можете попробовать конвертировать документы SVG в другие форматы с помощью нашего Бесплатного онлайн-конвертера SVG.