原文地址是 How to read from plist (Property List) in iOS Swift
本文講述如何在 Swift 中對 plist 文件進行讀寫操作。Plist 文件本質上是一個 XML 文件，可以用來存儲 key-value 形式的數據。因此，非常適合用於 APP 的配置信息存儲。
What's A Plist
Plist 的全稱是 [Property List]{.i}，即屬性列表。Plist 文件的內是以 XML 的編碼方式存儲的鍵值對數據。這種結構和 Swift 中的字典結構是對應的。
原文這裏還討論了一下 XML 的格式，其實我們完全不需要關心這些細節問題。
讀取數據
參考如下的代碼：
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)
:::{.note .info}
這有幾點要說明：
- 要訪問文件，首先需要有一個文件的 URL。這裏的示例代碼是訪問的 Bundle 中的文件。對於 APP 的設置信息來說我們還可以放到 Documents 文件夾。要獲取這個文件夾中的URL，需要使用
FileManager。下面是一個例子：
let url = FileManager.default.urls(for: .documentDirectory,
in: .userDomainMask)[0]
.appendingPathComponent("Configuration.plist")
- 在對
PropertyListSerialization.propertyList的結果做類型轉化時，要根據 Plist 的根節點形式確定。如果是一個數組，那麼應該用[[String: String]]，如果是個字典，那麼應該用[String: String]。如果節點的數據格式多樣，那 Value 的類型應該用Any。
:::
寫入數據
我對原文這部分的介紹不是很滿意，因此做了大幅度修改。
要將數據寫入 Plist，首先要將數據編碼成對應的 XML 格式。這個編碼過程，我們使用 PropertyListEncoder 來實現。
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml
剩下的問題是，encoder.encode 函數接受的輸入對象必須要是實現了 Encodable 協議的對象。比較簡單的方法是組裝一個 Dictionary，且確保 Dictionary 中的每個成員都是原始類型，即時數字或者字符串。但是這個 Swift 組裝字典的方法必然涉及到很多 Magic Number 和 Magic String，因此不是特別優雅的做法。那麼一個嚴謹的做法是，令我們想要保存的對象實現 Encodable 協議。
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 協議的例子。要點有二:
- 定一個枚舉類型
CodingKeys，這個類型的值類型是String，同時需要實現協議CodingKey。其中CodingKey不要求你額外添加什麼函數或者屬性。從文檔來看CodingKey這個協議就是要求你的枚舉類型能夠提供一個stringValue。CodingKeys的成員必須包括你想要編碼的所有變量。枚舉變量的stringValue會成爲編碼後的 Key 部分。 - 實現函數
encode，在這個函數內對要編碼的所有變量進行編碼。注意，編碼使用的鍵值是CodingKeys類型的。