@propertyWrapper

最近看 SwiftUI 的时候使用了 @State 和 @Binding, 在看API 的时候发现, 他们的实现都是通过 @propertyWrapper 实现的.

@propertyWrapper

它能干什么?
可以减少重复代码

举个例子:

extension UserDefaults {
    public enum Key: String {
        case someInt = "someInt"
    }
    var someInt: Int {
        get {
            return integer(forKey: Key.someInt.rawValue)
        }
        set {
            set(newValue, forKey: Key.someInt.rawValue)
        }
    }
}

之前使用 UserDefaults 通常采用上面的方式, 每个 Key 都要实现一次 get set,
产生了大量的工作.

可以使用 @propertyWrapper 来替换这部分代码, 实现如下:

@propertyWrapper
struct UserDefaultWrapper<T> {
    var key: String
    var defaultT: T!
    var wrappedValue: T! {
        get { (UserDefaults.standard.object(forKey: key) as? T) ?? defaultT }
        nonmutating set {
            if newValue == nil {
                UserDefaults.standard.removeObject(forKey: key)
            } else {
                UserDefaults.standard.set(newValue, forKey: key)
            }
        }
    }
    
    init(_ key: String, _ defaultT: T! = nil) {
        self.key = key
        self.defaultT = defaultT
    }
}
struct UserDefaultsUnit {
    @UserDefaultWrapper("test")
    static var test: String?
}

//使用
UserDefaultsUnit.test = "hahahha" // set
UserDefaultsUnit.test // get

看过上面代码, 开始具体说一下 @propertyWrapper.
简单的理解就是包装属性.
怎么包装? 替换 set 和 get 方法
每个 @propertyWrapper 都必须实现一个属性 wrappedValue, 实现 wrappedValue 的 set get 就相当于替换掉原属性的 set get.
如果你想实现被 @propertyWrapper 包裹的属性 get set, 会产生错误 Property wrapper cannot be applied to a computed property

@propertyWrapper 的思想是, 只可以通过 wrappedValue 的 get set 方法来访问属性, 所以它默认的初始化方法是下面的方法, 给wrappedValue初始值, 这个是从Swift Property Wrappers 复制过来的时候发现的, 但你也可以不实现这个方法, 通过其他的方式初始化, 比如上面 UserDefaults 的实现.

init(wrappedValue initialValue: T) {
        self.wrappedValue = initialValue
}

Codeale 使用

/// for codable
@available(swift 5.1)
@propertyWrapper
struct UserDefaultJsonWrapper<T: Codable> {
    var key: String
    var defaultT: T!
    var wrappedValue: T {
        get {
            guard let jsonString = UserDefaults.standard.string(forKey: key) else { return defaultT }
            guard let jsonData = jsonString.data(using: .utf8) else { return defaultT }
            guard let value = try? JSONDecoder().decode(T.self, from: jsonData) else { return defaultT }
            return value
        }
        set {
            let encoder = JSONEncoder()
            guard let jsonData = try? encoder.encode(newValue) else { return }
            let jsonString = String(bytes: jsonData, encoding: .utf8)
            UserDefaults.standard.set(jsonString, forKey: key)
        }
    }
    
    init(_ key: String, _ defaultT: T! = nil) {
        self.key = key
        self.defaultT = defaultT
    }
}

@propertyWrapper 可以使用的地方有很多, 一些通用的实现都可以使用它来减少重复代码.
下面是 RGB 通用的简单实现

@propertyWrapper
struct RGBColorWrapper {
    private var r: CGFloat
    private var g: CGFloat
    private var b: CGFloat
    private var alpha: CGFloat
    
    var wrappedValue: UIColor { UIColor.init(red: r, green: g, blue: b, alpha: alpha) }
    
    init(_ r: CGFloat, _ g: CGFloat, _ b: CGFloat, _ alpha: CGFloat = 1) {
        self.r = r / 255
        self.g = g / 255
        self.b = b / 255
        self.alpha = alpha
    }
}

struct Color {
    @RGBColorWrapper(255, 0, 0)
    static var redRed: UIColor
}

// 使用
view.backgroundColor = Color.redRed

Reference: Swift Property Wrappers