归档 - Archiving

苹果通过归档的方法来实现备忘录模式。它把对象转化成了流然后在不暴露内部属性的情况下存储数据。你可以读一读 《iOS 6 by Tutorials》 这本书的第 16 章，或者看下苹果的归档和序列化文档。

如何使用归档

首先，我们需要让 Album 实现 NSCoding 协议，声明这个类是可被归档的。打开 Album.swift 在 class 那行后面加上 NSCoding ：

  1. class Album: NSObject, NSCoding {

然后添加如下的两个方法：

  1. required init(coder decoder: NSCoder) {
  2.     super.init()
  3.     self.title = decoder.decodeObjectForKey("title") as! String
  4.     self.artist = decoder.decodeObjectForKey("artist")as! String
  5.     self.genre = decoder.decodeObjectForKey("genre") as! String?
  6.     self.coverUrl = decoder.decodeObjectForKey("cover_url")as! String
  7.     self.year = decoder.decodeObjectForKey("year") as! String
  8. }
  10. func encodeWithCoder(aCoder: NSCoder) {
  11.     aCoder.encodeObject(title, forKey: "title")
  12.     aCoder.encodeObject(artist, forKey: "artist")
  13.     aCoder.encodeObject(genre, forKey: "genre")
  14.     aCoder.encodeObject(coverUrl, forKey: "cover_url")
  15.     aCoder.encodeObject(year, forKey: "year")
  16. }

encodeWithCoder 方法是 NSCoding 的一部分，在被归档的时候调用。相对的， init(coder:) 方法则是用来解档的。很简单，很强大。

现在 Album 对象可以被归档了，添加一些代码来存储和加载 Album 数据。

在 PersistencyManager.swift 里添加如下代码：

  1. func saveAlbums() {
  2.     let filename = NSHomeDirectory().stringByAppendingString("/Documents/albums.bin")
  3.     let data = NSKeyedArchiver.archivedDataWithRootObject(albums)
  4.     data.writeToFile(filename, atomically: true)
  5. }

这个方法可以用来存储专辑。 NSKeyedArchiver 把专辑数组归档到了 albums.bin 这个文件里。

当我们归档一个包含子对象的对象时，系统会自动递归的归档子对象，然后是子对象的子对象，这样一层层递归下去。在我们的例子里，我们归档的是 albums 因为 Array 和 Album 都是实现 NSCopying 接口的，所以数组里的对象都可以自动归档。

用下面的代码取代 PersistencyManager 中的 init 方法：

  1. override init() {
  2.     super.init()
  3.     if let data = NSData(contentsOfFile: NSHomeDirectory().stringByAppendingString("/Documents/albums.bin")) {
  4.         let unarchiveAlbums = NSKeyedUnarchiver.unarchiveObjectWithData(data) as! [Album]
  5.         if let unwrappedAlbum : [Album]  = unarchiveAlbums {
  6.             albums = unwrappedAlbum
  7.         }
  8.     } else {
  9.         createPlaceholderAlbum()
  10.     }
  11. }
  13. func createPlaceholderAlbum() {
  14.     //Dummy list of albums
  15.     let album1 = Album(title: "Best of Bowie",
  16.              artist: "David Bowie",
  17.              genre: "Pop",
  18.              coverUrl: "http://www.coversproject.com/static/thumbs/album/album_david%20bowie_best%20of%20bowie.png",
  19.              year: "1992")
  21.     let album2 = Album(title: "It's My Life",
  22.            artist: "No Doubt",
  23.            genre: "Pop",
  24.            coverUrl: "http://www.coversproject.com/static/thumbs/album/album_no%20doubt_its%20my%20life%20%20bathwater.png",
  25.            year: "2003")
  27.     let album3 = Album(title: "Nothing Like The Sun",
  28.                artist: "Sting",
  29.            genre: "Pop",
  30.            coverUrl: "http://www.coversproject.com/static/thumbs/album/album_sting_nothing%20like%20the%20sun.png",
  31.            year: "1999")
  33.     let album4 = Album(title: "Staring at the Sun",
  34.            artist: "U2",
  35.            genre: "Pop",
  36.            coverUrl: "http://www.coversproject.com/static/thumbs/album/album_u2_staring%20at%20the%20sun.png",
  37.            year: "2000")
  39.     let album5 = Album(title: "American Pie",
  40.            artist: "Madonna",
  41.            genre: "Pop",
  42.            coverUrl: "http://www.coversproject.com/static/thumbs/album/album_madonna_american%20pie.png",
  43.            year: "2000")
  44.     albums = [album1, album2, album3, album4, album5]
  45.     saveAlbums()
  46. }

我们把创建专辑数据的方法放到了 createPlaceholderAlbum 里，这样代码可读性更高。在新的代码里，如果存在归档文件， NSKeyedUnarchiver 从归档文件加载数据；否则就创建归档文件，这样下次程序启动的时候可以读取本地文件加载数据。

我们还想在每次程序进入后台的时候存储专辑数据。看起来现在这个功能并不是必须的，但是如果以后我们加了编辑功能，这样做还是很有必要的，那时我们肯定希望确保新的数据会同步到本地的归档文件。

因为我们的程序通过 LibraryAPI 来访问所有服务，所以我们需要通过 LibraryAPI 来通知 PersistencyManager 存储专辑数据。

在 LibraryAPI 里添加存储专辑数据的方法：

  1. func saveAlbums() {
  2.     persistencyManager.saveAlbums()
  3. }

这个方法很简单，就是把 LibraryAPI 的 saveAlbums 方法传递给了 persistencyManager 的 saveAlbums 方法。

然后在 ViewController.swift 的 saveCurrentState 方法的最后加上：

  1. LibraryAPI.sharedInstance.saveAlbums()

在 ViewController 需要存储状态的时候，上面的代码通过 LibraryAPI 归档当前的专辑数据。

运行一下程序，检查一下没有编译错误。

不幸的是似乎没什么简单的方法来检查归档是否正确完成。你可以检查一下 Documents 目录，看下是否存在归档文件。如果要查看其他数据变化的话，还需要添加编辑专辑数据的功能。

不过和编辑数据相比，似乎加个删除专辑的功能更好一点，如果不想要这张专辑直接删除即可。再进一步，万一误删了话，是不是还可以再加个撤销按钮？

完成到这一步的Demo：