Como faço para obter uma plist como um dictionary no Swift?

Estou brincando com a nova linguagem de programação Swift da Apple e tenho alguns problemas …

Atualmente estou tentando ler um arquivo plist, em Objective-C eu faria o seguinte para obter o conteúdo como um NSDictionary:

NSString *filePath = [[NSBundle mainBundle] pathForResource:@"Config" ofType:@"plist"]; NSDictionary *dict = [[NSDictionary alloc] initWithContentsOfFile:filePath]; 

Como faço para obter uma plist como um dictionary no Swift?

Eu suponho que posso obter o caminho para o plist com:

 let path = NSBundle.mainBundle().pathForResource("Config", ofType: "plist") 

Quando isso funciona (Se estiver correto?): Como obtenho o conteúdo como um Dicionário?

Também uma pergunta mais geral:

Há algum problema em usar as classs NS * padrão? Eu acho que sim … ou estou faltando alguma coisa? Até onde eu sei, as classs NS * do framework padrão ainda são válidas e estão prontas para usar?

Você ainda pode usar NSDictionaries no Swift:

Para o Swift 3+

 if let path = Bundle.main.path(forResource: "Config", ofType: "plist"), let myDict = NSDictionary(contentsOfFile: path){ // Use your myDict here } 

E versões mais antigas do Swift

 var myDict: NSDictionary? if let path = NSBundle.mainBundle().pathForResource("Config", ofType: "plist") { myDict = NSDictionary(contentsOfFile: path) } if let dict = myDict { // Use your dict here } 

Os NSClasses ainda estão disponíveis e perfeitamente bem para usar no Swift. Eu acho que eles provavelmente vão querer mudar o foco para rápido, mas atualmente as APIs rápidas não têm todas as funcionalidades do NSClasses.

Isto é o que eu faço se eu quiser converter um .plist em um dictionary Swift:

 if let path = NSBundle.mainBundle().pathForResource("Config", ofType: "plist") { if let dict = NSDictionary(contentsOfFile: path) as? Dictionary { // use swift dictionary as normal } } 

Editado para o Swift 2.0:

 if let path = NSBundle.mainBundle().pathForResource("Config", ofType: "plist"), dict = NSDictionary(contentsOfFile: path) as? [String: AnyObject] { // use swift dictionary as normal } 

Editado para o Swift 3.0:

 if let path = Bundle.main.path(forResource: "Config", ofType: "plist"), let dict = NSDictionary(contentsOfFile: path) as? [String: AnyObject] { // use swift dictionary as normal } 

Em rápida leitura 3.0 do Plist.

 func readPropertyList() { var propertyListForamt = PropertyListSerialization.PropertyListFormat.xml //Format of the Property List. var plistData: [String: AnyObject] = [:] //Our data let plistPath: String? = Bundle.main.path(forResource: "data", ofType: "plist")! //the path of the data let plistXML = FileManager.default.contents(atPath: plistPath!)! do {//convert the data to a dictionary and handle errors. plistData = try PropertyListSerialization.propertyList(from: plistXML, options: .mutableContainersAndLeaves, format: &propertyListForamt) as! [String:AnyObject] } catch { print("Error reading plist: \(error), format: \(propertyListForamt)") } } 

Leia mais COMO USAR LISTAS DE PROPRIEDADE (.PLIST) NO SWIFT .

Essa resposta usa objects nativos do Swift em vez de NSDictionary.

Swift 3.0

 //get the path of the plist file guard let plistPath = Bundle.main.path(forResource: "level1", ofType: "plist") else { return } //load the plist as data in memory guard let plistData = FileManager.default.contents(atPath: plistPath) else { return } //use the format of a property list (xml) var format = PropertyListSerialization.PropertyListFormat.xml //convert the plist data to a Swift Dictionary guard let plistDict = try! PropertyListSerialization.propertyList(from: plistData, options: .mutableContainersAndLeaves, format: &format) as? [String : AnyObject] else { return } //access the values in the dictionary if let value = plistDict["aKey"] as? String { //do something with your value print(value) } //you can also use the coalesce operator to handle possible nil values var myValue = plistDict["aKey"] ?? "" 

Eu tenho trabalhado com o Swift 3.0 e queria contribuir com uma resposta para a syntax atualizada. Além disso, e possivelmente mais importante, estou usando o object PropertyListSerialization para fazer o trabalho pesado, que é muito mais flexível do que apenas usar o NSDictionary, pois permite que um Array seja o tipo de raiz do plist.

Abaixo está uma imagem do plist que estou usando. É um pouco complicado, de modo a mostrar a potência disponível, mas isso funcionará para qualquer combinação permitida de tipos de plist.

Arquivo plist amostra Como você pode ver, estou usando os dictionarys Array of String: String para armazenar uma lista de nomes de sites e suas URLs correspondentes.

Eu estou usando o object PropertyListSerialization , como mencionado acima, para fazer o trabalho pesado para mim. Além disso, o Swift 3.0 se tornou mais “Swifty”, então todos os nomes de objects perderam o prefixo “NS”.

 let path = Bundle.main().pathForResource("DefaultSiteList", ofType: "plist")! let url = URL(fileURLWithPath: path) let data = try! Data(contentsOf: url) let plist = try! PropertyListSerialization.propertyList(from: data, options: .mutableContainers, format: nil) 

Depois que o código acima for executado, o plist será do tipo Array , mas sabemos que tipo é realmente para que possamos Array lo no tipo correto:

 let dictArray = plist as! [[String:String]] // [[String:String]] is equivalent to Array< Dictionary > 

E agora podemos acessar as várias propriedades de nosso Array of String: String Dictionaries de maneira natural. Esperançosamente para convertê-los em estruturas ou classs fortemente tipadas;)

 print(dictArray[0]["Name"]) 

Swift 4.0

Agora você pode usar o protocolo Decodable para Decodificar um .plist em uma estrutura personalizada. Vou passar por cima de um exemplo básico, para estruturas mais complexas de .plist eu recomendo a leitura de Decodable / Encodable (um bom recurso está aqui: https://benscheirman.com/2017/06/swift-json/ ).

Primeiro, configure sua estrutura no formato do seu arquivo .plist. Para este exemplo, vou considerar um .plist com um dictionary de nível raiz e três inputs: 1 String com a chave “name”, 1 Int com a chave “age” e 1 Boolean com a chave “single”. Aqui está a estrutura:

 struct Config: Decodable { private enum CodingKeys: String, CodingKey { case name, age, single } let name: String let age: Int let single: Bool } 

Simples o suficiente. Agora a parte legal. Usando a class PropertyListDecoder, podemos facilmente analisar o arquivo .plist em uma instanciação dessa estrutura:

 func parseConfig() -> Config { let url = Bundle.main.url(forResource: "Config", withExtension: "plist")! let data = try! Data(contentsOf: url) let decoder = PropertyListDecoder() return try! decoder.decode(Config.self, from: data) } 

Não há muito mais código para se preocupar, e é tudo em Swift. Melhor ainda, agora temos uma instanciação da estrutura de configuração que podemos usar facilmente:

 let config = parseConfig() print(config.name) print(config.age) print(config.single) 

Isso Imprime o valor para as chaves “name”, “age” e “single” no .plist.

É melhor usar dictionarys e matrizes nativos porque eles foram otimizados para uso com o swift. Dito isto, você pode usar o NS … classs em swift e acho que esta situação justifica isso. Aqui está como você iria implementá-lo:

 var path = NSBundle.mainBundle().pathForResource("Config", ofType: "plist") var dict = NSDictionary(contentsOfFile: path) 

Até agora (na minha opinião) esta é a maneira mais fácil e eficiente de acessar uma plist, mas no futuro eu espero que a Apple adicione mais funcionalidades (como plist) em dictionarys nativos.

Swift – Ler / Escrever plist e arquivo de texto ….

 override func viewDidLoad() { super.viewDidLoad() let fileManager = (NSFileManager .defaultManager()) let directorys : [String]? = NSSearchPathForDirectoriesInDomains(NSSearchPathDirectory.DocumentDirectory,NSSearchPathDomainMask.AllDomainsMask, true) as? [String] if (directorys != nil){ let directories:[String] = directorys!; let dictionary = directories[0]; //documents directory // Create and insert the data into the Plist file .... let plistfile = "myPlist.plist" var myDictionary: NSMutableDictionary = ["Content": "This is a sample Plist file ........."] let plistpath = dictionary.stringByAppendingPathComponent(plistfile); if !fileManager .fileExistsAtPath(plistpath){//writing Plist file myDictionary.writeToFile(plistpath, atomically: false) } else{ //Reading Plist file println("Plist file found") let resultDictionary = NSMutableDictionary(contentsOfFile: plistpath) println(resultDictionary?.description) } // Create and insert the data into the Text file .... let textfile = "myText.txt" let sampleText = "This is a sample text file ......... " let textpath = dictionary.stringByAppendingPathComponent(textfile); if !fileManager .fileExistsAtPath(textpath){//writing text file sampleText.writeToFile(textpath, atomically: false, encoding: NSUTF8StringEncoding, error: nil); } else{ //Reading text file let reulttext = String(contentsOfFile: textpath, encoding: NSUTF8StringEncoding, error: nil) println(reulttext) } } else { println("directory is empty") } } 

Swift 2.0: Acessando Info.Plist

Eu tenho um dictionary chamado CoachMarksDictionary com um valor booleano em Info.Plist. Eu quero acessar o valor bool e torná-lo verdadeiro.

 let path = NSBundle.mainBundle().pathForResource("Info", ofType: "plist")! let dict = NSDictionary(contentsOfFile: path) as! [String: AnyObject] if let CoachMarksDict = dict["CoachMarksDictionary"] { print("Info.plist : \(CoachMarksDict)") var dashC = CoachMarksDict["DashBoardCompleted"] as! Bool print("DashBoardCompleted state :\(dashC) ") } 

Escrevendo para Plist:

De um Custom Plist: – (Faça do Arquivo-Novo-Arquivo-Recurso-PropertyList. Adicionado três strings nomeadas: DashBoard_New, DashBoard_Draft, DashBoard_Completed)

 func writeToCoachMarksPlist(status:String?,keyName:String?) { let path1 = NSBundle.mainBundle().pathForResource("CoachMarks", ofType: "plist") let coachMarksDICT = NSMutableDictionary(contentsOfFile: path1!)! as NSMutableDictionary var coachMarksMine = coachMarksDICT.objectForKey(keyName!) coachMarksMine = status coachMarksDICT.setValue(status, forKey: keyName!) coachMarksDICT.writeToFile(path1!, atomically: true) } 

O método pode ser chamado como

 self.writeToCoachMarksPlist(" true - means user has checked the marks",keyName: "the key in the CoachMarks dictionary"). 

pode realmente fazer isso em uma linha

  var dict = NSDictionary(contentsOfFile: NSBundle.mainBundle().pathForResource("Config", ofType: "plist")) 

Você pode ler o plist na linguagem SWIFT desta maneira:

 let path = NSBundle.mainBundle().pathForResource("PriceList", ofType: "plist") let dict = NSDictionary(contentsOfFile: path) 

Ler o valor do dictionary único:

 let test: AnyObject = dict.objectForKey("index1") 

Se você quiser obter dictionary multi-dimensional completo em plist:

 let value: AnyObject = dict.objectForKey("index2").objectForKey("date") 

Aqui está o problema:

   index2  date 20140610 amount 110  index1  amount 125 date 20140212    

Convertido em uma extensão de conveniência através da resposta de Nick:

 extension Dictionary { static func contentsOf(path: URL) -> Dictionary { let data = try! Data(contentsOf: path) let plist = try! PropertyListSerialization.propertyList(from: data, options: .mutableContainers, format: nil) return plist as! [String: AnyObject] } } 

uso:

 let path = Bundle.main.path(forResource: "plistName", ofType: "plist")! let url = URL(fileURLWithPath: path) let dict = Dictionary.contentsOf(path: url) 

Eu estaria disposto a apostar que também funcionaria para criar uma extensão semelhante para Arrays

Você pode usar isso, eu crio uma extensão simples para dictionary no github https://github.com/DaRkD0G/LoadExtension

 extension Dictionary { /** Load a Plist file from the app bundle into a new dictionary :param: File name :return: Dictionary? */ static func loadPlistFromProject(filename: String) -> Dictionary? { if let path = NSBundle.mainBundle().pathForResource("GameParam", ofType: "plist") { return NSDictionary(contentsOfFile: path) as? Dictionary } println("Could not find file: \(filename)") return nil } } 

E você pode usar isso para carregar

 /** Example function for load Files Plist :param: Name File Plist */ func loadPlist(filename: String) -> ExampleClass? { if let dictionary = Dictionary.loadPlistFromProject(filename) { let stringValue = (dictionary["name"] as NSString) let intergerValue = (dictionary["score"] as NSString).integerValue let doubleValue = (dictionary["transition"] as NSString).doubleValue return ExampleClass(stringValue: stringValue, intergerValue: intergerValue, doubleValue: doubleValue) } return nil } 

No meu caso eu crio um NSDictionary chamado appSettings e adiciono todas as chaves necessárias. Para este caso, a solução é:

 if let dict = NSBundle.mainBundle().objectForInfoDictionaryKey("appSettings") { if let configAppToken = dict["myKeyInsideAppSettings"] as? String { } } 

Aqui está uma versão um pouco mais curta, baseada na resposta do @connor

 guard let path = Bundle.main.path(forResource: "GoogleService-Info", ofType: "plist"), let myDict = NSDictionary(contentsOfFile: path) else { return nil } let value = dict.value(forKey: "CLIENT_ID") as! String? 

Swift 3.0

 if let path = Bundle.main.path(forResource: "config", ofType: "plist") { let dict = NSDictionary(contentsOfFile: path) // use dictionary } 

A maneira mais fácil de fazer isso na minha opinião.

Eu criei um simples inicializador de Dictionary que substitui NSDictionary(contentsOfFile: path) . Apenas remova o NS .

 extension Dictionary where Key == String, Value == Any { public init?(contentsOfFile path: String) { let url = URL(fileURLWithPath: path) self.init(contentsOfURL: url) } public init?(contentsOfURL url: URL) { guard let data = try? Data(contentsOf: url), let dictionary = (try? PropertyListSerialization.propertyList(from: data, options: [], format: nil) as? [String: Any]) ?? nil else { return nil } self = dictionary } } 

Você pode usá-lo assim:

 let filePath = Bundle.main.path(forResource: "Preferences", ofType: "plist")! let preferences = Dictionary(contentsOfFile: filePath)! UserDefaults.standard.register(defaults: preferences) 

Passo 1 : maneira simples e mais rápida de analisar plist em rápida 3 +

 extension Bundle { func parsePlist(ofName name: String) -> [String: AnyObject]? { // check if plist data available guard let plistURL = Bundle.main.url(forResource: name, withExtension: "plist"), let data = try? Data(contentsOf: plistURL) else { return nil } // parse plist into [String: Anyobject] guard let plistDictionary = try? PropertyListSerialization.propertyList(from: data, options: [], format: nil) as? [String: AnyObject] else { return nil } return plistDictionary } } 

Passo 2: como usar:

 Bundle().parsePlist(ofName: "Your-Plist-Name") 

Aqui está a solução que encontrei:

 let levelBlocks = NSDictionary(contentsOfFile: NSBundle.mainBundle().pathForResource("LevelBlocks", ofType: "plist")) let test: AnyObject = levelBlocks.objectForKey("Level1") println(test) // Prints the value of test 

Eu defino o tipo de test como AnyObject para silenciar um aviso sobre uma inferência inesperada que pode ocorrer.

Além disso, tem que ser feito em um método de class.

Para acessar e salvar um valor específico de um tipo conhecido:

 let value = levelBlocks.objectForKey("Level1").objectForKey("amount") as Int println(toString(value)) // Converts value to String and prints it 

Eu uso dictionarys rápidos, mas convertê-los para e de NSDictionaries na minha class de gerenciador de arquivos da seguinte forma:

  func writePlist(fileName:String, myDict:Dictionary){ let docsDir:String = dirPaths[0] as String let docPath = docsDir + "/" + fileName let thisDict = myDict as NSDictionary if(thisDict.writeToFile(docPath, atomically: true)){ NSLog("success") } else { NSLog("failure") } } func getPlist(fileName:String)->Dictionary{ let docsDir:String = dirPaths[0] as String let docPath = docsDir + "/" + fileName let thisDict = NSDictionary(contentsOfFile: docPath) return thisDict! as! Dictionary } 

Essa parece ser a maneira menos problemática de ler e escrever, mas vamos deixar o resto do meu código o mais rápido possível.

Plist é um enum simples do Swift que criei para trabalhar com listas de propriedades.

 // load an applications info.plist data let info = Plist(NSBundle.mainBundle().infoDictionary) let identifier = info["CFBundleIndentifier"].string! 

Mais exemplos:

 import Plist // initialize using an NSDictionary // and retrieve keyed values let info = Plist(dict) let name = info["name"].string ?? "" let age = info["age"].int ?? 0 // initialize using an NSArray // and retrieve indexed values let info = Plist(array) let itemAtIndex0 = info[0].value // utility initiaizer to load a plist file at specified path let info = Plist(path: "path_to_plist_file") // we support index chaining - you can get to a dictionary from an array via // a dictionary and so on // don't worry, the following will not fail with errors in case // the index path is invalid if let complicatedAccessOfSomeStringValueOfInterest = info["dictKey"][10]["anotherKey"].string { // do something } else { // data cannot be indexed } // you can also re-use parts of a plist data structure let info = Plist(...) let firstSection = info["Sections"][0]["SectionData"] let sectionKey = firstSection["key"].string! let sectionSecret = firstSection["secret"].int! 

Plist.swift

Plist em si é bastante simples, aqui está sua listview no caso de você se referir diretamente.

 // // Plist.swift // import Foundation public enum Plist { case dictionary(NSDictionary) case Array(NSArray) case Value(Any) case none public init(_ dict: NSDictionary) { self = .dictionary(dict) } public init(_ array: NSArray) { self = .Array(array) } public init(_ value: Any?) { self = Plist.wrap(value) } } // MARK:- initialize from a path extension Plist { public init(path: String) { if let dict = NSDictionary(contentsOfFile: path) { self = .dictionary(dict) } else if let array = NSArray(contentsOfFile: path) { self = .Array(array) } else { self = .none } } } // MARK:- private helpers extension Plist { /// wraps a given object to a Plist fileprivate static func wrap(_ object: Any?) -> Plist { if let dict = object as? NSDictionary { return .dictionary(dict) } if let array = object as? NSArray { return .Array(array) } if let value = object { return .Value(value) } return .none } /// tries to cast to an optional T fileprivate func cast() -> T? { switch self { case let .Value(value): return value as? T default: return nil } } } // MARK:- subscripting extension Plist { /// index a dictionary public subscript(key: String) -> Plist { switch self { case let .dictionary(dict): let v = dict.object(forKey: key) return Plist.wrap(v) default: return .none } } /// index an array public subscript(index: Int) -> Plist { switch self { case let .Array(array): if index >= 0 && index < array.count { return Plist.wrap(array[index]) } return .none default: return .none } } } // MARK:- Value extraction extension Plist { public var string: String? { return cast() } public var int: Int? { return cast() } public var double: Double? { return cast() } public var float: Float? { return cast() } public var date: Date? { return cast() } public var data: Data? { return cast() } public var number: NSNumber? { return cast() } public var bool: Bool? { return cast() } // unwraps and returns the underlying value public var value: Any? { switch self { case let .Value(value): return value case let .dictionary(dict): return dict case let .Array(array): return array case .none: return nil } } // returns the underlying array public var array: NSArray? { switch self { case let .Array(array): return array default: return nil } } // returns the underlying dictionary public var dict: NSDictionary? { switch self { case let .dictionary(dict): return dict default: return nil } } } // MARK:- CustomStringConvertible extension Plist : CustomStringConvertible { public var description:String { switch self { case let .Array(array): return "(array \(array))" case let .dictionary(dict): return "(dict \(dict))" case let .Value(value): return "(value \(value))" case .none: return "(none)" } } } 

Swift 3.0

Se você quiser ler uma “matriz bidimensional” de .plist, você pode tentar assim:

 if let path = Bundle.main.path(forResource: "Info", ofType: "plist") { if let dimension1 = NSDictionary(contentsOfFile: path) { if let dimension2 = dimension1["key"] as? [String] { destination_array = dimension2 } } } 

Swift 4.0 iOS 11.2.6 lista analisada e código para analisá-lo, com base em https://stackoverflow.com/users/3647770/ashok-r resposta acima.

      identity blah-1 major 1 minor 1 uuid f45321 web http://web   identity  major  minor  uuid  web     do { let plistXML = try Data(contentsOf: url) var plistData: [[String: AnyObject]] = [[:]] var propertyListForamt = PropertyListSerialization.PropertyListFormat.xml do { plistData = try PropertyListSerialization.propertyList(from: plistXML, options: .mutableContainersAndLeaves, format: &propertyListForamt) as! [[String:AnyObject]] } catch { print("Error reading plist: \(error), format: \(propertyListForamt)") } } catch { print("error no upload") } 

Estrutura simples para acessar o arquivo plist (Swift 2.0)

 struct Configuration { static let path = NSBundle.mainBundle().pathForResource("Info", ofType: "plist")! static let dict = NSDictionary(contentsOfFile: path) as! [String: AnyObject] static let someValue = dict["someKey"] as! String } 

Uso:

 print("someValue = \(Configuration.someValue)")