ValidatedPropertyKit 使用教程

项目介绍

ValidatedPropertyKit 是一个用于 Swift 的属性包装器库，它允许开发者轻松地为属性添加验证逻辑。通过使用 @Validated 属性包装器，开发者可以在声明属性的同时指定验证规则，从而确保属性值的有效性。该库支持多种预定义的验证规则，并且可以轻松扩展以添加自定义验证。

项目快速启动

安装

使用 Swift Package Manager

在 Xcode 项目中，选择 File -> Swift Packages -> Add Package Dependency，然后输入以下 URL：

https://github.com/SvenTiigi/ValidatedPropertyKit.git

手动集成

将 Sources 文件夹拖入你的 Xcode 项目中。

基本使用

以下是一个简单的示例，展示如何在项目中使用 @Validated 属性包装器：

import ValidatedPropertyKit

struct User {
    @Validated(.isEmpty)
    var username: String = ""

    @Validated(.isURL && .hasPrefix("https"))
    var avatarURL: String?
}

var user = User()
user.username = "JohnDoe"
user.avatarURL = "https://example.com/avatar.png"

if user.$username.isValid {
    print("Username is valid")
} else {
    print("Username is invalid")
}

if user.$avatarURL.isValid {
    print("Avatar URL is valid")
} else {
    print("Avatar URL is invalid")
}

应用案例和最佳实践

表单验证

在表单验证中，ValidatedPropertyKit 可以大大简化验证逻辑的实现。以下是一个表单验证的示例：

struct RegistrationForm {
    @Validated(.isEmail)
    var email: String = ""

    @Validated(.isLength(6...20))
    var password: String = ""

    @Validated(.equals(\.password))
    var confirmPassword: String = ""
}

var form = RegistrationForm()
form.email = "[e-mail]"
form.password = "password123"
form.confirmPassword = "password123"

if form.$email.isValid && form.$password.isValid && form.$confirmPassword.isValid {
    print("Form is valid")
} else {
    print("Form is invalid")
}

自定义验证

通过扩展 Validation，可以轻松添加自定义验证规则：

extension Validation where Value == Int {
    static var isMeaningOfLife: Self {
        return .init { value in
            value == 42
        }
    }
}

struct CustomValidationExample {
    @Validated(.isMeaningOfLife)
    var magicNumber: Int = 0
}

var example = CustomValidationExample()
example.magicNumber = 42

if example.$magicNumber.isValid {
    print("Magic number is valid")
} else {
    print("Magic number is invalid")
}

典型生态项目

SwiftUI 集成

ValidatedPropertyKit 与 SwiftUI 完美集成，可以在 SwiftUI 视图中使用 @Validated 属性包装器：

import SwiftUI
import ValidatedPropertyKit

struct ContentView: View {
    @Validated(.isEmail)
    var email: String = ""

    var body: some View {
        VStack {
            TextField("Email", text: $email)
                .textFieldStyle(RoundedBorderTextFieldStyle())
                .padding()

            if $email.isValid {
                Text("Email is valid")
                    .foregroundColor(.green)
            } else {
                Text("Email is invalid")
                    .foregroundColor(.red)
            }
        }
    }
}

通过以上示例，可以看到 ValidatedPropertyKit 在 SwiftUI 中的强大功能和简洁的集成方式。

总结

ValidatedPropertyKit 是一个功能强大且易于使用的 Swift 库，它通过属性包装器简化了属性验证的实现。无论是简单的表单验证还是复杂的自定义验证规则，ValidatedPropertyKit 都能提供优雅的解决方案。希望本教程能帮助你快速上手并充分利用