DataCompression (数据压缩)

• GZIP 格式 (.gz 文件) RFC-1952
• ZLIB deflate 流 RFC-1950
• ZLIB deflate 原始数据 RFC-1951
• LZMA
• LZFSE
• LZ4

• iOS 部署目标 >= 9.0
• macOS 部署目标 >= 10.11
• tvOS 部署目标 >= 9.0
• watchOS 部署目标 >= 2.0

let raw: Data! = String(repeating: "There is no place like 127.0.0.1", count: 25).data(using: .utf8)

print("raw   =>   \(raw.count) bytes")

for algo: Data.CompressionAlgorithm in [.zlib, .lzfse, .lz4, .lzma] {
    let compressedData: Data! = raw.compress(withAlgorithm: algo)

    let ratio = Double(raw.count) / Double(compressedData.count)
    print("\(algo)   =>   \(compressedData.count) bytes, ratio: \(ratio)")
    
    assert(compressedData.decompress(withAlgorithm: algo)! == raw)
}

将会打印如下内容

raw    =>   800 bytes
zlib   =>    40 bytes, ratio:  20.00
lzfse  =>    69 bytes, ratio:  11.59
lz4    =>   181 bytes, ratio:   4.42
lzma   =>   100 bytes, ratio:   8.00

let data: Data! = "https://www.ietf.org/rfc/rfc1951.txt".data(using: .utf8)
let deflated: Data! = data.deflate()
let inflated: Data? = deflated?.inflate()
assert(data == inflated)

let data: Data! = "https://www.ietf.org/rfc/rfc1952.txt".data(using: .utf8)
let gzipped: Data! = data.gzip()
let gunzipped: Data? = gzipped.gunzip()
assert(data == gunzipped)

注意：gzip 格式的压缩数据总是比原始 deflate 数据大 18 个字节，并且会附加/执行基于 crc32 校验和的数据完整性测试。

let data: Data! = "https://www.ietf.org/rfc/rfc1950.txt".data(using: .utf8)
let zipped: Data! = data.zip()
let unzipped: Data? = zipped.unzip()
assert(data == unzipped)

注意：zip 格式的压缩数据总是比原始 deflate 数据大 6 个字节，并且会附加/执行基于 adler32 校验和的数据完整性测试。

最简单的方法是使用已经安装的 gzip 命令行工具。假设你有一个名为 file.txt 的文件，在调用

gzip -9 file.txt

文件应该已经被压缩为 file.txt.gz。现在你可以加载并解压缩你的文件内容，使用

let compressedData = try? Data(contentsOf: URL(fileURLWithPath: "/path/to/your/file.txt.gz"))

if let uncompressedData = compressedData?.gunzip() {
    print(String(data: uncompressedData, encoding: .utf8) ?? "Can't decode UTF-8")
}

虽然与压缩无关，但为了方便，Crc32 和 Adler32 方法也暴露在 Data 类型上，这可能会很方便。

let classicExample = "The quick brown fox jumps over the lazy dog".data(using: .utf8)!
let crc32    = classicExample.crc32()
let adler32  = classicExample.adler32()
print("crc32: \(crc32), adler32: \(adler32)")

将会打印

crc32: 414fa339, adler32: 5bdc0fda

要使用 CocoaPods 将 DataCompression 集成到你的 Xcode 项目中，请将其添加到你的 Podfile

target '<your_target_name>' do
    pod 'DataCompression'
end

然后，运行以下命令

$ pod install

然后你需要在你的 swift 源文件顶部添加 import DataCompression 以使用该扩展。

注意： DataCompression 版本 < 3.3.0 与 Carthage 不兼容。这意味着仅支持 Swift 5。

要使用 Carthage 将 DataCompression 集成到你的 Xcode 项目中，请将其作为依赖项添加到你的 Cartfile。只需添加

github "mw99/DataCompression"

然后你必须在你的 Xcode 项目的 carthage copy-frameworks 运行脚本阶段中添加框架路径。路径可能因你设置项目与 Carthage 的关系而异。

$(SRCROOT)/Carthage/Build/iOS/DataCompression.framework

$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/DataCompression.framework

然后你需要在你的 swift 源文件顶部添加 import DataCompression 以使用该扩展。

要使用 Swift Package Manager 将 DataCompression 集成到你的 Xcode 项目中，请将其作为依赖项添加到你的 Package.swift 文件

import PackageDescription

let package = Package(
    name: "<your_package_name>",
    dependencies: [
        .Package(url: "https://github.com/mw99/DataCompression.git", majorVersion: 3)
    ]
)

然后你需要在你的 swift 源文件顶部添加 import DataCompression 以使用该扩展。

下次你运行 swift build 时，新的依赖项将被解析。

$ swift build

你只需要一个位于 Sources/DataCompression.swift 的文件。将其拖放到 Xcode 项目导航器中。

• 修复了由于 Swift 5.7 内部更改导致的不对齐指针加载，从而在使用 .unzip() 时崩溃的错误。

• 支持 Xcode 14 和 Swift 5.7

• 目标平台最终添加到 SPM Package 文件中
• Carthage 支持得到改进
• 支持 Xcode 11 SPM 集成

• 修复了在使用大数据块时，Apple lzfse 压缩器中的一个错误。

• Swift 5 版本比 Swift 5 beta 版本有更多的弃用警告。已修复。

• 添加了对 Carthage 的支持

• Podspec swift 版本设置为 5.0
• 库文件结构更新以适应新的 swift package manager 布局

• Podspec swift 版本设置为 4.2

• zip 格式的编码数据不再被复制，这应该会提高性能。
• 校验和验证现在始终使用 libz 执行，速度更快。
• .unzip() 的 skipCheckSumValidation: 参数已被移除。
• 算法枚举类型的项现在是 Swift 风格的小写，例如 .LZMA → .lzma

根据 Apache 许可证 2.0 版（“许可证”）获得许可；除非遵守许可证，否则您不得使用此文件。您可以在以下网址获取许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则根据许可证分发的软件按“现状”分发，不附带任何明示或暗示的保证或条件。请参阅许可证以了解有关权限和限制的特定语言。