ZipArchive Класс

Определение

Представляет пакет сжатых файлов в формате ZIP архива.Represents a package of compressed files in the zip archive format.

public ref class ZipArchive : IDisposable
public class ZipArchive : IDisposable
type ZipArchive = class
    interface IDisposable
Public Class ZipArchive
Implements IDisposable
Наследование
ZipArchive
Реализации

Примеры

В первом примере показано, как создать новую запись и выполнить запись в нее с помощью потока.The first example shows how to create a new entry and write to it by using a stream.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            using (FileStream zipToOpen = new FileStream(@"c:\users\exampleuser\release.zip", FileMode.Open))
            {
                using (ZipArchive archive = new ZipArchive(zipToOpen, ZipArchiveMode.Update))
                {
                    ZipArchiveEntry readmeEntry = archive.CreateEntry("Readme.txt");
                    using (StreamWriter writer = new StreamWriter(readmeEntry.Open()))
                    {
                            writer.WriteLine("Information about this package.");
                            writer.WriteLine("========================");
                    }
                }
            }
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Using zipToOpen As FileStream = New FileStream("c:\users\exampleuser\release.zip", FileMode.Open)
            Using archive As ZipArchive = New ZipArchive(zipToOpen, ZipArchiveMode.Update)
                Dim readmeEntry As ZipArchiveEntry = archive.CreateEntry("Readme.txt")
                Using writer As StreamWriter = New StreamWriter(readmeEntry.Open())
                    writer.WriteLine("Information about this package.")
                    writer.WriteLine("========================")
                End Using
            End Using
        End Using
    End Sub

End Module

В следующем примере показано, как открыть ZIP-архив и выполнить итерацию по коллекции записей.The following example shows how to open a zip archive and iterate through the collection of entries.

using System;
using System.IO;
using System.IO.Compression;

class Program
{
    static void Main(string[] args)
    {
        string zipPath = @".\result.zip";

        Console.WriteLine("Provide path where to extract the zip file:");
        string extractPath = Console.ReadLine();

        // Normalizes the path.
        extractPath = Path.GetFullPath(extractPath);

        // Ensures that the last character on the extraction path
        // is the directory separator char. 
        // Without this, a malicious zip file could try to traverse outside of the expected
        // extraction path.
        if (!extractPath.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal))
            extractPath += Path.DirectorySeparatorChar;

        using (ZipArchive archive = ZipFile.OpenRead(zipPath))
        {
            foreach (ZipArchiveEntry entry in archive.Entries)
            {
                if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
                {
                    // Gets the full path to ensure that relative segments are removed.
                    string destinationPath = Path.GetFullPath(Path.Combine(extractPath, entry.FullName));

                    // Ordinal match is safest, case-sensitive volumes can be mounted within volumes that
                    // are case-insensitive.
                    if (destinationPath.StartsWith(extractPath, StringComparison.Ordinal))
                        entry.ExtractToFile(destinationPath);
                }
            }
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = ".\result.zip"

        Console.WriteLine("Provide path where to extract the zip file:")
        Dim extractPath As String = Console.ReadLine()

        ' Normalizes the path.
        extractPath = Path.GetFullPath(extractPath)

        ' Ensures that the last character on the extraction path
        ' is the directory separator char. 
        ' Without this, a malicious zip file could try to traverse outside of the expected
        ' extraction path.
        If Not extractPath.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal) Then
            extractPath += Path.DirectorySeparatorChar
        End If

        Using archive As ZipArchive = ZipFile.OpenRead(zipPath)
            For Each entry As ZipArchiveEntry In archive.Entries
                If entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase) Then

                    ' Gets the full path to ensure that relative segments are removed.
                    Dim destinationPath As String = Path.GetFullPath(Path.Combine(extractPath, entry.FullName))
                    
                    ' Ordinal match is safest, case-sensitive volumes can be mounted within volumes that
                    ' are case-insensitive.
                    If destinationPath.StartsWith(extractPath, StringComparison.Ordinal) Then 
                        entry.ExtractToFile(destinationPath)
                    End If

                End If
            Next
        End Using
    End Sub

