GZipStream Klasse

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Quelle:

GZipStream.cs

Stellt Methoden und Eigenschaften bereit, die zum Komprimieren und Dekomprimieren von Datenströmen mithilfe der GZip-Datenformatspezifikation verwendet werden.

public ref class GZipStream : System::IO::Stream

public class GZipStream : System.IO.Stream

type GZipStream = class
    inherit Stream

Public Class GZipStream
Inherits Stream

Vererbung

Object

MarshalByRefObject

Stream

GZipStream

Beispiele

Das folgende Beispiel zeigt, wie Sie mithilfe der GZipStream-Klasse ein Verzeichnis von Dateien komprimieren und dekomprimieren.

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

public class FileCompressionModeExample
{
    private const string Message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
    private const string OriginalFileName = "original.txt";
    private const string CompressedFileName = "compressed.gz";
    private const string DecompressedFileName = "decompressed.txt";

    public static void Run()
    {
        CreateFileToCompress();
        CompressFile();
        DecompressFile();
        PrintResults();
        DeleteFiles();

        /*
         Output:

            The original file 'original.txt' is 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

            The compressed file 'compressed.gz' is 283 bytes.

            The decompressed file 'decompressed.txt' is 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
         */
    }

    private static void CreateFileToCompress() => File.WriteAllText(OriginalFileName, Message);

    private static void CompressFile()
    {
        using FileStream originalFileStream = File.Open(OriginalFileName, FileMode.Open);
        using FileStream compressedFileStream = File.Create(CompressedFileName);
        using var compressor = new GZipStream(compressedFileStream, CompressionMode.Compress);
        originalFileStream.CopyTo(compressor);
    }

    private static void DecompressFile()
    {
        using FileStream compressedFileStream = File.Open(CompressedFileName, FileMode.Open);
        using FileStream outputFileStream = File.Create(DecompressedFileName);
        using var decompressor = new GZipStream(compressedFileStream, CompressionMode.Decompress);
        decompressor.CopyTo(outputFileStream);
    }

    private static void PrintResults()
    {
        long originalSize = new FileInfo(OriginalFileName).Length;
        long compressedSize = new FileInfo(CompressedFileName).Length;
        long decompressedSize = new FileInfo(DecompressedFileName).Length;

        Console.WriteLine($"The original file '{OriginalFileName}' is {originalSize} bytes. Contents: \"{File.ReadAllText(OriginalFileName)}\"");
        Console.WriteLine($"The compressed file '{CompressedFileName}' is {compressedSize} bytes.");
        Console.WriteLine($"The decompressed file '{DecompressedFileName}' is {decompressedSize} bytes. Contents: \"{File.ReadAllText(DecompressedFileName)}\"");
    }

    private static void DeleteFiles()
    {
        File.Delete(OriginalFileName);
        File.Delete(CompressedFileName);
        File.Delete(DecompressedFileName);
    }
}

Imports System
Imports System.IO
Imports System.IO.Compression

Public Class FileCompressionModeExample
    Private Const Message As String = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
    Private Const OriginalFileName As String = "original.txt"
    Private Const CompressedFileName As String = "compressed.gz"
    Private Const DecompressedFileName As String = "decompressed.txt"

    Public Shared Sub Main()
        CreateFileToCompress()
        CompressFile()
        DecompressFile()
        PrintResults()
        DeleteFiles()

        ' Output:
        '   The original file 'original.txt' weighs 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

        '   The compressed file 'compressed.gz' weighs 283 bytes.

        '   The decompressed file 'decompressed.txt' weighs 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
    End Sub

    Private Shared Sub CreateFileToCompress()
        File.WriteAllText(OriginalFileName, Message)
    End Sub

    Private Shared Sub CompressFile()
        Using originalFileStream As FileStream = File.Open(OriginalFileName, FileMode.Open)
            Using compressedFileStream As FileStream = File.Create(CompressedFileName)
                Using compressor = New GZipStream(compressedFileStream, CompressionMode.Compress)
                    originalFileStream.CopyTo(compressor)
                End Using
            End Using
        End Using
    End Sub

    Private Shared Sub DecompressFile()
        Using compressedFileStream As FileStream = File.Open(CompressedFileName, FileMode.Open)
            Using outputFileStream As FileStream = File.Create(DecompressedFileName)
                Using decompressor = New GZipStream(compressedFileStream, CompressionMode.Decompress)
                    decompressor.CopyTo(outputFileStream)
                End Using
            End Using
        End Using
    End Sub

    Private Shared Sub PrintResults()
        Dim originalSize As Long = New FileInfo(OriginalFileName).Length
        Dim compressedSize As Long = New FileInfo(CompressedFileName).Length
        Dim decompressedSize As Long = New FileInfo(DecompressedFileName).Length

        Console.WriteLine($"The original file '{OriginalFileName}' weighs {originalSize} bytes. Contents: ""{File.ReadAllText(OriginalFileName)}""")
        Console.WriteLine($"The compressed file '{CompressedFileName}' weighs {compressedSize} bytes.")
        Console.WriteLine($"The decompressed file '{DecompressedFileName}' weighs {decompressedSize} bytes. Contents: ""{File.ReadAllText(DecompressedFileName)}""")
    End Sub

    Private Shared Sub DeleteFiles()
        File.Delete(OriginalFileName)
        File.Delete(CompressedFileName)
        File.Delete(DecompressedFileName)
    End Sub
