使用 Swift 4 中的 Encodable/Decodable 对结构进行编码/解码

Question

我不太习惯结构，我知道使用结构的唯一方法就是这样......

struct UserDetails {
  let name: String
  let message: String

  init(name: String, message: String) {
    self.name = name
    self.message = message
  }
}

一旦我收到name 和message 的值，我就会像这样将它们添加到结构中......

let userDetails = UserDetails(name: theName, message: theMessage)

然后将其添加到结构类型的数组中...

self.userDetailsArray.append(userDetails) 

现在终于，当我想获得个人姓名或信息时，我会这样......

let user = userDetailsArray[indexPath.row]
cell.userNameLabel.text = user.name
cell.messageLabel.text = user.message

这也很好用。但我担心的是……我上面指定的方法是一种非常古老的方法，因为 swift 已经提出了NSCoding 和Codable 协议。但我不知道如何实现它们。

希望有人可以展示我如何将NSCoding/Codable 协议应用于我上面提到的示例...

Answer 1

您可以在互联网上找到很多示例。这是使用Codable 协议的通用函数。让我们举个例子：

struct UserDetails: Codable {
  let name: String, message: String
}

现在让我们看看来自gist的精彩扩展：

extension Encodable {
    func encode(with encoder: JSONEncoder = JSONEncoder()) throws -> Data {
        return try encoder.encode(self)
    }
}

extension Decodable {
    static func decode(with decoder: JSONDecoder = JSONDecoder(), from data: Data) throws -> Self {
        return try decoder.decode(Self.self, from: data)
    }
}

它只对基于Class 指定的encode 和decode 值执行一个简单的函数。

现在，它变得更简单了，就像您只需传递从 API 接收的 data。

if let arrUserDetails: [UserDetails] = try? [UserDetails].decode(from: data!) {
    print("UserDetails \(arrUserDetails)")   
}

这是您可以使用最新的Encodable 和Decodable 协议的方法。

Answer 2

您的代码很好。要应用 Codable 来解析/存储/检索您的用户详细信息列表，您需要像下面这样定义您的结构，

struct UserDetails: Codable {
    let name: String
    let message: String

    enum CodingKeys: String, CodingKey {
        //Uncomment the following commentted lines, if your JSON formatted data comes with different keys like bellow
        case name       //= "user_name"
        case message    //= "user_message"
    }

    init(name: String, message: String) {
        self.name = name
        self.message = message
    }

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

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decode(String.self, forKey: .name)
        message = try container.decode(String.self, forKey: .message)
    }
}

要解析来自 web api 调用的响应，您可以使用以下函数

func makeAPICall(){
    guard let url = URL(string: "https://www.your-web-api") else { return }
    URLSession.shared.dataTask(with: url) { (data, response, error) in
        guard let data = data else { return }
        do {
            let decoder = JSONDecoder()
            let userDetails = try decoder.decode([UserDetails].self, from: data)
            print(userDetails)
        } catch let err {
            print("Error", err)
        }
    }.resume()
}

要存储你的用户详细信息列表，你可以这样写

func storeUserDetails(userDetails: [UserDetails]) {
    do {
        let data = try PropertyListEncoder().encode(userDetails)
        let success = NSKeyedArchiver.archiveRootObject(data, toFile: filePath(key: "file.archive"))
        print(success ? "Successful save" : "Save Failed")
    } catch {
        print("Save Failed")
    }
}

要检索您的用户详细信息列表，请使用此功能

func retrieveUserDetails() -> [UserDetails]? {
    guard let data = NSKeyedUnarchiver.unarchiveObject(withFile: filePath(key: "file.archive")) as? Data else { return nil }
    do {
        let products = try PropertyListDecoder().decode([UserDetails].self, from: data)
        return products
    } catch {
        print("Retrieve Failed")
        return nil
    }
}

以及获取文件路径的辅助函数

func filePath(key:String) -> String {
    let manager = FileManager.default
    let url = manager.urls(for: .documentDirectory, in: .userDomainMask).first
    return (url!.appendingPathComponent(key).path)
}

一些不错的读物：

1. Encoding and Decoding Custom Types
2. Encoding, Decoding and Serialization in Swift 4
3. Everything about Codable in Swift 4