GZipStream Klasa

Definicja

Przestrzeń nazw:

System.IO.Compression

Zestaw:

System.IO.Compression.dll

Źródło:

GZipStream.cs

Udostępnia metody i właściwości używane do kompresowania i dekompresowania strumieni przy użyciu specyfikacji formatu danych GZip.

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

public class GZipStream : System.IO.Stream

type GZipStream = class
    inherit Stream

Public Class GZipStream
Inherits Stream

Dziedziczenie

Object

MarshalByRefObject

Stream

GZipStream

Przykłady

W poniższym przykładzie pokazano, jak za pomocą GZipStream klasy kompresować i dekompresować katalog plików.

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

Uwagi

Ta klasa reprezentuje format danych gzip, który używa standardowego algorytmu branżowego do kompresji i dekompresji plików bez strat. Format zawiera cykliczną wartość sprawdzania nadmiarowości na potrzeby wykrywania uszkodzenia danych. Format danych gzip używa tego samego algorytmu DeflateStream co klasa, ale można go rozszerzyć, aby używać innych formatów kompresji. Format można łatwo zaimplementować w sposób, który nie jest objęty patentami.

Począwszy od .NET Framework 4.5, DeflateStream klasa używa biblioteki zlib do kompresji. W rezultacie zapewnia lepszy algorytm kompresji i, w większości przypadków, mniejszy skompresowany plik niż zapewnia we wcześniejszych wersjach .NET Framework.

Skompresowane GZipStream obiekty zapisywane w pliku z rozszerzeniem .gz można dekompresować przy użyciu wielu typowych narzędzi kompresji. Jednak ta klasa nie zapewnia z natury funkcji dodawania plików do lub wyodrębniania plików z archiwów zip.

Funkcja kompresji w systemie DeflateStream i GZipStream jest uwidoczniona jako strumień. Dane są odczytywane na podstawie bajtów bajtów, więc nie można wykonać wielu przejść, aby określić najlepszą metodę kompresji całych plików lub dużych bloków danych. Klasy DeflateStream i GZipStream są najlepiej używane w nieskompresowanych źródłach danych. Jeśli dane źródłowe są już skompresowane, użycie tych klas może rzeczywiście zwiększyć rozmiar strumienia.

Uwagi dotyczące dziedziczenia

Po dziedziczeniu z GZipStreamprogramu należy zastąpić następujące elementy członkowskie: CanSeek, CanWritei CanRead.

Konstruktory

GZipStream(Stream, CompressionLevel)	Inicjuje GZipStream nowe wystąpienie klasy przy użyciu określonego strumienia i poziomu kompresji.
GZipStream(Stream, CompressionLevel, Boolean)	Inicjuje GZipStream nowe wystąpienie klasy przy użyciu określonego strumienia i poziomu kompresji, a opcjonalnie pozostawia otwarty strumień.
GZipStream(Stream, CompressionMode)	Inicjuje GZipStream nowe wystąpienie klasy przy użyciu określonego strumienia i trybu kompresji.
GZipStream(Stream, CompressionMode, Boolean)	Inicjuje GZipStream nowe wystąpienie klasy przy użyciu określonego strumienia i trybu kompresji, a opcjonalnie pozostawia strumień otwarty.

Właściwości

