iOS 对象的归档和反归档（序列化）

在iOS中，对象的序列化和反序列化分别使用NSKeyedArchiver和NSKeyedUnarchiver两个类，我们可以把一个类对象进行序列化然后保存到文件中，使用时再读取文件，把内容反序列化出来。这个过程通常也被称为对象的编码(归档)和解码(解档)。

需要注意的是，NSKeyedArchiver和NSKeyedUnarchiver是继承于NSCoder这个抽象类的，所以我们需要手动实现相应的编码方法和解码方法。

要把一个对象归档，我么需要让这个类实现NSCoding协议，NSCoding协议是干嘛的，看头文件：

protocol NSCoding {
    func encodeWithCoder(aCoder:NSCoder)
    init(coder aDecoder:NSCoder)
}

一个是编码方法：encoderWithCoder,参数是NSCoder对象；另一个是负责解码的构造函数。

我们有如下这个类：Person,分别实现了编码方法和解码方法：

class Person:NSObject,NSCoding {

    var name: String?
    var age: Int32?
    override init(0 {
    }
    
    required init(coder:aDecoder:NSCoder) {
        self.name = aDecoder.decodeObjectForKey("name") as? String
        self.age = aDecoder.decodeInt32ForKey("age")
    }

    func encodeWithCoder(aCoder:NSCoder) {
        aCoder.encodeObject(self.name, forKey:"name")
        aCoder.encodeInt32(self.age!, forKey:"age")
    }

}

NSCoder的编码和解码方法也很简单，不同数据类型有自己的编码解码方法。详细可以在Dash中查看。

现在可以在NSKeyedArchiver类进行编码了：

//获得app的Document目录
let path = NSHomeDirectory() + "/Documents"

//创建Person对象
var p = Person()
p.name = "abc"
p.age = 26

//进行归档，存放到Documents目录下的person.data文件中
let result = NSKeyedArchiver.archiveRootObject(p, toFile: path.appending("person.data")) 
print("result = \(result)")

打开Documents目录看下：

 

使用编辑器打开这个文件，看不懂的一些乱码信息：

 

NSKeyedArchiver类除了能把对象归档到本地文件中，还能把对象转换为NSData类型，然后我们在使用NSData做一系列操作。

不管是归档到本地还是转换为NSData，操作的对象都要实现NSCoding接口

//创建Person对象
var p = Person()
p.name = "abc"
p.age = 26

//获得NSData类型
let data = NSKeyedArchiver.archivedDataWithRootObject(p)

对象的反序列化（解码，解档）

反序列化的类无非就多了个un:

//从NSData中解码出对象
var person:Person? = NSKeyedUnarchiver.unarchiveObjectWithData(data) as? Person

//从一个文件中解码保存的对象
var person:Person? = NSKeyedUnarchiver.unarchiveObjectWithFile(path) as? Person

归档多个对象

NSkeyedArchiver类有个构造函数，可以接受一个可编辑的NSData，也就是NSMutabledata,通过使用这个可以编辑的daya，我们可以同时归档多个对象。

//创建一个可变价的NSData
var mudata = NSMutableData()
//归档对象
var keyArch = NSKeyedArchiver(forWritingWithMutableData: mudata)
keyArch.encodeObject(person, forKey:"person")
keyArch.encodeObject(person2, forKey:"person2")
keyArch.finishEncoding()
//保存NSdata到文件中
let path = NSHomeDirectiry().stringByAppendingPathComponent("person.mudata")
mudata.writeToFile(path, atomically: true)

读取时：

var readData = NSData(contentsOfFile:path)
var unKeyedArch = NSKeyedUnarchiver(forReadingWithData: readData)
let p = unKeyArch.decodeObjectForKey("person") as! Person
let p2 = unKeyedArch.decodeObjectForKey("person2") as! Person
print(p.name)
print(p2.name)

总结：

对象的归档解档，该对象都需要实现NSCoding协议。在一些简单的App中，可以使用这种方式快速保存一个对象。

 

2019年7月23日更新：

在iOS 12.0中方法：

func archiveRootObject(_ rootObject: Any, toFile path: String) -> Bool

已经废弃，取代它的是下面的方法：

NSKeyedArchiver.archivedData(withRootObject: <#T##Any#>, requiringSecureCoding: <#T##Bool#>)

具体用法归档：

       do {
            let data = try NSKeyedArchiver.archivedData(withRootObject: model, requiringSecureCoding: false)
            UserDefaults.standard.set(data, forKey: kUserInfo)

        } catch let error {
            print(error.localizedDescription)
            
        }

反归档：

        let data = UserDefaults.standard.value(forKey: kUserInfo)
        guard let db = data else {
            return nil
        }
        do {
            let model = try NSKeyedUnarchiver.unarchiveTopLevelObjectWithData(db as! Data) as! UserInfoModel
            return model
        } catch let error {
            print(error.localizedDescription)
        }

其中UserInfoModel是要存储的对象类型。