在本课中，你将在FoodTracker应用会话中保存菜品列表。理解并实现数据持久化是iOS应用开发的重要组成部分。iOS有多种持久化数据的存储解决方案；在本课中，你将使用NSCoding作为FoodTracker应用数据持久化的机制。NSCoding是一个协议，它会激活一个针对归档对象和其他结构体的轻量级解决方案。归档对象（Archived objects）能够被存储在磁盘上也能在以后从磁盘取回。
学习目标
在本课结束的时候，你将能够：
- 创建一个用来存储字符串常量的结构
- 理解静态属性和实例属性之间的区别
- 使用NSCoding协议来读写数据
保存和加载Meal对象
在这一步中，你将在Meal类中实现保存和加载菜品的行为。使用NSCoding方法，让Meal类负责存储和加载它的每个属性。它需要通过分配每个属性值到特定的键来存储它的数据。然后它通过查找和这键有关联的信息来加载数据。
一个键就是一个简单的字符串。你基于在应用中最有意义的方针选择你自己的键。例如，你或许使用键 name 来存储name属性的值。
要清楚编码键对应的每个数据，创建一个结构来存储键字符串。这样，当你需要在代码的多个地方使用这个键时，你可以使用常量来替代反复输入字符串（这增加了错误的可能性）。
实现编码键结构
- 打开 Meal.swift。
- 在 Meal.swift中，在//MARK: Properties部分下面，添加如下结构：
//MARK: Types
struct PropertyKey {
}
- 在这个PropertyKey结构中，添加如下属性：
static let name = "name"
static let photo = "photo"
static let rating = "rating"
每个常量对应一个Meal的三个属性之一。这个static关键字表示这些常量属于结构自己，而不是结构的实例。你可以使用结构名来访问这些常量（例如，PropertyKey.name）。
你的PropertyKey结构看上去时这样的：
struct PropertyKey {
static let name = "name"
static let photo = "photo"
static let rating = "rating"
}
为了能够编码和解码它们自己和它们的属性，Meal类需要符合NSCoding协议。为了附和NSCoding，Meal需要子类化NSObject。NSObject 被认为是一个基本类，它定义了运行时系统的基本接口。
子类化NSObject并遵守NSCoding
- 在Meal.swift，找到class行：
class Meal {
- 在Meal后面，添加冒号和NSObject来从NSObject子类化一个类
class Meal: NSObject {
- 在NSObject后面，添加逗号和NSCoding来采用NSCoding协议：
class Meal: NSObject, NSCoding {
现在，Meal是NSObject的子类，Meal类的初始化器必须调用一个NSObject类的指定初始化器。因为NSObject类的唯一初始化器是 init()，Swift编译器自动添加这个调用，所以你无需改变代码；但是，如果你愿意，你可以随时添加super.init()来进行调用。
进一步探索
更多关于Swift初始化规则的信息，查看Class Inheritance and Initialization和The Swift Programming Language (Swift 4)中的初始化。
NSCoding协议声明了两个方法，任何采用了它的类都必须实现，这样这些类的实例就可以编码和解码：
encode(with aCoder: NSCoder)
init?(coder aDecoder: NSCoder)
encode(with:)方法准备用来归档的类的信息，并且初始化器在类被创建的时候解档这些数据。你需要同时实现encode(with:) 方法和用来正确存储和加载数据的初始化器。
实现encodeWithCoder NSCoding方法
- 在Meal.swift中，在结束花括号之前，添加如下注释:
//MARK: NSCoding
- 在这个注释的下面，添加如下方法：
func encode(with aCoder: NSCoder) {
}
- 在encode(with:)方法中，添加如下代码：
aCoder.encode(name, forKey: PropertyKey.name)
aCoder.encode(photo, forKey: PropertyKey.photo)
aCoder.encode(rating, forKey: PropertyKey.rating)
这个NSCoder类定义了几个encode(_:forKey:)方法，每个方法的第一个参数都有不同的类型。每个方法编码给定类型的数据。在上面显示的代码中，前两行传递的是String参数，而第三行传递一个Int参数。这些行对每个Meal类的属性的值进行了编码，并使用它们相应的键存储它们。
encode(with:)方法应该是这样的：
func encode(with aCoder: NSCoder) {
aCoder.encode(name, forKey: PropertyKey.name)
aCoder.encode(photo, forKey: PropertyKey.photo)
aCoder.encode(rating, forKey: PropertyKey.rating)
}
使用编码方法写入，实现初始化方法来解码这些编码的数据。
实现初始化方法类加载菜品
- 在文件的顶部，导入统一日志系统，在导入UIKit的下方位置。
import os.log
- 在encodeWithCoder(_:)方法下方，添加下面的初始化方法：
required convenience init?(coder aDecoder: NSCoder) {
}
required修饰词意味着如果子类定义了一个自己的初始化器，这个初始化器在每一个子类中必须被实现。
convenience修饰词意味着这是一个次要的初始化器，并且它必须从同一个类里调用指定初始化器。
问号意味着这时一个可失败初始化器，它可以返回nil。
- 在初始化器里面添加如下代码：
// The name is required. If we cannot decode a name string, the initializer should fail.
guard let name = aDecoder.decodeObject(forKey: PropertyKey.name) as? String else {
os_log("Unable to decode the name for a Meal object.", log: OSLog.default, type: .debug)
return nil
}
decodeObject(forKey:)方法解码被编码的信息。decodeObjectForKey(_:)的返回值是 Any?可选类型。这个guard语句在分配它到name常量之前，解包这个可选类型并把它降级为String类型。如果这些操作失败，整个初始化失败。
- 紧跟着前面的代码，添加下面的代码：
// Because photo is an optional property of Meal, just use conditional cast.
let photo = aDecoder.decodeObjectForKey(PropertyKey.photo) as? UIImage
你把decodeObject(forKey:)的返回值降级为UIImage，并把它分配给photo常量。如果降级失败，它会给photo属性分配nil。这里没有必要使用guard语句，因为photo属性本身就是可选类型。
- 接着添加代码：
let rating = aDecoder.decodeIntegerForKey(PropertyKey.rating)
decodeIntegerForKey(_:)方法解归档一个整型。因为decodeIntegerForKey返回值是一个Int，这里不需要降级这个解码值，这里没有可选类型需要解包。
- 在这个实现方法的最后添加如下代码：
// Must call designated initializer.
self.init(name: name, photo: photo, rating: rating)
作为一个方便初始化器，这个初始化器在完成之前必须要调用它的类指定初始化方法。作为这个初始化器的参数，你需要给他传递一个常量的值，这个常量是你在归档保存数据的时候创建的。
这个新的init?(coder:)初始化方法看上去是这样的：
required convenience init?(coder aDecoder: NSCoder) {
// The name is required. If we cannot decode a name string, the initializer should fail.
guard let name = aDecoder.decodeObject(forKey: PropertyKey.name) as? String else {
os_log("Unable to decode the name for a Meal object.", log: OSLog.default, type: .debug)
return nil
}
// Because photo is an optional property of Meal, just use conditional cast.
let photo = aDecoder.decodeObject(forKey: PropertyKey.photo) as? UIImage
let rating = aDecoder.decodeInteger(forKey: PropertyKey.rating)
// Must call designated initializer.
self.init(name: name, photo: photo, rating: rating)
}
required convenience init?(coder aDecoder: NSCoder) {
// The name is required. If we cannot decode a name string, the initializer should fail.
guard let name = aDecoder.decodeObject(forKey: PropertyKey.name) as? String else {
os_log("Unable to decode the name for a Meal object.", log: OSLog.default, type: .debug)
return nil
}
// Because photo is an optional property of Meal, just use conditional cast.
let photo = aDecoder.decodeObject(forKey: PropertyKey.photo) as? UIImage
let rating = aDecoder.decodeInteger(forKey: PropertyKey.rating)
// Must call designated initializer.
self.init(name: name, photo: photo, rating: rating)
}
接下来，你需要在文件系统中的持久化路径，数据将在这个位置被读写，因此你要知道在哪里查找。
创建数据的文件路径
在 Meal.swift中，在//MARK: Properties部分下方，添加如下代码：
//MARK: Archiving Paths
static let DocumentsDirectory = FileManager().urls(for: .documentDirectory, in: .userDomainMask).first!
static let ArchiveURL = DocumentsDirectory.appendingPathComponent("meals")
你标记这些常量使用static关键字，这意味着它们属于这个类，而不是这个类的实例。在Meal类外部，你访问这个路径需要使用语法Meal.ArchiveURL.path。不用担心创建了多少Meal类的实例，这里将只有这些属性的一个副本。
DocumentsDirectory常量使用文件管理器的urls(for:in:)方法来查找应用的文件目录的URL。这是应用能够存储用户数据的目录。这个方法返回一个URL的数组，第一个项（first!）返回一个包含数组中第一个URL的可选类型；但是，只要枚举是正确的，返回的数组必然包含一个匹配项。因此，强制解包可选类型是安全的。确定文档目录的URL后，你使用这个URL创建你的应用存储数据的URL。这里，你通过添加meals到文档URL末尾来创建的文件URL。
进一步探索
更多与iOS文件系统的交互信息，参见File System Programming Guide.。
检查点：使用Command-B构建应用。它应该没有任何错误。
保存和加载菜品列表
想要能保存和加载个人的菜品，你要在用户添加、编辑或者删除菜品的时候保存和加载菜品列表。
实现保存菜品列表的方法
- 打开MealTableViewController.swift。
- 在//MARK: Private Methods部分，在结束花括号之前，添加如下方法：
private func saveMeals() {
}
- 在saveMeals()方法总，添加下面的代码：
let isSuccessfulSave = NSKeyedArchiver.archiveRootObject(meals, toFile: Meal.ArchiveURL.path)
这个方法试图把meals数组归档到一个指定位置，并在操作成功的时候返回true。方法使用你在Meal类中定义的常量Meal.ArchiveURL来指明保存信息的位置。
但是，如何快速的测试数据是否保存成功？在控制台输出消息来表示结果。
- 添加如下if语句
if isSuccessfulSave {
os_log("Meals successfully saved.", log: OSLog.default, type: .debug)
} else {
os_log("Failed to save meals...", log: OSLog.default, type: .error)
}
如果保存成功，它会在控制台输出一个调试信息，如果保存失败，则在控制台输出一个错误信息。
你的saveMeals()方法看上去应该是这样的：
private func saveMeals() {
let isSuccessfulSave = NSKeyedArchiver.archiveRootObject(meals, toFile: Meal.ArchiveURL.path)
if isSuccessfulSave {
os_log("Meals successfully saved.", log: OSLog.default, type: .debug)
} else {
os_log("Failed to save meals...", log: OSLog.default, type: .error)
}
}
现在实现加载菜品的方法。
实现加载菜品列表的方法
- 在MealTableViewController.swift中，在结束花括号之前，添加下面的方法：
private func loadMeals() -> [Meal]? {
}
这个方法返回一个可选类型数组，数组的元素是Meal对象。这意味着它可以返回一个Meal对象的数组，或者返回nil。
- 在loadMeals()方法中，添加如下代码：
return NSKeyedUnarchiver.unarchiveObject(withFile: Meal.ArchiveURL.path) as? [Meal]
这个方法视图解档存储在Meal.ArchiveURL.path路径的对象，并把它降级为一个Meal对象的数组。这段代码使用 as?运算符，所以在降级失败的时候能返回nil。通常发生这种失败的原因是数组还没有被保存。这种情况下，unarchiveObject(withFile:)方法返回nil。试图把nil降级为[Meal]也会失败，它自身返回nil。
你的loadMeals()方法看上去是这样的：
private func loadMeals() -> [Meal]? {
return NSKeyedUnarchiver.unarchiveObject(withFile: Meal.ArchiveURL.path) as? [Meal]
}
要使用这些方法，你需要添加代码用来在用户添加、删除、或者编辑菜品的时候保存和加载菜品列表。
当用户添加、删除、或者编辑菜品的时候保存菜品列表
- 在MealTableViewController.swift中，找到unwindToMealList(sender:)方法：
@IBAction func unwindToMealList(sender: UIStoryboardSegue) {
if let sourceViewController = sender.source as? MealViewController, let meal = sourceViewController.meal {
if let selectedIndexPath = tableView.indexPathForSelectedRow {
// Update an existing meal.
meals[selectedIndexPath.row] = meal
tableView.reloadRows(at: [selectedIndexPath], with: .none)
}
else {
// Add a new meal.
let newIndexPath = IndexPath(row: meals.count, section: 0)
meals.append(meal)
tableView.insertRows(at: [newIndexPath], with: .automatic)
}
}
}
- 在else分句下面，添加如下代码：
// Save the meals.
saveMeals()
一旦一个新菜品添加或已存在的菜品被更新，这段代码就会保存meals数组。确保这段代码在外层if语句里面。
- 在MealTableViewController.swift中，找到tableView(_:commit:forRowAt:)方法：
// Override to support editing the table view.
override func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCellEditingStyle, forRowAt indexPath: IndexPath) {
if editingStyle == .delete {
// Delete the row from the data source
meals.remove(at: indexPath.row)
tableView.deleteRows(at: [indexPath], with: .fade)
} else if editingStyle == .insert {
// Create a new instance of the appropriate class, insert it into the array, and add a new row to the table view
}
}
- 在meals.removeAtIndex(indexPath.row)后面，添加如下代码：
saveMeals()
这个代码会在一个菜品被删除的时候保存meals数组。
你的 unwindToMealList(_:)方法看上去是这样的：
@IBAction func unwindToMealList(sender: UIStoryboardSegue) {
if let sourceViewController = sender.source as? MealViewController, let meal = sourceViewController.meal {
if let selectedIndexPath = tableView.indexPathForSelectedRow {
// Update an existing meal.
meals[selectedIndexPath.row] = meal
tableView.reloadRows(at: [selectedIndexPath], with: .none)
}
else {
// Add a new meal.
let newIndexPath = IndexPath(row: meals.count, section: 0)
meals.append(meal)
tableView.insertRows(at: [newIndexPath], with: .automatic)
}
// Save the meals.
saveMeals()
}
}
你的 tableView(_:commit:forRowAt:)方法看上去是这样的：
// Override to support editing the table view.
override func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCellEditingStyle, forRowAt indexPath: IndexPath) {
if editingStyle == .delete {
// Delete the row from the data source
meals.remove(at: indexPath.row)
saveMeals()
tableView.deleteRows(at: [indexPath], with: .fade)
} else if editingStyle == .insert {
// Create a new instance of the appropriate class, insert it into the array, and add a new row to the table view
}
}
现在，菜品列表会在合适的时间保存，接下来确保菜品会在合适的时候被加载。加载存储的数据的合适位置是在这个table view的viewDidLoad方法中。
在合适的时机加载菜品列表
- 在MealTableViewController.swift中，找到viewDidLoad()方法：
override func viewDidLoad() {
super.viewDidLoad()
// Use the edit button item provided by the table view controller.
navigationItem.leftBarButtonItem = editButtonItem
// Load the sample data.
loadSampleMeals()
}
- 在设置完编辑按钮（navigationItem.leftBarButtonItem = editButtonItem）之后，添加如下if语句：
// Load any saved meals, otherwise load sample data.
if let savedMeals = loadMeals() {
meals += savedMeals
}
如果loadMeals()成功，就会返回一个Meal对象的数组，这个条件就是true，if语句就会执行。如果loadMeals()返回nil，就不会有菜品被加载，if语句也不会被执行。这段代码会添加任何成功加载的菜品到meals数组。
- 在if语句之后，添加else分句，并把loadSampleMeals()放到分句中：
else {
// Load the sample data.
loadSampleMeals()
}
现在viewDidLoad()方法看上去是这样的：
override func viewDidLoad() {
super.viewDidLoad()
// Use the edit button item provided by the table view controller.
navigationItem.leftBarButtonItem = editButtonItem
// Load any saved meals, otherwise load sample data.
if let savedMeals = loadMeals() {
meals += savedMeals
}
else {
// Load the sample data.
loadSampleMeals()
}
}
检查点：运行应用。如果你添加一些新菜品并退出应用，这些你添加的菜品会在下一次你打开应用的时候显示。
小结
在本课中，你添加了保存和加载应用数据的功能。这让数据持续存在于多次运行中。无论何时应用启动，它就会加载已存在的数据。当数据被修改时，应用就会保存它。这个应用能够安全的终止而不会丢失任何数据。
到此本应用完成。恭喜！你现在已经有了一个功能齐全的应用。
注意
想看本课的完整代码，下载这个文件并在Xcode中打开。
下载文件
