ZipArchive Třída

Definice

Představuje balíček komprimovaných souborů ve formátu archivu 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
Dědičnost
ZipArchive
Implementuje

Příklady

První příklad ukazuje, jak vytvořit novou položku a zapisovat do ní pomocí datového proudu.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

Následující příklad ukazuje, jak otevřít archiv zip a iterovat v kolekci položek.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

Třetí příklad ukazuje, jak použít rozšiřující metody k vytvoření nové položky v archivu zip z existujícího souboru a extrakci obsahu archivu.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. Chcete-li spustit kód, musíte odkazovat na sestavení 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

Poznámky

Metody pro manipulaci s archivy zip a jejich položky jsou rozdělené mezi tři třídy: ZipFile, ZipArchivea ZipArchiveEntry.The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive, and ZipArchiveEntry.

ProTo PoužitíUse
Vytvoření archivu zip z adresářeCreate a zip archive from a directory ZipFile.CreateFromDirectory
Extrakce obsahu archivu zip do adresářeExtract the contents of a zip archive to a directory ZipFile.ExtractToDirectory
Přidat nové soubory do existujícího archivu zipAdd new files to an existing zip archive ZipArchive.CreateEntry
Načtení souboru z archivu zipRetrieve a file from a zip archive ZipArchive.GetEntry
Načíst všechny soubory z archivu zipRetrieve all the files from a zip archive ZipArchive.Entries
Otevření datového proudu pro jeden soubor obsažený v archivu zipOpen a stream to a single file contained in a zip archive ZipArchiveEntry.Open
Odstranění souboru z archivu zipDelete a file from a zip archive ZipArchiveEntry.Delete

Když vytvoříte novou položku, soubor bude komprimován a přidán do balíčku zip.When you create a new entry, the file is compressed and added to the zip package. Metoda CreateEntry umožňuje při přidávání položky zadat hierarchii adresářů.The CreateEntry method enables you to specify a directory hierarchy when adding the entry. Do balíčku zip zadáte relativní cestu k nové položce.You include the relative path of the new entry within the zip package. Například vytvoření nové položky s relativní cestou AddedFolder\NewFile.txt vytvoří komprimovaný textový soubor v adresáři s názvem AddedFolder.For example, creating a new entry with a relative path of AddedFolder\NewFile.txt creates a compressed text file in a directory named AddedFolder.

Pokud odkazujete na System.IO.Compression.FileSystem sestavení v projektu, můžete získat přístup ke čtyřem rozšiřujícím metodám (z třídy ZipFileExtensions) pro třídu ZipArchive: CreateEntryFromFile(ZipArchive, String, String), CreateEntryFromFile(ZipArchive, String, String, CompressionLevel), ExtractToDirectory(ZipArchive, String)a ExtractToDirectory(ZipArchive, String, Boolean) (k dispozici v rozhraní .NET Core 2,0 a novějších verzích).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). Tyto metody rozšíření umožňují komprimovat a dekomprimovat obsah položky do souboru.These extension methods enable you to compress and decompress the contents of the entry to a file. System.IO.Compression.FileSystem sestavení není k dispozici pro Windows 8.x StoreWindows 8.x Store aplikace.The System.IO.Compression.FileSystem assembly is not available for Windows 8.x StoreWindows 8.x Store apps. V Windows 8.x StoreWindows 8.x Store aplikace můžete komprimovat a dekomprimovat soubory pomocí třídy DeflateStream nebo GZipStream, případně můžete použít kompresního a dekomprimačníhotypu prostředí Windows RuntimeWindows Runtime.In Windows 8.x StoreWindows 8.x Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the prostředí Windows RuntimeWindows Runtime types Compressor and Decompressor.

Konstruktory

ZipArchive(Stream)

Inicializuje novou instanci třídy ZipArchive ze zadaného datového proudu.Initializes a new instance of the ZipArchive class from the specified stream.

ZipArchive(Stream, ZipArchiveMode)

Inicializuje novou instanci třídy ZipArchive ze zadaného datového proudu a se zadaným režimem.Initializes a new instance of the ZipArchive class from the specified stream and with the specified mode.

ZipArchive(Stream, ZipArchiveMode, Boolean)

Inicializuje novou instanci třídy ZipArchive v zadaném datovém proudu pro zadaný režim a volitelně ponechá datový proud otevřený.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)

Inicializuje novou instanci třídy ZipArchive v zadaném datovém proudu pro zadaný režim, používá zadané kódování pro názvy záznamů a volitelně ponechá datový proud otevřený.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.

Vlastnosti

Entries

Získá kolekci položek, které jsou aktuálně v archivu zip.Gets the collection of entries that are currently in the zip archive.

Mode

Získá hodnotu, která popisuje typ akce, kterou může archiv zip provádět na položkách.Gets a value that describes the type of action the zip archive can perform on entries.

Metody

CreateEntry(String)

Vytvoří prázdnou položku, která má zadanou cestu a název položky v archivu zip.Creates an empty entry that has the specified path and entry name in the zip archive.

CreateEntry(String, CompressionLevel)

Vytvoří prázdnou položku, která má zadaný název položky a úroveň komprese v archivu zip.Creates an empty entry that has the specified entry name and compression level in the zip archive.

Dispose()

Uvolní prostředky používané aktuální instancí třídy ZipArchive.Releases the resources used by the current instance of the ZipArchive class.

Dispose(Boolean)

Volá se metodami Dispose() a Finalize() k uvolnění nespravovaných prostředků používaných aktuální instancí třídy ZipArchive a volitelně dokončí zápis archivu a uvolní spravované prostředky.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)

Určuje, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
GetEntry(String)

Načte obálku pro zadanou položku v archivu zip.Retrieves a wrapper for the specified entry in the zip archive.

GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetType()

Získá Type aktuální instance.Gets the Type of the current instance.

(Zděděno od Object)
MemberwiseClone()

Vytvoří kopii aktuálního Objectbez podstruktury.Creates a shallow copy of the current Object.

(Zděděno od Object)
ToString()

Vrací řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)

Metody rozšíření

CreateEntryFromFile(ZipArchive, String, String)

Archivuje soubor pomocí jeho komprimace a jeho přidání do archivu zip.Archives a file by compressing it and adding it to the zip archive.

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

Archivuje soubor pomocí komprimace na zadané úrovni komprese a jeho přidáním do archivu zip.Archives a file by compressing it using the specified compression level and adding it to the zip archive.

ExtractToDirectory(ZipArchive, String)

Extrahuje všechny soubory v archivu zip do adresáře v systému souborů.Extracts all the files in the zip archive to a directory on the file system.

ExtractToDirectory(ZipArchive, String, Boolean)

Extrahuje všechny soubory v archivu do adresáře v systému souborů.Extracts all of the files in the archive to a directory on the file system.

Platí pro

Viz také