End Class

Hinweise

Diese Klasse stellt das gzip-Datenformat dar, das einen industriestandardbasierten Algorithmus für verlustlose Dateikomprimierung und Dekomprimierung verwendet. Das Format enthält einen zyklischen Redundanzüberprüfungswert zum Erkennen von Datenbeschädigungen. Das Gzip-Datenformat verwendet den gleichen Algorithmus wie die DeflateStream Klasse, kann jedoch erweitert werden, um andere Komprimierungsformate zu verwenden. Das Format kann auf eine Weise implementiert werden, die nicht von Patenten abgedeckt wird.

Ab .NET Framework 4.5 verwendet die DeflateStream-Klasse die Zlib-Bibliothek für die Komprimierung. Daher bietet sie einen besseren Komprimierungsalgorithmus und in den meisten Fällen eine kleinere komprimierte Datei als in früheren Versionen von .NET Framework.

Komprimierte GZipStream Objekte, die mit einer Erweiterung von .gz in eine Datei geschrieben wurden, können mit vielen gängigen Komprimierungstools dekomprimiert werden; Diese Klasse bietet jedoch nicht inhärent Funktionen zum Hinzufügen oder Extrahieren von Dateien aus ZIP-Archiven.

Die Komprimierungsfunktion in DeflateStream und GZipStream wird als Datenstrom verfügbar gemacht. Daten werden nach Byte-Byte-Basis gelesen, sodass es nicht möglich ist, mehrere Durchläufe auszuführen, um die beste Methode zum Komprimieren ganzer Dateien oder großer Datenblöcke zu ermitteln. Die klassen DeflateStream und GZipStream werden am besten für nicht komprimierte Datenquellen verwendet. Wenn die Quelldaten bereits komprimiert sind, kann die Verwendung dieser Klassen die Größe des Datenstroms tatsächlich erhöhen.

Hinweise für Vererber

Wenn Sie von GZipStreamerben, müssen Sie die folgenden Member außer Kraft setzen: CanSeek, CanWriteund CanRead.

Konstruktoren

GZipStream(Stream, CompressionLevel, Boolean)	Initialisiert eine neue Instanz der GZipStream Klasse mithilfe der angegebenen Datenstrom- und Komprimierungsebene und lässt optional den Datenstrom geöffnet.
GZipStream(Stream, CompressionLevel)	Initialisiert eine neue Instanz der GZipStream Klasse mithilfe der angegebenen Datenstrom- und Komprimierungsebene.
GZipStream(Stream, CompressionMode, Boolean)	Initialisiert eine neue Instanz der GZipStream-Klasse mithilfe des angegebenen Datenstrom- und Komprimierungsmodus und lässt optional den Datenstrom geöffnet.
GZipStream(Stream, CompressionMode)	Initialisiert eine neue Instanz der GZipStream Klasse mithilfe des angegebenen Datenstrom- und Komprimierungsmodus.

Eigenschaften