End Module

В третьем примере показано, как использовать методы расширения для создания новой записи в ZIP-архиве на основе существующего файла и извлечения содержимого архива.The third example shows how to use extension methods to create a new entry in a zip archive from an existing file and extract the archive contents. Чтобы выполнить код, System.IO.Compression.FileSystem необходимо сослаться на сборку.You must reference the System.IO.Compression.FileSystem assembly to execute the code.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string zipPath = @"c:\users\exampleuser\start.zip";
            string extractPath = @"c:\users\exampleuser\extract";
            string newFile = @"c:\users\exampleuser\NewFile.txt";
            
            using (ZipArchive archive = ZipFile.Open(zipPath, ZipArchiveMode.Update))
            {
                archive.CreateEntryFromFile(newFile, "NewEntry.txt");
                archive.ExtractToDirectory(extractPath);
            } 
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = "c:\users\exampleuser\end.zip"
        Dim extractPath As String = "c:\users\exampleuser\extract"
        Dim newFile As String = "c:\users\exampleuser\NewFile.txt"

        Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update)
            archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest)
            archive.ExtractToDirectory(extractPath)
        End Using
    End Sub

End Module

Комментарии

Методы управления ZIP-архивами и записи файлов распределены по трем классам: ZipFile, ZipArchiveи ZipArchiveEntry.The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive, and ZipArchiveEntry.

КомуTo ИспользоватьUse
Создание ZIP-архива из каталогаCreate a zip archive from a directory ZipFile.CreateFromDirectory
Извлечение содержимого ZIP-архива в каталогExtract the contents of a zip archive to a directory ZipFile.ExtractToDirectory
Добавление новых файлов в существующий ZIP-архивAdd new files to an existing zip archive ZipArchive.CreateEntry
Получение файла из ZIP-архиваRetrieve a file from a zip archive ZipArchive.GetEntry
Получение всех файлов из ZIP-архиваRetrieve all the files from a zip archive ZipArchive.Entries
Открытие потока в отдельный файл, содержащийся в ZIP-архивеOpen a stream to a single file contained in a zip archive ZipArchiveEntry.Open
Удаление файла из ZIP-архиваDelete a file from a zip archive ZipArchiveEntry.Delete

При создании новой записи файл сжимается и добавляется в ZIP-пакет.When you create a new entry, the file is compressed and added to the zip package. CreateEntry Метод позволяет указать иерархию каталогов при добавлении записи.The CreateEntry method enables you to specify a directory hierarchy when adding the entry. Вы включаете относительный путь новой записи в ZIP-пакете.You include the relative path of the new entry within the zip package. Например, создание новой записи с относительным путем AddedFolder\NewFile.txt создает сжатый текстовый файл в каталоге с именем аддедфолдер.For example, creating a new entry with a relative path of AddedFolder\NewFile.txt creates a compressed text file in a directory named AddedFolder.

Если вы ссылаетесь System.IO.Compression.FileSystem на сборку в проекте, вы можете получить доступ к четырем методам ZipFileExtensions расширения (из класса ZipArchive ) для CreateEntryFromFile(ZipArchive, String, String)класса CreateEntryFromFile(ZipArchive, String, String, CompressionLevel): ExtractToDirectory(ZipArchive, String),, ExtractToDirectory(ZipArchive, String, Boolean) и (доступно в .NET Core 2,0 и более поздних версий).If you reference the System.IO.Compression.FileSystem assembly in your project, you can access four extension methods (from the ZipFileExtensions class) for the ZipArchive class: CreateEntryFromFile(ZipArchive, String, String), CreateEntryFromFile(ZipArchive, String, String, CompressionLevel), ExtractToDirectory(ZipArchive, String), and ExtractToDirectory(ZipArchive, String, Boolean) (available in .NET Core 2.0 and later versions). Эти методы расширения позволяют сжимать и распаковать содержимое записи в файл.These extension methods enable you to compress and decompress the contents of the entry to a file. Сборка недоступна для Магазин Windows 8.xWindows 8.x Storeприложений. System.IO.Compression.FileSystemThe System.IO.Compression.FileSystem assembly is not available for Магазин Windows 8.xWindows 8.x Store apps. В Магазин Windows 8.xWindows 8.x Store приложениях можно сжимать и распаковывать файлы с DeflateStream помощью класса или GZipStream , а также использовать Среда выполнения WindowsWindows Runtime типы программы сжатия и декомпрессора. In Магазин Windows 8.xWindows 8.x Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the Среда выполнения WindowsWindows Runtime types Compressor and Decompressor.

