EasyStash 使用教程

1. 项目介绍

EasyStash 是一个简单轻量的 Swift 数据持久化框架。它通过简单封装 NSCache 和 FileManager，免去了我们保存和加载数据对象的繁琐工作。目前该项目不支持复杂的异步操作、过期处理或缓存策略，仅提供数据的保存和加载功能。

2. 项目快速启动

在您的 Swift 项目中使用 EasyStash 非常简单。首先，您需要将 EasyStash 作为依赖项添加到您的项目中。以下是使用 CocoaPods、Carthage 和 Swift Package Manager 的方式：

CocoaPods

在您的 Podfile 中添加以下内容：

pod 'EasyStash'

Carthage

在您的 Cartfile 中添加以下内容：

github "onmyway133/EasyStash"

Swift Package Manager

在您的 Package.swift 中添加以下依赖：

.package(url: "https://github.com/onmyway133/EasyStash.git", from: "1.1.8")

接下来，您可以使用以下代码来初始化并使用 EasyStash：

import EasyStash

var options = Options()
options.folder = "Users"

let storage = try? Storage(options: options)

do {
    try storage?.save(image, forKey: "image")
    try storage?.save(users, forKey: "codable")
} catch {
    print(error)
}

3. 应用案例和最佳实践

以下是一些使用 EasyStash 的典型场景：

保存和加载图像

// 保存图像
try storage?.save(image, forKey: "image")

// 加载图像
let loadedImage: UIImage = try storage?.load(forKey: "image") ?? UIImage()

保存和加载 Codable 对象

let user = User(name: "A", age: 10)
let cities = [City(name: "Oslo"), City(name: "New York")]

try storage?.save(users, forKey: "user")
try storage?.save(cities, forKey: "cities")

let loadedUser = try storage?.load(forKey: "user", as: User.self)
let loadedCities = try storage?.load(forKey: "cities", as: [City].self)

保存和加载原始数据

try storage?.save(object: data, forKey: "data")
let loadedData: Data = try storage?.load(forKey: "data") ?? Data()

保存和加载基本类型

try storage?.save(100, forKey: "an int")
try storage?.save(isLoggedIn, forKey: "a boolean")

4. 典型生态项目

目前，EasyStash 作为一个轻量级的数据持久化框架，在 Swift 社区内已经得到了一定的认可。它适用于简单的数据缓存场景，尤其是在对数据持久化要求不是特别复杂的项目中。EasyStash 也可以与其他框架和服务结合使用，以构建更加完善的数据管理解决方案。