DeflateStream 類別

定義

命名空間:

System.IO.Compression

組件:

System.IO.Compression.dll

來源:

DeflateStream.cs

提供使用Deflate演演算法壓縮和解壓縮數據流的方法和屬性。

public ref class DeflateStream : System::IO::Stream

public class DeflateStream : System.IO.Stream

type DeflateStream = class
    inherit Stream

Public Class DeflateStream
Inherits Stream

繼承

Object

MarshalByRefObject

Stream

DeflateStream

範例

下列範例示範如何使用 DeflateStream 類別來壓縮和解壓縮檔案。

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

public static 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.dfl";
    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.dfl' is 265 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 DeflateStream(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 DeflateStream(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.IO
Imports System.IO.Compression

Module 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.dfl"
    Private Const DecompressedFileName As String = "decompressed.txt"

    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.dfl' weighs 265 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 Sub CreateFileToCompress()
        File.WriteAllText(OriginalFileName, Message)
    End Sub

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

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

    Private 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 Sub DeleteFiles()
        File.Delete(OriginalFileName)
        File.Delete(CompressedFileName)
        File.Delete(DecompressedFileName)
    End Sub
End Module

備註

這個類別代表Deflate演算法，這是無損失檔案壓縮和解壓縮的業界標準演算法。 從 .NET Framework 4.5 開始，DeflateStream 類別會使用 zlib 連結庫。 因此，它提供更佳的壓縮演算法，而且在大部分情況下，壓縮檔案比舊版 .NET Framework 所提供的還要小。

這個類別原本就不提供將檔案新增至 zip 封存或擷取檔案的功能。 若要使用 zip 封存，請使用 ZipArchive 和 ZipArchiveEntry 類別。

DeflateStream 類別會使用與 GZipStream 類別所使用的 gzip 數據格式相同的壓縮演算法。

DeflateStream 和 GZipStream 中的壓縮功能會公開為數據流。 數據會以位元組為單位讀取，因此無法執行多個傳遞，以判斷壓縮整個檔案或大型數據區塊的最佳方法。 DeflateStream 和 GZipStream 類別最適合用於未壓縮的數據源。 如果源數據已經壓縮，使用這些類別實際上可能會增加數據流的大小。

建構函式

DeflateStream(Stream, CompressionLevel, Boolean)	使用指定的數據流和壓縮層級，初始化 DeflateStream 類別的新實例，並選擇性地讓數據流保持開啟狀態。
DeflateStream(Stream, CompressionLevel)	使用指定的數據流和壓縮層級，初始化 DeflateStream 類別的新實例。
DeflateStream(Stream, CompressionMode, Boolean)	使用指定的數據流和壓縮模式，初始化 DeflateStream 類別的新實例，並選擇性地讓數據流保持開啟狀態。
DeflateStream(Stream, CompressionMode)	使用指定的數據流和壓縮模式，初始化 DeflateStream 類別的新實例。

屬性

BaseStream	取得基礎數據流的參考。
CanRead	取得值，指出數據流是否支援在解壓縮檔案時讀取。
CanSeek	取得值，指出數據流是否支持搜尋。
CanTimeout	取得值，這個值會判斷目前的數據流是否可以逾時。 (繼承來源 Stream)
CanWrite	取得值，指出數據流是否支援寫入。
Length	不支援這個屬性，而且一律會擲回 NotSupportedException。
Position	不支援這個屬性，而且一律會擲回 NotSupportedException。
ReadTimeout	取得或設定值，以毫秒為單位，決定數據流在逾時之前嘗試讀取的時間長度。 (繼承來源 Stream)
WriteTimeout	取得或設定值，以毫秒為單位，決定數據流在逾時之前嘗試寫入的時間長度。 (繼承來源 Stream)

