TinyStorage 项目使用教程

TinyStorage 项目使用教程

TinyStorage A simple, lightweight replacement for UserDefaults that makes access a little more straightforward (plus some niceties!) 项目地址: https://gitcode.com/gh_mirrors/ti/TinyStorage

1. 项目的目录结构及介绍

TinyStorage 是一个简单的轻量级 UserDefaults 替代方案，它提供了更可靠的访问方式和原生对 Codable 类型的支持。项目的目录结构如下：

TinyStorage/
├── Sources/
│   ├── TinyStorage/
│   │   ├── TinyStorage.swift          # TinyStorage 类的实现文件
│   │   ├── TinyStorageKey.swift       # TinyStorageKey 协议及其扩展
│   │   └── TinyStorage+Defaults.swift #UserDefaults 迁移到 TinyStorage 的辅助方法
│   ├── Support/
│   │   ├── Observation.swift          # Observation 框架相关的支持代码
│   │   └── DiskSession.swift          # 磁盘会话管理
│   ├── Extensions/
│   │   ├── Array++.swift              # Array 的扩展
│   │   ├── Date++.swift               # Date 的扩展
│   │   └── Data++.swift               # Data 的扩展
│   └── LICENSE                         # MIT 许可证
├── .gitignore                           # Git 忽略文件列表
├── README.md                           # 项目说明文件
└── Package.swift                       # Swift 包管理器配置文件

• Sources/：包含所有 TinyStorage 的源代码。
• TinyStorage/：TinyStorage 的主要代码，包括核心功能实现。
• Support/：一些支持性代码，例如 Observation 框架的适配。
• Extensions/：对标准库类型进行扩展，增加额外的功能。
• LICENSE：项目的 MIT 许可证。
• .gitignore：指定 Git 忽略的文件和目录。
• README.md：项目的说明文档。
• Package.swift：项目的 Swift 包管理器配置。

2. 项目的启动文件介绍

TinyStorage.swift 是项目的启动文件，它定义了 TinyStorage 类，该类提供了存储和检索数据的基本方法。以下是 TinyStorage 类的一些关键功能：

• 提供了可靠的数据访问，即使在设备首次启动或应用预热状态下也能正确读写数据。
• 支持存储和检索符合 Codable 协议的类型。
• 在内存中使用缓存来提高性能。
• 通过内部 DispatchQueue 确保 thread-safe 的读写操作。
• 支持 across multiple processes 的数据共享。
• 提供了迁移 UserDefaults 数据到 TinyStorage 的方法。

3. 项目的配置文件介绍

Package.swift 是 Swift 包管理器的配置文件，它定义了项目的依赖和构建配置。以下是 Package.swift 的一个基本示例：

.package(url: "https://github.com/christianselig/TinyStorage.git", from: "1.0.0"),

在您的项目中的 Package.swift 文件中添加上述代码，可以将其作为依赖项包含进来。您还可以根据需要配置其他选项，例如子模块或特定版本的依赖。

请确保在使用 TinyStorage 时，您的项目设置为支持 iOS 17 或更高版本，因为 TinyStorage 使用了较新的 Observation 框架。如果您需要支持更早的 iOS 版本，可以查看 newky2k 的分支版本。

TinyStorage A simple, lightweight replacement for UserDefaults that makes access a little more straightforward (plus some niceties!) 项目地址: https://gitcode.com/gh_mirrors/ti/TinyStorage