Swift 项目总结 01 - Swift 反射应用于模型归档

1）发现问题

在我刚进入公司接手公司项目(Swift)时，发现模型文件中存在大量 encode 和 decode 代码，是用于模型的归档和解档（这些基础知识我就不补充了），每当模型增加或删除一个属性时，都需要增加或删除对应的 encode 和 decode 代码，类似于下面：

class UserModel: NSObject, NSCoding {

    var name: String?
    var age: Int = 0
    var isWriter: Bool = false
    var createAt: Double = 0

    required init(coder aDecoder: NSCoder) {
        name = aDecoder.decodeObject(forKey: "user_name") as? String
        age = aDecoder.decodeInteger(forKey: "user_age")
        isWriter = aDecoder.decodeBool(forKey: "user_is_writer")
        createAt = aDecoder.decodeDouble(forKey: "user_created_at")
    }

    func encode(with aCoder: NSCoder) {
        aCoder.encode(name, forKey: "user_name")
        aCoder.encode(age, forKey: "user_age")
        aCoder.encode(isWriter, forKey: "user_is_writer")
        aCoder.encode(isWriter, forKey: "user_created_at")
    }
}

当这样的模型越来越多，我们就要维护越来越多这样的东西，这样是没有什么意义的，所以我在想，怎么样才能不用给每个模型都加这些代码就能实现这个功能呢？或者怎么才能简化这些代码？

2）分析问题

首先我先观察这些代码，发现这些代码核心就只有 2 个，就是 decode 和 encode，decode 需要设置属性的值，encode 需要获取属性的值，有点类似我们 objc 属性的 get、set 方法，需要我们拿到该模型的所有存储属性的类型，判断是哪种类型，调用哪种 decode 和 encode 方法。而要获取该模型的所有存储属性的类型，我想到了 Mirror 反射（对应 Obj-C 的运行时 runtime ）。

3）解决问题

首先我先构建一个模型基类 BasicCodingModel，用于 decode 和 encode 功能的集成

class BasicCodingModel: NSObject, NSCoding {

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        // 这个要先调用 super.init ，因为 decodeMirror 里用到了 self，否则会报错
        super.init()
        decodeMirror(coder: aDecoder)
    }

    func encode(with aCoder: NSCoder) {
        encodeMirror(coder: aCoder)
    }

    // 用来确保获取和设置的 key 是一致的
    fileprivate func getCodingKey(_ label: String) -> String {
        // 这里直接用属性名当 key
        return label
    }

    // 解码的反射应用
    fileprivate func decodeMirror(coder aDecoder: NSCoder) {
        // 创建当前模型的反射
        let mirror: Mirror = Mirror(reflecting: self)
        // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）
        mirror.children.forEach { (label, value) in
            if let label = label {
                let decodeKey = getCodingKey(label)
                var decodeValue: Any?
                if value is Bool {
                    decodeValue = aDecoder.decodeBool(forKey: decodeKey)
                } else if value is Int {
                    decodeValue = aDecoder.decodeInteger(forKey: decodeKey)
                } else if value is Double {
                    decodeValue = aDecoder.decodeDouble(forKey: decodeKey)
                } else {
                    decodeValue = aDecoder.decodeObject(forKey: decodeKey)
                }
                if let decodeValue = decodeValue {
                    // 通过使用 KVC 的方式对属性进行赋值
                    self.setValue(decodeValue, forKeyPath: label)
                }
            }
        }
    }

    // 编码的反射应用
    fileprivate func encodeMirror(coder aCoder: NSCoder) {
        // 创建当前模型的反射
        let mirror: Mirror = Mirror(reflecting: self)
        // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）
        mirror.children.forEach { (label, value) in
            if let label = label {
                let decodeKey = getCodingKey(label)
                if let valueBool = value as? Bool {
                    // 具体调用的是 encode(_ value: Bool, forKey key: String)
                    aCoder.encode(valueBool, forKey: decodeKey)
                } else if let valueInt = value as? Int {
                    // 具体调用的是 encode(_ value: Int, forKey key: String)
                    aCoder.encode(valueInt, forKey: decodeKey)
                } else if let valueDouble = value as? Double {
                    // 具体调用的是 encode(_ value: Double, forKey key: String)
                    aCoder.encode(valueDouble, forKey: decodeKey)
                } else {
                    // 具体调用的是 encode(_ object: Any?, forKey key: String)
                    aCoder.encode(value, forKey: decodeKey)
                }
            }
        }
    }
}

然后我们之前的 UserModel 就可以写成以下的格式

class UserModel: BasicCodingModel {

    var name: String?
    var age: Int = 0
    var isWriter: Bool = false
    var createAt: Double = 0

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
    }
}

我们来测试一下，在项目中启动会执行的地方放入下面代码：

