SwiftyRedis

SwiftyRedis 是一个用于 Swift 的异步 Redis 库，旨在简化您与 Redis 数据库的交互。它从 redis-rs Rust crate 中汲取灵感，SwiftyRedis 提供了一个 Redis 功能的高级接口，同时保留了底层的灵活性。它通过提供非常灵活的类型转换协议以及现代的 async-await 模式来增强您的开发体验。

要将 SwiftyRedis 集成到您的项目中，您可以使用 Swift Package Manager。只需将以下依赖项添加到您的 Package.swift 文件中

.package(url: "https://github.com/michaelvanstraten/swifty-redis.git", from: "0.3.0")

然后，在您的目标依赖项数组中，添加 "SwiftyRedis" 作为依赖项

.target(
    name: "YourApp",
    dependencies: ["SwiftyRedis"]),

添加依赖项后，导入 SwiftyRedis 并开始在您的代码中使用它

import SwiftyRedis

let client = RedisClient(.init("localhost"))
let connection = try await client.getConnection()

let value: String = try await connection.hget("myhash", "field1")

• 实现了超过 240 个 Redis 命令
• 无缝的类型转换协议，提供直观的结果
• 利用现代且直观的 async-await 设计模式
• 简化的构建器接口，用于创建自定义命令
• 内置的 Pub/Sub 支持
• 即将推出：集群支持
• 即将推出：RedisJSON 实现
• 即将推出：RedisTimeSeries 实现
• 即将推出：SwiftNIO 网络后端

完整的文档可在此处 获取，或者您可以方便地通过右侧“关于”部分中的链接访问它。

我们非常感谢您对 SwiftyRedis 做出贡献的兴趣！要开始，我们建议您浏览上面提供的文档。虽然文档可能没有涵盖所有细节，但它包含有价值的见解。以下是一些您的贡献可以产生有意义的影响的领域

• 增强测试覆盖率： 通过创建额外的测试或增强现有测试来提高项目的可靠性。
• 改进文档结构： 增强我们文档的清晰度和组织性。 您的贡献可以帮助用户更有效地导航信息。
• 丰富教程： 考虑在文档中添加新教程或改进现有教程。 这可以极大地帮助用户有效地利用 SwiftyRedis。

要开始贡献，请运行以下命令来克隆存储库

git clone --recurse-submodules https://github.com/michaelvanstraten/swifty-redis.git

如果您对我们开发的自动代码生成包感兴趣，以便与最新的 Redis 版本保持同步，请导航到 Sources/CodeGen 目录。

我们邀请您为项目做出贡献并增强库的功能！

请注意： 本自述文件中的信息截至 2023 年 9 月是准确的。