BaseStream	Ruft einen Verweis auf den zugrunde liegenden Datenstrom ab.
CanRead	Ruft einen Wert ab, der angibt, ob der Datenstrom das Lesen unterstützt, während eine Datei dekomprimiert wird.
CanSeek	Ruft einen Wert ab, der angibt, ob der Datenstrom die Suche unterstützt.
CanTimeout	Ruft einen Wert ab, der bestimmt, ob der aktuelle Datenstrom Timeout ausführen kann. (Geerbt von Stream)
CanWrite	Ruft einen Wert ab, der angibt, ob der Datenstrom das Schreiben unterstützt.
Length	Diese Eigenschaft wird nicht unterstützt und löst immer eine NotSupportedExceptionaus.
Position	Diese Eigenschaft wird nicht unterstützt und löst immer eine NotSupportedExceptionaus.
ReadTimeout	Dient zum Abrufen oder Festlegen eines Werts in Millisekunden, der bestimmt, wie lange der Datenstrom vor dem Timeout zu lesen versucht. (Geerbt von Stream)
WriteTimeout	Dient zum Abrufen oder Festlegen eines Werts in Millisekunden, der bestimmt, wie lange der Datenstrom versucht, vor dem Timeout zu schreiben. (Geerbt von Stream)

Methoden

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Startet einen asynchronen Lesevorgang. (Erwägen Sie stattdessen die Verwendung der ReadAsync(Byte[], Int32, Int32)-Methode.)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Startet einen asynchronen Schreibvorgang. (Erwägen Sie stattdessen die Verwendung der WriteAsync(Byte[], Int32, Int32)-Methode.)
Close()	Schließt den aktuellen Datenstrom und gibt alle Ressourcen (z. B. Sockets und Dateihandles) frei, die dem aktuellen Datenstrom zugeordnet sind. Anstatt diese Methode aufzurufen, stellen Sie sicher, dass der Datenstrom ordnungsgemäß verworfen ist. (Geerbt von Stream)
CopyTo(Stream, Int32)	Liest die Bytes aus dem aktuellen GZip-Stream und schreibt sie mithilfe der angegebenen Puffergröße in einen anderen Datenstrom.
CopyTo(Stream)	Liest die Bytes aus dem aktuellen Datenstrom und schreibt sie in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, CancellationToken)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie mithilfe eines angegebenen Abbruchtokens in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Liest asynchron die Bytes aus dem aktuellen GZip-Stream und schreibt sie mithilfe einer angegebenen Puffergröße in einen anderen Datenstrom.
CopyToAsync(Stream, Int32)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie mithilfe einer angegebenen Puffergröße in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CreateObjRef(Type)	Erstellt ein Objekt, das alle relevanten Informationen enthält, die zum Generieren eines Proxys erforderlich sind, der für die Kommunikation mit einem Remoteobjekt verwendet wird. (Geerbt von MarshalByRefObject)
CreateWaitHandle()	Veraltet. Weist ein WaitHandle-Objekt zu. (Geerbt von Stream)
Dispose()	Gibt alle vom Streamverwendeten Ressourcen frei. (Geerbt von Stream)
Dispose(Boolean)	Gibt die nicht verwalteten Ressourcen frei, die vom GZipStream verwendet werden, und gibt optional die verwalteten Ressourcen frei.
DisposeAsync()	Gibt asynchron die nicht verwalteten Ressourcen frei, die vom GZipStreamverwendet werden.
EndRead(IAsyncResult)	Wartet auf den Abschluss des ausstehenden asynchronen Lesevorgangs. (Erwägen Sie stattdessen die Verwendung der ReadAsync(Byte[], Int32, Int32)-Methode.)
EndWrite(IAsyncResult)	Behandelt das Ende eines asynchronen Schreibvorgangs. (Erwägen Sie stattdessen die Verwendung der WriteAsync(Byte[], Int32, Int32)-Methode.)
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
Flush()	Löscht die internen Puffer.
FlushAsync()	Löscht asynchron alle Puffer für diesen Datenstrom und bewirkt, dass alle gepufferten Daten auf das zugrunde liegende Gerät geschrieben werden. (Geerbt von Stream)
FlushAsync(CancellationToken)	Löscht asynchron alle Puffer für diesen GZip-Stream, bewirkt, dass alle gepufferten Daten auf das zugrunde liegende Gerät geschrieben werden, und überwacht Abbruchanforderungen.
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetLifetimeService()	Veraltet. Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinie für diese Instanz steuert. (Geerbt von MarshalByRefObject)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
InitializeLifetimeService()	Veraltet. Ruft ein Lebensdauerdienstobjekt ab, um die Lebensdauerrichtlinie für diese Instanz zu steuern. (Geerbt von MarshalByRefObject)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
MemberwiseClone(Boolean)	Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts. (Geerbt von MarshalByRefObject)
ObjectInvariant()	Veraltet. Bietet Unterstützung für eine Contract. (Geerbt von Stream)
Read(Byte[], Int32, Int32)	Liest eine Anzahl von dekomprimierten Bytes in das angegebene Bytearray.
Read(Span<Byte>)	Liest eine Abfolge von Bytes aus dem aktuellen GZip-Stream in eine Byte-Spanne und wechselt die Position innerhalb des GZip-Datenstroms um die Anzahl der gelesenen Bytes.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Liest asynchron eine Bytesequenz aus dem aktuellen GZip-Datenstrom in ein Bytearray, wechselt die Position innerhalb des GZip-Datenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen.
ReadAsync(Byte[], Int32, Int32)	Liest asynchron eine Abfolge von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes. (Geerbt von Stream)
ReadAsync(Memory<Byte>, CancellationToken)	Liest asynchron eine Bytesequenz aus dem aktuellen GZip-Datenstrom in einen Bytespeicherbereich, wechselt die Position innerhalb des GZip-Datenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Liest mindestens eine Minimale Anzahl von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes. (Geerbt von Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Liest asynchron mindestens eine Mindestanzahl von Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadByte()	Liest ein Byte aus dem GZip-Stream und wechselt die Position innerhalb des Datenstroms um ein Byte oder gibt -1 zurück, wenn am Ende des GZip-Datenstroms.
ReadExactly(Byte[], Int32, Int32)	Liest count Anzahl von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms. (Geerbt von Stream)
ReadExactly(Span<Byte>)	Liest Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms, bis die buffer gefüllt ist. (Geerbt von Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Liest asynchron count Anzahl von Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Liest asynchron Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms, bis die buffer gefüllt ist, und überwacht Abbruchanforderungen. (Geerbt von Stream)
Seek(Int64, SeekOrigin)	Diese Eigenschaft wird nicht unterstützt und löst immer eine NotSupportedExceptionaus.
SetLength(Int64)	Diese Eigenschaft wird nicht unterstützt und löst immer eine NotSupportedExceptionaus.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Write(Byte[], Int32, Int32)	Schreibt komprimierte Bytes in den zugrunde liegenden GZip-Datenstrom aus dem angegebenen Bytearray.
Write(ReadOnlySpan<Byte>)	Schreibt eine Bytesequenz aus einer schreibgeschützten Bytespanne in den aktuellen GZip-Stream und wechselt die aktuelle Position innerhalb dieses GZip-Datenstroms um die Anzahl der geschriebenen Bytes.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Schreibt asynchron komprimierte Bytes aus dem angegebenen Bytearray in den zugrunde liegenden GZip-Datenstrom.
WriteAsync(Byte[], Int32, Int32)	Schreibt asynchron eine Bytesequenz in den aktuellen Datenstrom und wechselt die aktuelle Position innerhalb dieses Datenstroms um die Anzahl der geschriebenen Bytes. (Geerbt von Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Schreibt asynchron komprimierte Bytes aus dem angegebenen schreibgeschützten Bytespeicherbereich in den zugrunde liegenden GZip-Datenstrom.
WriteByte(Byte)	Schreibt ein Byte in den aktuellen GZip-Stream und wechselt die aktuelle Position innerhalb dieses GZip-Datenstroms um eins.

Erweiterungsmethoden

CopyToAsync(Stream, PipeWriter, CancellationToken)	Liest die Bytes asynchron aus dem Stream und schreibt sie mithilfe eines Abbruchtokens in das angegebene PipeWriter.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguriert, wie auf die von einem asynchronen Einweg zurückgegebenen Aufgaben gewartet wird.

Weitere Informationen

• Partial- und Zero-Byte-Lesevorgänge in DeflateStream-, GZipStream- und CryptoStream-