方法

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步讀取作業。 （請考慮改用 ReadAsync(Byte[], Int32, Int32) 方法。
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步寫入作業。 （請考慮改用 WriteAsync(Byte[], Int32, Int32) 方法。
Close()	關閉目前的數據流，並釋放與目前數據流相關聯的任何資源（例如套接字和檔句柄）。 請確定已正確處置數據流，而不是呼叫此方法。 (繼承來源 Stream)
CopyTo(Stream, Int32)	從目前的 Deflate 資料流讀取位元組，並使用指定的緩衝區大小將它們寫入另一個數據流。
CopyTo(Stream)	從目前的數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream, CancellationToken)	使用指定的取消標記，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	使用指定的緩衝區大小，以異步方式從目前的 Deflate 數據流讀取位元組，並將其寫入另一個數據流。
CopyToAsync(Stream, Int32)	使用指定的緩衝區大小，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream)	以異步方式從目前的數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CreateObjRef(Type)	建立物件，其中包含產生用來與遠端物件通訊之 Proxy 所需的所有相關信息。 (繼承來源 MarshalByRefObject)
CreateWaitHandle()	已淘汰. 配置 WaitHandle 物件。 (繼承來源 Stream)
Dispose()	釋放 Stream所使用的所有資源。 (繼承來源 Stream)
Dispose(Boolean)	釋放 DeflateStream 所使用的 Unmanaged 資源，並選擇性地釋放 Managed 資源。
DisposeAsync()	以異步方式釋放 DeflateStream所使用的 Unmanaged 資源。
EndRead(IAsyncResult)	等候暫止的異步讀取完成。 （請考慮改用 ReadAsync(Byte[], Int32, Int32) 方法。
EndWrite(IAsyncResult)	結束異步寫入作業。 （請考慮改用 WriteAsync(Byte[], Int32, Int32) 方法。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
Flush()	這個方法的目前實作沒有功能。
FlushAsync()	以異步方式清除此數據流的所有緩衝區，並導致任何緩衝的數據寫入基礎裝置。 (繼承來源 Stream)
FlushAsync(CancellationToken)	以異步方式清除此 Deflate 數據流的所有緩衝區、導致任何緩衝的數據寫入基礎裝置，並監視取消要求。
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetLifetimeService()	已淘汰. 擷取控制這個實例存留期原則的目前存留期服務物件。 (繼承來源 MarshalByRefObject)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
InitializeLifetimeService()	已淘汰. 取得存留期服務物件，以控制這個實例的存留期原則。 (繼承來源 MarshalByRefObject)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 對象的淺層複本。 (繼承來源 MarshalByRefObject)
ObjectInvariant()	已淘汰. 提供 Contract的支援。 (繼承來源 Stream)
Read(Byte[], Int32, Int32)	將數個解壓縮的位元組讀入指定的位元組數位。
Read(Span<Byte>)	將目前 Deflate 資料流中的位元組序列讀入位元組範圍，並將 Deflate 資料流中的位置依讀取的位元元數目往前移。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	以異步方式從目前的 Deflate 資料流讀取位元組序列、將它們寫入位元組陣列、將 Deflate 資料流中的位置依讀取的位元組數目往前移，並監視取消要求。
ReadAsync(Byte[], Int32, Int32)	以異步方式從目前數據流讀取位元組序列，並依讀取的位元元組數目將數據流中的位置往前移。 (繼承來源 Stream)
ReadAsync(Memory<Byte>, CancellationToken)	以異步方式從目前的 Deflate 資料流讀取位元組序列、將它們寫入位元組記憶體範圍、將 Deflate 資料流中的位置依讀取的位元組數目往前移，並監視取消要求。
ReadAtLeast(Span<Byte>, Int32, Boolean)	從目前數據流讀取至少一個字節數目，並將數據流中的位置依讀取的位元組數目往前移。 (繼承來源 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	以異步方式從目前數據流讀取至少一個字節數目、依讀取的位元組數目將數據流中的位置往前移，並監視取消要求。 (繼承來源 Stream)
ReadByte()	從 Deflate 數據流讀取位元組，並將數據流中的位置往前移一個字節，或在 Deflate 數據流結尾傳回 -1。
ReadExactly(Byte[], Int32, Int32)	從目前數據流讀取 count 位元組數，並將位置往前移。 (繼承來源 Stream)
ReadExactly(Span<Byte>)	從目前的數據流讀取位元組，並將位置往前移，直到填入 buffer 為止。 (繼承來源 Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	以異步方式從目前數據流讀取 count 位元組數目、推進數據流中的位置，以及監視取消要求。 (繼承來源 Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	以異步方式從目前數據流讀取位元組、將數據流中的位置往前移，直到填入 buffer，並監視取消要求。 (繼承來源 Stream)
Seek(Int64, SeekOrigin)	不支援這項作業，而且一律會擲回 NotSupportedException。
SetLength(Int64)	不支援這項作業，而且一律會擲回 NotSupportedException。
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)
Write(Byte[], Int32, Int32)	從指定的位元組陣列將壓縮的位元組寫入基礎數據流。
Write(ReadOnlySpan<Byte>)	將位元組序列寫入目前的Deflate資料流，並將這個Deflate資料流中的目前位置依寫入的位元組數目往前移。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	從指定的位元組陣列，以異步方式將壓縮的位元組寫入基礎 Deflate 數據流。
WriteAsync(Byte[], Int32, Int32)	以異步方式將位元組序列寫入目前數據流，並依寫入的位元元組數目，將這個數據流中的目前位置往前移。 (繼承來源 Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	從指定的只讀記憶體區域，以異步方式將壓縮的位元組寫入基礎 Deflate 資料流。
WriteByte(Byte)	將位元組寫入目前的Deflate數據流，並將這個Deflate數據流中的目前位置往前移一個。

擴充方法

CopyToAsync(Stream, PipeWriter, CancellationToken)	使用取消標記，以異步方式從 Stream 讀取位元組，並將其寫入指定的 PipeWriter。
ConfigureAwait(IAsyncDisposable, Boolean)	設定如何執行從異步可處置專案傳回的工作等候。

另請參閱

• DeflateStream、GZipStream 和 CryptoStream 中的部分和零位元組讀取