Cely 项目使用教程

Cely 项目使用教程

Cely Plug-n-Play login system for iOS written in Swift 项目地址: https://gitcode.com/gh_mirrors/ce/Cely

1. 项目介绍

Cely 是一个为 iOS 应用提供快速登录系统的开源项目，它允许开发者在不到 30 秒的时间内集成一个完整的登录系统。Cely 建立在 Locksmith 上，后者是 Swift 社区中最受欢迎的 Keychain 封装库，保证了登录凭证的安全存储。

Cely 的核心功能包括：

• 简单的 API 用于安全地存储和检索用户凭证。
• 管理应用在登录界面和主界面之间的切换。

2. 项目快速启动

在开始之前，请确保你的开发环境满足以下要求：

• iOS 11.0 或更高版本。
• Xcode 9.0 或更高版本。
• Swift 4.0 或更高版本。

以下是快速启动的步骤：

首先，创建一个新的 User 模型，使其符合 CelyUser 协议：

import Cely

struct User: CelyUser {
    enum Property: CelyProperty {
        case token = "token"
    }
}

然后，在 AppDelegate 中设置 Cely：

import Cely

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    Cely.setup(with: window!, forModel: User(), requiredProperties: [.token])
    return true
}

接下来，实现一个登录完成的闭包，用于处理用户登录：

Cely.setup(
    with: window!,
    forModel: User(),
    requiredProperties: [.token],
    withOptions: [
        .loginCompletionBlock: { (username: String, password: String) in
            // 这里处理登录逻辑，比如验证用户名和密码
            if username == "user" && password == "password" {
                Cely.save("userToken", forKey: "token", securely: true)
                Cely.changeStatus(to: .loggedIn)
            }
        }
    ]
)

3. 应用案例和最佳实践

在真实的应用中，你可能需要自定义登录界面或者处理网络请求。以下是一些最佳实践：

• 自定义登录界面：创建一个符合 CelyStyle 协议的结构体来自定义登录界面的样式。

struct CustomLoginStyle: CelyStyle {
    func backgroundColor() -> UIColor {
        return UIColor.blue
    }
    // 其他自定义样式函数...
}

在设置 Cely 时使用这个样式：

Cely.setup(
    with: window!,
    forModel: User(),
    requiredProperties: [.token],
    withOptions: [
        .loginStyle: CustomLoginStyle()
    ]
)

• 处理网络请求：在登录完成闭包中，你可以添加网络请求代码来验证用户凭据。

Cely.setup(
    with: window!,
    forModel: User(),
    requiredProperties: [.token],
    withOptions: [
        .loginCompletionBlock: { (username: String, password: String) in
            // 添加网络请求来验证用户名和密码
        }
    ]
)

4. 典型生态项目

Cely 作为登录系统，可以与许多其他开源项目结合使用，比如：

• 使用 Alamofire 进行网络请求。
• 使用 Vuex 进行状态管理。
• 使用 Kingfisher 进行图片加载。

通过将这些项目与 Cely 结合使用，可以构建出功能丰富且安全的应用程序。

Cely Plug-n-Play login system for iOS written in Swift 项目地址: https://gitcode.com/gh_mirrors/ce/Cely