fileprivate func test() {
    // 创建一个模型
    let model = UserModel()
    model.name = "执着执念"
    model.age = 24
    model.createAt = Date().timeIntervalSince1970
    model.isWriter = true

    // 归档
    print("====== archivedData ======")
    let data = NSKeyedArchiver.archivedData(withRootObject: model)
    print("name=\(model.name)")
    print("tag=\(model.age)")
    print("is_writer=\(model.isWriter)")
    print("craete_at=\(model.createAt)")

    // 解档
    print("\n====== unarchiveObject ======")
    if let unarchiveModel = NSKeyedUnarchiver.unarchiveObject(with: data) as? UserModel {
        print("name=\(unarchiveModel.name)")
        print("tag=\(unarchiveModel.age)")
        print("is_writer=\(unarchiveModel.isWriter)")
        print("craete_at=\(unarchiveModel.createAt)")
    } else {
        print("unarchiveModel error")
    }
}
/* 
打印如下：
====== archivedData ======
name=Optional("执着执念")
tag=24
is_writer=true
craete_at=1521365431.49331

====== unarchiveObject ======
name=Optional("执着执念")
tag=24
is_writer=true
craete_at=1521365431.49331
*/

打印输出说明这个方法成功了，o(￣￣)ｄ

看起来问题解决了，实际不然，因为我们上面的 UserModel 是没有子类的，所以没问题，但如果我们再创建一个 WriterModel，继承自 UserModel，则会发现 WriterModel 是没有进行归档解档的【(´⊙ω⊙`)一脸懵逼】，这是因为反射的特性是只反射当前类名下的属性，父类属性需要调用 superMirror 属性获取，所以我们改造一下代码：

class UserModel: BasicCodingModel {

    var name: String?
    var age: Int = 0
    var isWriter: Bool = false
    var createAt: Double = 0

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
    }
}

class WriterModel: UserModel {

    var writerName: String?

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
    }
}

class BasicCodingModel: NSObject, NSCoding {

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        // 这个要先调用 super.init ，因为 decodeMirror 里用到了 self，否则会报错
        super.init()
        decodeMirror(coder: aDecoder)
    }

    func encode(with aCoder: NSCoder) {
        encodeMirror(coder: aCoder)
    }

    // 用来确保获取和设置的 key 是一致的
    fileprivate func getCodingKey(_ label: String) -> String {
        // 这里直接用属性名当 key
        return label
    }

    // 解码的反射应用
    fileprivate func decodeMirror(coder aDecoder: NSCoder) {

        // 创建当前模型的反射
        var mirror: Mirror? = Mirror(reflecting: self)
        while mirror != nil {
            // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）var mirror: Mirror? = Mirror(reflecting: model)
            mirror?.children.forEach { (label, value) in
                if let label = label {
                    let decodeKey = getCodingKey(label)
                    var decodeValue: Any?
                    if value is Bool {
                        decodeValue = aDecoder.decodeBool(forKey: decodeKey)
                    } else if value is Int {
                        decodeValue = aDecoder.decodeInteger(forKey: decodeKey)
                    } else if value is Double {
                        decodeValue = aDecoder.decodeDouble(forKey: decodeKey)
                    } else {
                        decodeValue = aDecoder.decodeObject(forKey: decodeKey)
                    }
                    if let decodeValue = decodeValue {
                        // 通过使用 KVC 的方式对属性进行赋值
                        self.setValue(decodeValue, forKeyPath: label)
                    }
                }
            }
            // 判断有没有父类，直到顶层类
            mirror = mirror?.superclassMirror
        }
    }

    // 编码的反射应用
    fileprivate func encodeMirror(coder aCoder: NSCoder) {
        // 创建当前模型的反射
        var mirror: Mirror? = Mirror(reflecting: self)
        while mirror != nil {
            // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）
            mirror?.children.forEach { (label, value) in
                if let label = label {
                    let decodeKey = getCodingKey(label)
                    if let valueBool = value as? Bool {
                        // 具体调用的是 encode(_ value: Bool, forKey key: String)
                        aCoder.encode(valueBool, forKey: decodeKey)
                    } else if let valueInt = value as? Int {
                        // 具体调用的是 encode(_ value: Int, forKey key: String)
                        aCoder.encode(valueInt, forKey: decodeKey)
                    } else if let valueDouble = value as? Double {
                        // 具体调用的是 encode(_ value: Double, forKey key: String)
                        aCoder.encode(valueDouble, forKey: decodeKey)
                    } else {
                        // 具体调用的是 encode(_ object: Any?, forKey key: String)
                        aCoder.encode(value, forKey: decodeKey)
                    }
                }
            }
            // 判断有没有父类，直到顶层类
            mirror = mirror?.superclassMirror
        }
    }
}

4）回顾问题

这样我的问题已经解决了，可以直接在项目中用了，但是这段代码的健壮性太差了，测试也只是测试了 4 种常用类型而已，但项目中属性类型是各种各样的，需要测试完全才能用于项目中，不测不知道，一测吓一跳。。。发现上面的代码有很大的一些问题

• 上面的代码只能在 Swift 4 以下版本运行，Swift 4 需要在 class BasicCodingModel 前面加上关键字 @objcMembers，因为 Swift 4 中的一个对此有影响的改变是继承 NSObject 的 swift class 不再默认全部 bridge 到 OC，为了清除冗余代码，减小包大小。

• 枚举类型存储属性使用 KVC 会导致程序奔溃，-_-||汗，目前没找到什么好的方法兼容这个，所以枚举类型还是使用以前的方式（实际上我一般不存枚举，只存枚举 rawValue，枚举可以用计算属性代替）。

• encode 值为 nil 的属性时，decode 的时候会出现 -[NSNull length]: unrecognized selector sent to instance 的崩溃

下面是我优化了的代码，目前使用起来没什么问题，如果有什么问题可以给我提出，我及时改正：

class UserModel: BasicCodingModel {

    var name: String?
    var age: Int = 0
    var isWriter: Bool = false
    var createAt: Double = 0

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
    }
}

class WriterModel: UserModel {

    enum WriterType {
        case white
        case black
    }

    var type: WriterType = .white
    var writerName: String?
    var object: UserModel?

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
    }
}

@objcMembers class BasicCodingModel: NSObject, NSCoding {

    override init() {
        super.init()
    }

    required init(coder aDecoder: NSCoder) {
        // 这个要先调用 super.init ，因为 decodeMirror 里用到了 self，否则会报错
        super.init()
        decodeMirror(coder: aDecoder)
    }

    func encode(with aCoder: NSCoder) {
        encodeMirror(coder: aCoder)
    }

    // 重载该方法是为了防止使用 KVC 设置没有的属性时不至于直接崩溃
    override func setValue(_ value: Any?, forUndefinedKey key: String) {
    }

    // 用来确保获取和设置的 key 是一致的
    fileprivate func getCodingKey(_ label: String) -> String {
        // 这里直接用属性名当 key
        return label
    }

    // 解码的反射应用
    fileprivate func decodeMirror(coder aDecoder: NSCoder) {

        // 创建当前模型的反射
        var mirror: Mirror? = Mirror(reflecting: self)
        while mirror != nil {
            // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）var mirror: Mirror? = Mirror(reflecting: model)
            mirror?.children.forEach { (label, value) in
                if let label = label {
                    let decodeKey = getCodingKey(label)
                    var decodeValue: Any?
                    if value is Bool {
                        decodeValue = aDecoder.decodeBool(forKey: decodeKey)
                    } else if value is Int {
                        decodeValue = aDecoder.decodeInteger(forKey: decodeKey)
                    } else if value is Double {
                        decodeValue = aDecoder.decodeDouble(forKey: decodeKey)
                    } else if value is String {
                        decodeValue = aDecoder.decodeObject(forKey: decodeKey)
                    } else if let displayStyle = Mirror(reflecting: value).displayStyle, displayStyle != .`enum` { // 过滤掉可选类型
                        decodeValue = aDecoder.decodeObject(forKey: decodeKey)
                    }
                    if let decodeValue = decodeValue, !(decodeValue is NSNull) {
                        // 通过使用 KVC 的方式对属性进行赋值
                        self.setValue(decodeValue, forKeyPath: label)
                    }
                }
            }
            // 判断有没有父类，直到顶层类
            mirror = mirror?.superclassMirror
        }
    }

    // 编码的反射应用
    fileprivate func encodeMirror(coder aCoder: NSCoder) {
        // 创建当前模型的反射
        var mirror: Mirror? = Mirror(reflecting: self)
        while mirror != nil {
            // mirror.children 表示该模型所有存储属性集合，它是一个元组（label = 属性名, value = 属性值）
            mirror?.children.forEach { (label, value) in
                if let label = label {
                    let decodeKey = getCodingKey(label)
                    if let valueBool = value as? Bool {
                        // 具体调用的是 encode(_ value: Bool, forKey key: String)
                        aCoder.encode(valueBool, forKey: decodeKey)
                    } else if let valueInt = value as? Int {
                        // 具体调用的是 encode(_ value: Int, forKey key: String)
                        aCoder.encode(valueInt, forKey: decodeKey)
                    } else if let valueDouble = value as? Double {
                        // 具体调用的是 encode(_ value: Double, forKey key: String)
                        aCoder.encode(valueDouble, forKey: decodeKey)
                    } else if let valueStr = value as? String {
                        // 具体调用的是 encode(_ value: Any?, forKey key: String)
                        aCoder.encode(valueStr, forKey: decodeKey)
                    } else if let displayStyle = Mirror(reflecting: value).displayStyle, displayStyle != .`enum` { // 过滤掉可选类型
                        // 具体调用的是 encode(_ value: Any?, forKey key: String)
                        aCoder.encode(value, forKey: decodeKey)
                    }
                }
            }
            // 判断有没有父类，直到顶层类
            mirror = mirror?.superclassMirror
        }
    }
}

以上就是我现在项目中使用到的一个简单反射应用框架，用于归档和解档还是挺方便的，比之前的繁琐工作好太多了O(∩_∩)O哈哈~，如果你们用了我的这个代码发现了一些问题，可以及时反馈给我，我也会同步更新的。

这个代码地址：github 地址的 ArchiveWithMirror