原文地址是 How to read from plist (Property List) in iOS Swift

本文讲述如何在 Swift 中对 plist 文件进行读写操作。Plist 文件本质上是一个 XML 文件，可以用来存储 key-value 形式的数据。因此，非常适合用于 APP 的配置信息存储。

1 What's A Plist

Plist 的全称是 Property List，即属性列表。Plist 文件的内是以 XML 的编码方式存储的键值对数据。这种结构和 Swift 中的字典结构是对应的。

原文这里还讨论了一下 XML 的格式，其实我们完全不需要关心这些细节问题。

2 读取数据

参考如下的代码：

1
2
3
4
5
6
guard let path = Bundle.main.path(forResources: "filename", ofType: "plist") else { return }
let url = URL(fileURLWithPath: path)
let data = try! Data(contentsOf: url)
guard let plist = try! PropertyListSerialization.propertyList(
  from: data, options: .mutableContainers, format: nil) as? [[String: String]] else { return }
print(plist)

这有几点要说明：

  1. 要访问文件，首先需要有一个文件的 URL。这里的示例代码是访问的 Bundle 中的文件。对于 APP 的设置信息来说我们还可以放到 Documents 文件夹。要获取这个文件夹中的 URL，需要使用 FileManager。下面是一个例子：
1
2
3
let url = FileManager.default.urls(for: .documentDirectory,
                                   in: .userDomainMask)[0]
  .appendingPathComponent("Configuration.plist")
  1. 在对PropertyListSerialization.propertyList 的结果做类型转化时，要根据 Plist 的根节点形式确定。如果是一个数组，那么应该用 [[String: String]]，如果是个字典，那么应该用 [String: String]。如果节点的数据格式多样，那 Value 的类型应该用 Any。

3 写入数据

我对原文这部分的介绍不是很满意，因此做了大幅度修改。

要将数据写入 Plist，首先要将数据编码成对应的 XML 格式。这个编码过程，我们使用 PropertyListEncoder 来实现。

1
2
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml

剩下的问题是，encoder.encode 函数接受的输入对象必须要是实现了 Encodable 协议的对象。比较简单的方法是组装一个 Dictionary，且确保 Dictionary 中的每个成员都是原始类型，即时数字或者字符串。但是这个 Swift 组装字典的方法必然涉及到很多 Magic Number 和 Magic String，因此不是特别优雅的做法。那么一个严谨的做法是，令我们想要保存的对象实现 Encodable 协议。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

class SomeDataToSave {
  var key1: String
  var key2: Int
}

extension SomeDataToSave: Encodable {
  enum CodingKeys: String, CodingKey {
    case key1
    case key2 = "anothername"
  }

  func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    try container.encode(key1, forKey: .key1)
    try container.encode(key2, forKey: .key2)
  }
}

上面展示的是一个完整的实现 Encodable 协议的例子。要点有二:

  1. 定一个枚举类型 CodingKeys，这个类型的值类型是 String，同时需要实现协议 CodingKey。其中 CodingKey 不要求你额外添加什么函数或者属性。从文档来看 CodingKey 这个协议就是要求你的枚举类型能够提供一个 stringValue。CodingKeys 的成员必须包括你想要编码的所有变量。枚举变量的 stringValue 会成为编码后的 Key 部分。
  2. 实现函数 encode，在这个函数内对要编码的所有变量进行编码。注意，编码使用的键值是 CodingKeys 类型的。