Кроме классов чтения-записи .NET предоставляет классы, которые позволяют сжимать файлы, а также затем восстанавливать их в исходное состояние.
Это классы ZipFile, DeflateStream и GZipStream, которые находятся в пространстве имен System.IO.Compression и представляют реализацию одного из алгоритмов сжатия Deflate или GZip.
Для создания объекта GZipStream можно использовать один из его конструкторов:
GZipStream(Stream stream, CompressionLevel level): stream представляет данные, а level задает уровень сжатияGZipStream(Stream stream, CompressionMode mode): mode указывает, будут ли данные сжиматься или, наоборот, восстанавливаться и может принимать два значения:
CompressionMode.Compress: данные сжимаются
CompressionMode.Decompress: данные восстанавливаются
Если данные сжимаются, то stream указывает на поток архивируемых данных. Если данные восстанавливаются, то stream указывает на поток, куда будут передаваться восстановленные данные.
GZipStream(Stream stream, CompressionLevel level, bool leaveMode): параметр leaveMode указывает, надо ли оставить открытым поток stream после удаления
объекта GZipStream. Если значение true, то поток остается открытымGZipStream(Stream stream, CompressionMode mode, bool leaveMode)Для управления сжатием/восстанавлением данных GZipStream предоставляет ряд методов. Основые из них:
void CopyTo(Stream destination): копирует все данные в поток destinationTask CopyToAsync(Stream destination): асинхронная версия метода CopyTovoid Flush(): очищает буфер, записывая все его данные в файлTask FlushAsync(): асинхронная версия метода Flushint Read(byte[] array, int offset, int count): считывает данные из файла в массив байтов и возвращает количество успешно считанных байтов.
Принимает три параметра:
array - массив байтов, куда будут помещены считываемые из файла данные
offset представляет смещение в байтах в массиве array, в который считанные байты будут помещены
count - максимальное число байтов, предназначенных для чтения. Если в файле находится меньшее количество байтов, то
все они будут считаны.
int Read(byte[] array, int offset, int count): считывает данные из файла в массив байтов и возвращает количество успешно считанных байтов.
Принимает три параметра:
array - массив байтов, куда будут помещены считываемые из файла данные
offset представляет смещение в байтах в массиве array, в который считанные байты будут помещены
count - максимальное число байтов, предназначенных для чтения. Если в файле находится меньшее количество байтов, то
все они будут считаны.
Task<int> ReadAsync(byte[] array, int offset, int count): асинхронная версия метода Read
long Seek(long offset, SeekOrigin origin): устанавливает позицию в потоке со смещением на количество байт,
указанных в параметре offset.
void Write(byte[] array, int offset, int count): записывает в файл данные из массива байтов. Принимает три параметра:
array - массив байтов, откуда данные будут записываться в файл
offset - смещение в байтах в массиве array, откуда начинается запись байтов в поток
count - максимальное число байтов, предназначенных для записи
Task WriteAsync(byte[] array, int offset, int count): асинхронная версия метода Write
Рассмотрим применение класса GZipStream на примере:
using System.IO.Compression;
string sourceFile = "book.pdf"; // исходный файл
string compressedFile = "book.gz"; // сжатый файл
string targetFile = "book_new.pdf"; // восстановленный файл
// создание сжатого файла
await CompressAsync(sourceFile, compressedFile);
// чтение из сжатого файла
await DecompressAsync(compressedFile, targetFile);
async Task CompressAsync(string sourceFile, string compressedFile)
{
// поток для чтения исходного файла
using FileStream sourceStream = new FileStream(sourceFile, FileMode.OpenOrCreate);
// поток для записи сжатого файла
using FileStream targetStream = File.Create(compressedFile);
// поток архивации
using GZipStream compressionStream = new GZipStream(targetStream, CompressionMode.Compress);
await sourceStream.CopyToAsync(compressionStream); // копируем байты из одного потока в другой
Console.WriteLine($"Сжатие файла {sourceFile} завершено.");
Console.WriteLine($"Исходный размер: {sourceStream.Length} сжатый размер: {targetStream.Length}");
}
async Task DecompressAsync(string compressedFile, string targetFile)
{
// поток для чтения из сжатого файла
using FileStream sourceStream = new FileStream(compressedFile, FileMode.OpenOrCreate);
// поток для записи восстановленного файла
using FileStream targetStream = File.Create(targetFile);
// поток разархивации
using GZipStream decompressionStream = new GZipStream(sourceStream, CompressionMode.Decompress);
await decompressionStream.CopyToAsync(targetStream);
Console.WriteLine($"Восстановлен файл: {targetFile}");
}
В данном случае подразумевается, что в папке с программой располагается файл book.pdf, который собственно и будет архивироваться.
Метод CompressAsync получает название исходного файла, который надо архивировать, и название будущего сжатого файла.
Сначала создается поток для чтения из исходного файла - FileStream sourceStream. Затем создается поток для записи в сжатый файл -
FileStream targetStream. Поток архивации GZipStream compressionStream инициализируется потоком targetStream и с помощью
метода CopyToAsync() получает данные от потока sourceStream.
Метод DecompressAsync производит обратную операцию по восстановлению сжатого файла в исходное состояние. Он принимает в качестве параметров
пути к сжатому файлу и будущему восстановленному файлу.
Здесь в начале создается поток для чтения из сжатого файла FileStream sourceStream, затем поток для записи в восстанавливаемый файл
FileStream targetStream. В конце создается поток GZipStream decompressionStream, который с помощью метода
CopyToAsync() копирует восстановленные данные в поток targetStream.
Чтобы указать потоку GZipStream, для чего именно он предназначен - сжатия или восстановления - ему в конструктор передается параметр CompressionMode, принимающий два значения: Compress и Decompress.
Пример консольного вывода программы:
Сжатие файла book.pdf завершено. Исходный размер: 3235353 сжатый размер: 2574401 Восстановлен файл: book_new.pdf
Если бы захотели бы использовать другой класс сжатия - DeflateStream, то мы могли бы просто заменить в коде упоминания GZipStream на DeflateStream, без изменения остального кода. Их использование идентично.
В то же время при использовании этих классов есть некоторые ограничения, в частности, мы можем сжимать только один файл. Для архивации группы файлы лучше выбрать другие инструменты, например, ZipFile.
Статический класс ZipFile из простанства имен System.IO.Compression предоставляет дополнительные возможности для создания архивов. Он позволяет создавать архив из каталогов. Его основные методы:
void CreateFromDirectory(string sourceDirectoryName, string destinationFileName): архивирует папку по пути sourceDirectoryName в
файл с названием destinationFileName
void ExtractToDirectory(string sourceFileName, string destinationDirectoryName): извлекает все файлы из zip-файла sourceFileName в каталог destinationDirectoryName
Оба метода имеют ряд дополнительных перегруженных версий. Рассмотрим их применение.
using System.IO.Compression;
string sourceFolder = "D://test/"; // исходная папка
string zipFile = "D://test.zip"; // сжатый файл
string targetFolder = "D://newtest"; // папка, куда распаковывается файл
ZipFile.CreateFromDirectory(sourceFolder, zipFile);
Console.WriteLine($"Папка {sourceFolder} архивирована в файл {zipFile}");
ZipFile.ExtractToDirectory(zipFile, targetFolder);
Console.WriteLine($"Файл {zipFile} распакован в папку {targetFolder}");
В данном случае папка "D://test/" методом ZipFile.CreateFromDirectory архивируется в файл test.zip. Затем метод
ZipFile.ExtractToDirectory() распаковывает данный файл в папку "D://newtest" (если такой папки нет, она создается).