#Swift Property wrappers separation for code and action

news2024/11/16 20:17:23

在 Swift 中，Property Wrappers 是一种强大的特性，允许我们为属性附加额外的行为逻辑，从而简化代码、提高代码的可重用性。它们是一个通过封装属性的读写逻辑来提供行为扩展的机制。

Property Wrappers 的工作原理

Property Wrapper 本质上是一个包含 wrappedValue 属性的结构体或类。通过在属性前加上 @ 符号，我们可以将一个 Property Wrapper 应用到该属性上。Swift 会将该属性的存取逻辑委托给 Property Wrapper 的 wrappedValue 属性。

创建一个 Property Wrapper

一个简单的 Property Wrapper 示例：

@propertyWrapper
struct Clamped {
    private var value: Int
    private let range: ClosedRange<Int>

    var wrappedValue: Int {
        get { value }
        set { value = min(max(newValue, range.lowerBound), range.upperBound) }
    }

    init(wrappedValue: Int, _ range: ClosedRange<Int>) {
        self.range = range
        self.value = min(max(wrappedValue, range.lowerBound), range.upperBound)
    }
}

在这个例子中，Clamped 是一个 Property Wrapper，它限制整数值在一个给定范围内。当值超出范围时，它会自动调整到范围边界。

使用 Property Wrapper

在定义属性时应用 Property Wrapper，如下所示：

struct Settings {
    @Clamped(0...10) var volume: Int = 5
}

在这个示例中，当你设置 volume 的值时，它会自动调整在 0 到 10 的范围内：

var settings = Settings()
settings.volume = 15  // volume 会被限制为 10
print(settings.volume)  // 输出: 10

Property Wrappers 的好处

代码复用：可以将属性的常见行为封装在 Property Wrapper 中，减少重复代码。
数据验证：可以在写入属性时自动执行验证逻辑，比如上面的范围限制。
数据转换：可以在读写属性时自动执行转换逻辑，例如自动加密/解密。

更高级的用法：Projected Value

Property Wrappers 还可以定义一个 projectedValue，它提供额外的接口或信息给属性。例如，可以使用 $ 符号访问 projectedValue：

@propertyWrapper
struct Uppercase {
    private var value: String = ""

    var wrappedValue: String {
        get { value }
        set { value = newValue.uppercased() }
    }

    var projectedValue: String {
        return "Projected value: \(value)"
    }
}

struct Text {
    @Uppercase var name: String
}

var text = Text()
text.name = "hello"
print(text.name)         // 输出: HELLO
print(text.$name)        // 输出: Projected value: HELLO