BaseStream	Pobiera odwołanie do bazowego strumienia.
CanRead	Pobiera wartość wskazującą, czy strumień obsługuje odczytywanie podczas dekompresowania pliku.
CanSeek	Pobiera wartość wskazującą, czy strumień obsługuje wyszukiwanie.
CanTimeout	Pobiera wartość określającą, czy bieżący strumień może upłynął limit czasu. (Odziedziczone po Stream)
CanWrite	Pobiera wartość wskazującą, czy strumień obsługuje zapisywanie.
Length	Ta właściwość nie jest obsługiwana i zawsze zgłasza obiekt NotSupportedException.
Position	Ta właściwość nie jest obsługiwana i zawsze zgłasza obiekt NotSupportedException.
ReadTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował odczytać przed upływem limitu czasu. (Odziedziczone po Stream)
WriteTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień podejmie próbę zapisania przed upływem limitu czasu. (Odziedziczone po Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna operację odczytu asynchronicznego. (Zamiast tego rozważ użycie ReadAsync(Byte[], Int32, Int32) metody).
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna operację zapisu asynchronicznego. (Zamiast tego rozważ użycie WriteAsync(Byte[], Int32, Int32) metody).
Close()	Zamyka bieżący strumień i zwalnia wszystkie zasoby (takie jak gniazda i uchwyty plików) skojarzone z bieżącym strumieniem. Zamiast wywoływać tę metodę, upewnij się, że strumień jest prawidłowo usuwany. (Odziedziczone po Stream)
CopyTo(Stream)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyTo(Stream, Int32)	Odczytuje bajty z bieżącego strumienia GZip i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu.
CopyToAsync(Stream)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego tokenu anulowania. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia GZip i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu.
CreateObjRef(Type)	Tworzy obiekt zawierający wszystkie istotne informacje wymagane do wygenerowania serwera proxy używanego do komunikowania się z obiektem zdalnym. (Odziedziczone po MarshalByRefObject)
CreateWaitHandle()	Przestarzałe. WaitHandle Przydziela obiekt. (Odziedziczone po Stream)
Dispose()	Zwalnia wszelkie zasoby używane przez element Stream. (Odziedziczone po Stream)
Dispose(Boolean)	Zwalnia zasoby niezarządzane używane przez element GZipStream i opcjonalnie zwalnia zasoby zarządzane.
DisposeAsync()	Asynchronicznie zwalnia niezarządzane zasoby używane przez GZipStreamprogram .
EndRead(IAsyncResult)	Czeka na ukończenie oczekującego odczytu asynchronicznego. (Zamiast tego rozważ użycie ReadAsync(Byte[], Int32, Int32) metody).
EndWrite(IAsyncResult)	Obsługuje koniec operacji zapisu asynchronicznego. (Zamiast tego rozważ użycie WriteAsync(Byte[], Int32, Int32) metody).
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
Flush()	Opróżnia wewnętrzne bufory.
FlushAsync()	Asynchronicznie czyści wszystkie bufory dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym. (Odziedziczone po Stream)
FlushAsync(CancellationToken)	Asynchronicznie czyści wszystkie bufory dla tego strumienia GZip, powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym i monitorowanie żądań anulowania.
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetLifetimeService()	Przestarzałe. Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
InitializeLifetimeService()	Przestarzałe. Uzyskuje obiekt usługi okresu istnienia, aby kontrolować zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
MemberwiseClone(Boolean)	Tworzy płytkią kopię bieżącego MarshalByRefObject obiektu. (Odziedziczone po MarshalByRefObject)
ObjectInvariant()	Przestarzałe. Zapewnia obsługę programu Contract. (Odziedziczone po Stream)
Read(Byte[], Int32, Int32)	Odczytuje liczbę dekompresowanych bajtów do określonej tablicy bajtów.
Read(Span<Byte>)	Odczytuje sekwencję bajtów z bieżącego strumienia GZip do zakresu bajtów i rozwija pozycję w strumieniu GZip według liczby odczytanych bajtów.
ReadAsync(Byte[], Int32, Int32)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia GZip do tablicy bajtów, zwiększa pozycję w strumieniu GZip przez liczbę odczytanych bajtów i monitoruje żądania anulowania.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia GZip do regionu pamięci bajtów, zwiększa pozycję w strumieniu GZip o liczbę odczytanych bajtów i monitoruje żądania anulowania.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronicznie odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadByte()	Odczytuje bajt ze strumienia GZip i rozwija pozycję w strumieniu według jednego bajtu lub zwraca wartość -1, jeśli na końcu strumienia GZip.
ReadExactly(Byte[], Int32, Int32)	Odczytuje count liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu. (Odziedziczone po Stream)
ReadExactly(Span<Byte>)	Odczytuje bajty z bieżącego strumienia i rozwija pozycję w strumieniu do momentu buffer wypełnienia. (Odziedziczone po Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje count liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia, przesuwa pozycję w strumieniu do buffer momentu wypełnienia i monitoruje żądania anulowania. (Odziedziczone po Stream)
Seek(Int64, SeekOrigin)	Ta właściwość nie jest obsługiwana i zawsze zgłasza obiekt NotSupportedException.
SetLength(Int64)	Ta właściwość nie jest obsługiwana i zawsze zgłasza obiekt NotSupportedException.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
Write(Byte[], Int32, Int32)	Zapisuje skompresowane bajty do bazowego strumienia GZip z określonej tablicy bajtów.
Write(ReadOnlySpan<Byte>)	Zapisuje sekwencję bajtów do bieżącego strumienia GZip z zakresu bajtów tylko do odczytu i rozwija bieżącą pozycję w tym strumieniu GZip według liczby zapisanych bajtów.
WriteAsync(Byte[], Int32, Int32)	Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i rozwija bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie zapisuje skompresowane bajty do bazowego strumienia GZip z określonej tablicy bajtów.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronicznie zapisuje skompresowane bajty do bazowego strumienia GZip z określonego regionu pamięci bajtów tylko do odczytu.
WriteByte(Byte)	Zapisuje bajt do bieżącego strumienia GZip i rozwija bieżącą pozycję w tym strumieniu GZip po jednym.

Metody rozszerzania

ConfigureAwait(IAsyncDisposable, Boolean)

Konfiguruje sposób oczekiwania na zadania zwracane z asynchronicznego jednorazowego wykonania.

Zobacz też

• Odczyty częściowe i zerowe w deflatestream, GZipStream i CryptoStream