ZipArchive Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Představuje balíček komprimovaných souborů ve formátu archivu zip.
public ref class ZipArchive : IDisposable
public ref class ZipArchive : IAsyncDisposable, IDisposable
public class ZipArchive : IDisposable
public class ZipArchive : IAsyncDisposable, IDisposable
type ZipArchive = class
interface IDisposable
type ZipArchive = class
interface IAsyncDisposable
interface IDisposable
Public Class ZipArchive
Implements IDisposable
Public Class ZipArchive
Implements IAsyncDisposable, IDisposable
- Dědičnost
-
ZipArchive
- Implementuje
Poznámky
Metody manipulace s archivy zip a jejich záznamy souboru jsou rozloženy do tří tříd: ZipFile, ZipArchivea ZipArchiveEntry.
| To | Use |
|---|---|
| Vytvoření archivu zip z adresáře | ZipFile.CreateFromDirectory |
| Extrahování obsahu archivu zip do adresáře | ZipFile.ExtractToDirectory |
| Přidání nových souborů do existujícího archivu zip | ZipArchive.CreateEntry |
| Načtení souboru z archivu zip | ZipArchive.GetEntry |
| Načtení všech souborů z archivu zip | ZipArchive.Entries |
| Otevření datového proudu do jednoho souboru obsaženého v archivu zip | ZipArchiveEntry.Open |
| Odstranění souboru z archivu zip | ZipArchiveEntry.Delete |
Když vytvoříte novou položku, soubor se zkomprimuje a přidá do balíčku ZIP. Metoda CreateEntry umožňuje určit hierarchii adresářů při přidávání položky. Do balíčku ZIP zahrnete relativní cestu nové položky. Například vytvoření nové položky s relativní cestou k vytvoření komprimovaného textového AddedFolder\NewFile.txt souboru v adresáři s názvem AddedFolder.
Pokud odkazujete na sestavení System.IO.Compression.FileSystem v projektu, Pro třídu ZipFileExtensions můžete přistupovat ke čtyřem metodám rozšíření (z třídy ZipArchive) pro třídu ZipFileExtensions: CreateEntryFromFile(ZipArchive, String, String, CompressionLevel), ExtractToDirectory(ZipArchive, String), ExtractToDirectory(ZipArchive, String, Boolean) a (dostupné v .NET Core 2.0 a novějších verzích). Tyto rozšiřující metody umožňují komprimovat a dekomprimovat obsah položky do souboru. Sestavení System.IO.Compression.FileSystem není k dispozici pro aplikace Windows 8.x Store. V aplikacích Windows 8.x Store můžete komprimovat a dekompresovat soubory pomocí třídy DeflateStream nebo GZipStream nebo můžete použít typy prostředí Windows Runtime <xref:Windows.Storage.Compression.Compressor> a <xref:Windows.Storage.Compression.Decompressor>.
Příklady
První příklad ukazuje, jak vytvořit novou položku a zapisovat do ní pomocí datového proudu.
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 prostřednictvím kolekce položek.
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 pomocí rozšiřujících metod vytvořit novou položku v archivu ZIP z existujícího souboru a extrahovat obsah archivu. Ke spuštění kódu je nutné odkazovat System.IO.Compression.FileSystem na sestavení.
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
Konstruktory
| Name | Description |
|---|---|
| ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding) |
Inicializuje novou instanci ZipArchive třídy v zadaném datovém proudu pro zadaný režim, použije zadané kódování pro názvy položek a volitelně ponechá stream otevřený. |
| ZipArchive(Stream, ZipArchiveMode, Boolean) |
Inicializuje novou instanci ZipArchive třídy v zadaném datovém proudu pro zadaný režim a volitelně ponechá stream otevřený. |
| ZipArchive(Stream, ZipArchiveMode) |
Inicializuje novou instanci ZipArchive třídy ze zadaného datového proudu a se zadaným režimem. |
| ZipArchive(Stream) |
Inicializuje novou instanci ZipArchive třídy ze zadaného datového proudu. |
Vlastnosti
| Name | Description |
|---|---|
| Comment |
Získá nebo nastaví volitelný komentář archivu. |
| Entries |
Získá kolekci položek, které jsou aktuálně v archivu zip. |
| Mode |
Získá hodnotu, která popisuje typ akce archiv zip může provádět s položkami. |
Metody
| Name | Description |
|---|---|
| CreateAsync(Stream, ZipArchiveMode, Boolean, Encoding, CancellationToken) |
Asynchronně inicializuje a vrátí novou instanci daného datového ZipArchive proudu v zadaném režimu a určuje, zda se má datový proud ponechat otevřený, s volitelným kódováním a volitelným tokenem zrušení. |
| CreateEntry(String, CompressionLevel) |
Vytvoří prázdnou položku, která má zadaný název položky a úroveň komprese v archivu zip. |
| CreateEntry(String) |
Vytvoří prázdnou položku, která má zadanou cestu a název položky v archivu zip. |
| Dispose() |
Uvolní prostředky používané aktuální instancí ZipArchive třídy. |
| Dispose(Boolean) |
Volá se metodami Dispose() a Finalize() uvolní nespravované prostředky používané aktuální instancí ZipArchive třídy a volitelně dokončí zápis archivu a uvolní spravované prostředky. |
| DisposeAsync() |
Představuje balíček komprimovaných souborů ve formátu archivu zip. |
| DisposeAsyncCore() |
Představuje balíček komprimovaných souborů ve formátu archivu zip. |
| Equals(Object) |
Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object) |
| GetEntry(String) |
Načte obálku pro zadanou položku v archivu zip. |
| GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
Metody rozšíření
| Name | Description |
|---|---|
| ConfigureAwait(IAsyncDisposable, Boolean) |
Konfiguruje, jak čekají na úlohy vrácené z asynchronního jednorázového použití. |
| CreateEntryFromFile(ZipArchive, String, String, CompressionLevel) |
Archivuje soubor tak, že ho zkomprimuje pomocí zadané úrovně komprese a přidá ho do archivu zip. |
| CreateEntryFromFile(ZipArchive, String, String) |
Archivuje soubor tím, že ho zkomprimuje a přidá do archivu zip. |
| CreateEntryFromFileAsync(ZipArchive, String, String, CancellationToken) |
Asynchronně přidá soubor ze systému souborů do archivu pod zadaný název položky. |
| CreateEntryFromFileAsync(ZipArchive, String, String, CompressionLevel, CancellationToken) |
Asynchronně přidá soubor ze systému souborů do archivu pod zadaný název položky. |
| ExtractToDirectory(ZipArchive, String, Boolean) |
Extrahuje všechny soubory v archivu do adresáře v systému souborů. |
| ExtractToDirectory(ZipArchive, String) |
Extrahuje všechny soubory v archivu zip do adresáře v systému souborů. |
| ExtractToDirectoryAsync(ZipArchive, String, Boolean, CancellationToken) |
Extrahuje všechny soubory v archivu do adresáře v systému souborů. Zadaný adresář již může existovat. |
| ExtractToDirectoryAsync(ZipArchive, String, CancellationToken) |
Asynchronně extrahuje všechny soubory v archivu do adresáře v systému souborů. Zadaný adresář již může existovat. |