ZipArchive Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Reprezentuje pakiet skompresowanych plików w formacie archiwum zip.
public ref class ZipArchive : IDisposable
public class ZipArchive : IDisposable
type ZipArchive = class
interface IDisposable
Public Class ZipArchive
Implements IDisposable
- Dziedziczenie
-
ZipArchive
- Implementuje
Uwagi
Metody manipulowania archiwami zip i ich wpisy plików są rozłożone na trzy klasy: ZipFile, ZipArchivei ZipArchiveEntry.
Działanie | Zastosowanie |
---|---|
Twórca archiwum zip z katalogu | ZipFile.CreateFromDirectory |
Wyodrębnianie zawartości archiwum zip do katalogu | ZipFile.ExtractToDirectory |
Dodawanie nowych plików do istniejącego archiwum zip | ZipArchive.CreateEntry |
Pobieranie pliku z archiwum zip | ZipArchive.GetEntry |
Pobieranie wszystkich plików z archiwum zip | ZipArchive.Entries |
Otwieranie strumienia do pojedynczego pliku zawartego w archiwum zip | ZipArchiveEntry.Open |
Usuwanie pliku z archiwum zip | ZipArchiveEntry.Delete |
Podczas tworzenia nowego wpisu plik jest kompresowany i dodawany do pakietu zip. Metoda CreateEntry umożliwia określenie hierarchii katalogów podczas dodawania wpisu. Dołącz ścieżkę względną nowego wpisu w pakiecie zip. Na przykład utworzenie nowego wpisu przy użyciu ścieżki AddedFolder\NewFile.txt
względnej powoduje utworzenie skompresowanego pliku tekstowego w katalogu o nazwie AddedFolder.
Jeśli odwołujesz się do System.IO.Compression.FileSystem
zestawu w projekcie, możesz uzyskać dostęp do czterech metod rozszerzeń (z ZipFileExtensions klasy) dla ZipArchive klasy: CreateEntryFromFile(ZipArchive, String, String), , CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)ExtractToDirectory(ZipArchive, String)i ExtractToDirectory(ZipArchive, String, Boolean) (dostępnej na platformie .NET Core 2.0 i nowszych wersjach). Te metody rozszerzenia umożliwiają kompresowanie i dekompresowanie zawartości wpisu do pliku. Zestaw System.IO.Compression.FileSystem
nie jest dostępny dla aplikacji ze sklepu Windows 8.x. W aplikacjach ze sklepu DeflateStream Windows 8.x można kompresować i dekompresować pliki przy użyciu klasy lub GZipStream lub użyć typów Compressor środowisko wykonawcze systemu Windows i Decompressor.
Przykłady
W pierwszym przykładzie pokazano, jak utworzyć nowy wpis i zapisać go przy użyciu strumienia.
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
W poniższym przykładzie pokazano, jak otworzyć archiwum zip i iterować po kolekcji wpisów.
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
Trzeci przykład pokazuje, jak za pomocą metod rozszerzeń utworzyć nowy wpis w archiwum zip z istniejącego pliku i wyodrębnić zawartość archiwum. Aby wykonać kod, należy odwołać System.IO.Compression.FileSystem
się do zestawu.
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
ZipArchive(Stream) |
Inicjuje ZipArchive nowe wystąpienie klasy z określonego strumienia. |
ZipArchive(Stream, ZipArchiveMode) |
Inicjuje ZipArchive nowe wystąpienie klasy z określonego strumienia i z określonym trybem. |
ZipArchive(Stream, ZipArchiveMode, Boolean) |
Inicjuje nowe wystąpienie ZipArchive klasy w określonym strumieniu dla określonego trybu i opcjonalnie pozostawia otwarty strumień. |
ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding) |
Inicjuje nowe wystąpienie ZipArchive klasy w określonym strumieniu dla określonego trybu, używa określonego kodowania nazw wpisów i opcjonalnie pozostawia otwarty strumień. |
Właściwości
Comment |
Pobiera lub ustawia opcjonalny komentarz archiwum. |
Entries |
Pobiera kolekcję wpisów, które znajdują się obecnie w archiwum zip. |
Mode |
Pobiera wartość opisową typu akcji, którą archiwum zip może wykonywać wpisów. |
Metody
CreateEntry(String) |
Tworzy pusty wpis, który ma określoną ścieżkę i nazwę wpisu w archiwum zip. |
CreateEntry(String, CompressionLevel) |
Tworzy pusty wpis o określonej nazwie wpisu i poziomie kompresji w archiwum zip. |
Dispose() |
Zwalnia zasoby używane przez bieżące wystąpienie klasy ZipArchive. |
Dispose(Boolean) |
Wywoływane przez Dispose() metody i Finalize() w celu zwolnienia niezarządzanych zasobów używanych przez bieżące wystąpienie ZipArchive klasy i opcjonalnie kończy pisanie archiwum i zwalnia zasoby zarządzane. |
Equals(Object) |
Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object) |
GetEntry(String) |
Pobiera otokę dla określonego wpisu w archiwum zip. |
GetHashCode() |
Służy jako domyślna funkcja skrótu. (Odziedziczone po Object) |
GetType() |
Type Pobiera bieżące wystąpienie. (Odziedziczone po Object) |
MemberwiseClone() |
Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object) |
ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object) |
Metody rozszerzania
CreateEntryFromFile(ZipArchive, String, String) |
Archiwizuje plik, kompresując go i dodając go do archiwum zip. |
CreateEntryFromFile(ZipArchive, String, String, CompressionLevel) |
Archiwizuje plik, kompresując go przy użyciu określonego poziomu kompresji i dodając go do archiwum zip. |
ExtractToDirectory(ZipArchive, String) |
Wyodrębnia wszystkie pliki z archiwum zip do katalogu w systemie plików. |
ExtractToDirectory(ZipArchive, String, Boolean) |
Wyodrębnia wszystkie pliki z archiwum do katalogu w systemie plików. |