Конструкторы

ZipArchive(Stream)

Инициализирует новый экземпляр класса ZipArchive из указанного потока.Initializes a new instance of the ZipArchive class from the specified stream.

ZipArchive(Stream, ZipArchiveMode)

Инициализирует новый экземпляр класса ZipArchive из указанного потока с указанным режимом.Initializes a new instance of the ZipArchive class from the specified stream and with the specified mode.

ZipArchive(Stream, ZipArchiveMode, Boolean)

Инициализирует новый экземпляр класса ZipArchive в указанном потоке для указанного режима, а также при необходимости оставляет поток открытым.Initializes a new instance of the ZipArchive class on the specified stream for the specified mode, and optionally leaves the stream open.

ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding)

Инициализирует новый экземпляр класса ZipArchive в указанном потоке для заданного режима, использует указанную кодировку для кодировку для имен записей, а также, при необходимости, оставляет поток открытым.Initializes a new instance of the ZipArchive class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open.

Свойства

Entries

Получает коллекцию сущностей, которые находятся в ZIP-архиве в текущий момент.Gets the collection of entries that are currently in the zip archive.

Mode

Получает значение, которое описывает тип действий, которые ZIP-архив может выполнять на записях.Gets a value that describes the type of action the zip archive can perform on entries.

Методы

CreateEntry(String)

Создает пустую запись, которая имеет указанные путь и имя записи в ZIP архиве.Creates an empty entry that has the specified path and entry name in the zip archive.

CreateEntry(String, CompressionLevel)

Создает пустую запись, которая имеет указанные имя и уровень сжатия ZIP записи в архиве.Creates an empty entry that has the specified entry name and compression level in the zip archive.

Dispose()

Освобождает ресурсы, используемые текущим экземпляром класса ZipArchive.Releases the resources used by the current instance of the ZipArchive class.

Dispose(Boolean)

Вызывается методами Dispose() и Finalize(), чтобы освободить неуправляемые ресурсы, используемые текущим экземпляром класса ZipArchive, и необязательно заканчивает запись архива и высвобождает управляемые ресурсы.Called by the Dispose() and Finalize() methods to release the unmanaged resources used by the current instance of the ZipArchive class, and optionally finishes writing the archive and releases the managed resources.

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetEntry(String)

Извлекает Программу-оболочку для заданной записи в ZIP-архиве.Retrieves a wrapper for the specified entry in the zip archive.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Методы расширения

CreateEntryFromFile(ZipArchive, String, String)

Архивирует файл, сжимая его и добавляя его в ZIP-архив.Archives a file by compressing it and adding it to the zip archive.

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

Архивирует файл, сжимая его с использованием заданного уровня сжатия и добавляя его в ZIP-архив.Archives a file by compressing it using the specified compression level and adding it to the zip archive.

ExtractToDirectory(ZipArchive, String)

Извлекает все файлы в ZIP-архиве в каталогу в файловой системе.Extracts all the files in the zip archive to a directory on the file system.

ExtractToDirectory(ZipArchive, String, Boolean)

Извлекает все файлы в архиве в каталог в файловой системе.Extracts all of the files in the archive to a directory on the file system.

Применяется к

Дополнительно